diff --git a/_config.yml b/_config.yml index 4a90ed5885..45147f16ca 100644 --- a/_config.yml +++ b/_config.yml @@ -3,7 +3,7 @@ # Main Configs # # ----------------------- # -url: https://home-assistant.io +url: https://www.home-assistant.io title: Home Assistant subtitle: Open-source home automation platform running on Python 3 author: Home Assistant @@ -139,14 +139,14 @@ social: # Home Assistant release details current_major_version: 0 -current_minor_version: 65 -current_patch_version: 5 -date_released: 2018-03-14 +current_minor_version: 69 +current_patch_version: 0 +date_released: 2018-05-11 # Either # or the anchor link to latest release notes in the blog post. # Must be prefixed with a # and have double quotes around it. # Major release: -patch_version_notes: "#release-0655---march-14" +patch_version_notes: "#" # Minor release (Example #release-0431---april-25): # Date we moved to Discourse for comments diff --git a/credits_generator/README.md b/credits_generator/README.md index ee89f67817..986f0b4785 100644 --- a/credits_generator/README.md +++ b/credits_generator/README.md @@ -1,11 +1,12 @@ credits_generator ================= -This tool can be used to update the [Home Assistant's Credits page](https://home-assistant.io/developers/credits/). +This tool can be used to update the [Credits page for Home Assistant](https://home-assistant.io/developers/credits/). Setup ----- +Fetch the dependencies with `npm`. ```bash $ cd credits_generator $ npm install @@ -13,8 +14,11 @@ $ npm install Usage ----- +Go to https://github.com/settings/tokens/new and generate a new GitHub personal access token. +Give the token any name and select the `public_repo` and `read:user` scopes. -Set your personal GitHub access token as environmental variable. + +Set the environment variable `GITHUB_TOKEN` to the new token. ```bash $ export GITHUB_TOKEN= @@ -23,7 +27,6 @@ $ export GITHUB_TOKEN= Run the script. ```bash -$ cd credits_generator $ node update_credits.js ``` diff --git a/credits_generator/update_credits.js b/credits_generator/update_credits.js index d850ccaee9..3cfab7a9e2 100644 --- a/credits_generator/update_credits.js +++ b/credits_generator/update_credits.js @@ -58,7 +58,12 @@ github.repos.getForOrg({ cb(err); return; } - if(userInfo.login == 'RubenKelevra') userInfo.name = 'RubenKelevra'; // ugh, because his name is `@RubenKelevra` + if (userInfo.name) { + userInfo.name = userInfo.name.replace(/^@/, '') + .replace(//g, '>') + .replace(/[\\`*_{}[\]()#+-.!~|]/g, '\\$&'); + } usersMap[login].info.name = userInfo.name || userInfo.login; usersMap[login].info.username = userInfo.login; cb(); diff --git a/plugins/configuration.rb b/plugins/configuration.rb index 52bcf87fb9..30a5196d72 100644 --- a/plugins/configuration.rb +++ b/plugins/configuration.rb @@ -2,7 +2,7 @@ module Jekyll class ConfigurationBlock < Liquid::Block TYPE_LINKS = { 'action' => '/docs/scripts/', - 'device_class' => '/components/%{component}/#device_class', + 'device_class' => '/components/%{component}/#device-class', 'template' => '/docs/configuration/templating/', } diff --git a/plugins/environment_variables.rb b/plugins/environment_variables.rb new file mode 100644 index 0000000000..7d9203f164 --- /dev/null +++ b/plugins/environment_variables.rb @@ -0,0 +1,17 @@ +module Jekyll + class EnvironmentVariablesGenerator < Generator + def generate(site) + # https://www.netlify.com/docs/continuous-deployment/#build-environment-variables + repo_url = ENV['REPOSITORY_URL'] || 'https://github.com/home-assistant/home-assistant.github.io' + + # Rewrite urls if repo url is the ssh format. + if repo_url.start_with? 'git@github.com:' + repo_url = repo_url.sub 'git@github.com:', 'https://github.com/' + end + + # These values will be available as {{ site.NLY_REPOSITORY_URL }} + site.config['NLY_REPOSITORY_URL'] = repo_url + site.config['NLY_HEAD'] = ENV['HEAD'] || 'current' + end + end +end diff --git a/plugins/filters.rb b/plugins/filters.rb index 5eacd7b8cf..41ad3357a8 100644 --- a/plugins/filters.rb +++ b/plugins/filters.rb @@ -24,7 +24,7 @@ module Jekyll # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION def site_url - 'https://home-assistant.io' + 'https://www.home-assistant.io' end # Prepend a url with the full site url diff --git a/sass/custom/_paulus.scss b/sass/custom/_paulus.scss index 2a9e1fb4eb..c64bdb7da2 100644 --- a/sass/custom/_paulus.scss +++ b/sass/custom/_paulus.scss @@ -4,6 +4,10 @@ $primary-color: #049cdb; .site-header { position: relative; + + .site-title { + font-weight: normal; + } } .search-container { @@ -377,18 +381,26 @@ p.note { } .copyright { - text-align: center; + text-align: left; - i { - font-size: 3em; - margin-right: 8px; - position: relative; - top: -5px; + .company { + .title { + font-size: 1.5em; + } + + img { + vertical-align: middle; + } + + i { + font-size: 2em; + padding: 0 5px; + } } - .credit { - text-align: left; - display: inline-block; - font-size: .8em; + + ul { + margin: 0; + list-style: none; } } diff --git a/source/_addons/configurator.markdown b/source/_addons/configurator.markdown index c601025a12..d402488270 100644 --- a/source/_addons/configurator.markdown +++ b/source/_addons/configurator.markdown @@ -65,7 +65,7 @@ Screenshot of the HASS Configurator. ### {% linkable_title Embedding into Home-Assistant %} -Using the Home Assistant component [panel_iframe](https://home-assistant.io/components/panel_iframe/) it is possible to embed the configurator directly into Home Assistant, allowing you to modify your configuration from within the Home Assistant frontend. +Using the Home Assistant component [panel_iframe](/components/panel_iframe/) it is possible to embed the configurator directly into Home Assistant, allowing you to modify your configuration from within the Home Assistant frontend. An example configuration would look like this: diff --git a/source/_addons/duckdns.markdown b/source/_addons/duckdns.markdown index 297cbb8fd9..123e975e97 100644 --- a/source/_addons/duckdns.markdown +++ b/source/_addons/duckdns.markdown @@ -10,12 +10,14 @@ footer: true featured: true --- -[Duck DNS](https://duckdns.org/) is a free service which will point a DNS (sub domains of duckdns.org) to an IP of your choice. This add-on includes support for Let's Encrypt and will automatically create and renew your certificates. +[Duck DNS](https://www.duckdns.org/) is a free service which will point a DNS (sub domains of duckdns.org) to an IP of your choice. This add-on includes support for Let's Encrypt and will automatically create and renew your certificates. ```json { "lets_encrypt": { - "accept_terms": true + "accept_terms": true, + "certfile": "fullchain.pem", + "keyfile": "privkey.pem" }, "token": "sdfj-2131023-dslfjsd-12321", "domains": ["my-domain.duckdns.org"] @@ -24,10 +26,10 @@ featured: true Configuration variables: +- **lets_encrypt.accept_terms** (*Optional*): If you accept the [Let's Encrypt Subscriber Agreement][le], it will generate and update Let's Encrypt certificates for your DuckDNS domain. - **token** (*Required*): Your Duck DNS API key. - **domains** (*Required*): A list of domains to update DNS. -- **seconds** (*Optional*): Seconds between updates to Duck DNS. -- **lets_encrypt.accept_terms** (*Optional*): If you accept the [Let's Encrypt Subscriber Agreement][le], it will generate & update Let's Enrypt certificates for your DuckDNS domain. +- **seconds** (*Required*): Seconds between updates to Duck DNS. [le]: https://letsencrypt.org/repository/ @@ -49,3 +51,5 @@ If you use a port other than `8123` or an SSL proxy, change the port number acco 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. Ensure that you allocate the Home Assistant system a fixed IP on your network before you configure port forwarding. You can do this either on the computer itself (see the [install guide](/hassio/installation/) or via a static lease on your router. + +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`. diff --git a/source/_addons/google_assistant.markdown b/source/_addons/google_assistant.markdown index ac0765bc51..f48415638e 100644 --- a/source/_addons/google_assistant.markdown +++ b/source/_addons/google_assistant.markdown @@ -11,7 +11,7 @@ featured: true ---

- If you want to integrate your Google Home, or mobile phone running Google Assistant, with Home Assistant, then you want the [Google Assistant component](https://home-assistant.io/components/google_assistant/). + If you want to integrate your Google Home, or mobile phone running Google Assistant, with Home Assistant, then you want the [Google Assistant component](/components/google_assistant/).

[Google Assistant][GoogleAssistant] is an AI-powered voice assistant that runs on the Raspberry Pi and x86 platforms and interact via the [DialogFlow][comp] integration with Home-Assistant. You can also use [Google Actions][GoogleActions] to extend its functionality. @@ -66,7 +66,7 @@ Configuration example that uses the USB microphone and the built-in headset audi Configuration variables: -- **mic**: This is the hardware address of your microphone. Look at the add-on output +- **mic**: This is the hardware address of your microphone. Look at the add-on output - **speaker**: This is the hardware address of your speakers. Look at the add-on output ### {% linkable_title Home Assistant configuration %} diff --git a/source/_addons/lets_encrypt.markdown b/source/_addons/lets_encrypt.markdown index c0cbf10bbe..0ac8d01994 100644 --- a/source/_addons/lets_encrypt.markdown +++ b/source/_addons/lets_encrypt.markdown @@ -2,7 +2,7 @@ layout: page title: "Let's Encrypt" description: "Automatically manage your SSL certificate using Let's Encrypt." -date: 2017-04-30 13:28 +date: 2018-04-18 10:55 sidebar: true comments: false sharing: true @@ -41,4 +41,24 @@ http: If you use another port such as `8123` or an SSL proxy, change the port number. +## {% linkable_title 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 certificte, and then stops. It's up to you to manually start it again whenever your certificate comes close to expiry. + +However, you can automate this process using Home Assistant. + +Use this in your `automations.yaml` to attempt certificate renewal each day at midnight: + +```yaml +- id: letsencrypt-renewal + alias: "Let's Encrypt Renewal" + trigger: + - platform: time + at: '00:00:00' + action: + - service: hassio.addon_restart + data: + addon: core_letsencrypt +``` + [DuckDNS add-on]: /addons/duckdns/ diff --git a/source/_addons/mariadb.markdown b/source/_addons/mariadb.markdown index 673857de06..66df1440c6 100644 --- a/source/_addons/mariadb.markdown +++ b/source/_addons/mariadb.markdown @@ -9,7 +9,7 @@ sharing: true footer: true --- -Set up a [mariadb](https://mariadb.org/) SQL server. It supports multiple databases, users, and permission settings. If you want to only connect from inside home assistant use `core-mariadb` as the host address. +Set up a [mariadb](https://mariadb.org/) SQL server. It supports multiple databases, users, and permission settings. If you want to only connect from inside Home Assistant use `core-mariadb` as the host address. ```json { diff --git a/source/_addons/mosquitto.markdown b/source/_addons/mosquitto.markdown index de3df29894..f143d9ac34 100644 --- a/source/_addons/mosquitto.markdown +++ b/source/_addons/mosquitto.markdown @@ -43,7 +43,7 @@ Configuration variables: ### {% linkable_title Home Assistant configuration %} -To use the Mosquitto as [broker](/docs/mqtt/broker/#run-your-own) add the following entry to the `configuration.yaml` file. +To use the Mosquitto as [broker](/docs/mqtt/broker/#run-your-own), add the following entry to the `configuration.yaml` file. ```yaml # Example configuration.yaml entry @@ -59,3 +59,20 @@ mqtt: username: YOUR_USERNAME password: YOUR_PASSWORD ``` + +### {% linkable_title Listening simultaneously on SSL/TLS (8883) and insecure (1883) ports %} + +1. Configure SSL/TLS as normal. +2. Set `customize` flag to `true` in your configuration. +3. Create a file in `/share/mosquitto` named `insecure.conf` with the following contents: + +```text +listener 1883 +protocol mqtt +``` + +4. Restart MQTT + +

+It's recommened that you only open your firewall to the SSL/TLS port (8883) and only use the insecure port (1883) for local devices. +

diff --git a/source/_addons/nginx_proxy.markdown b/source/_addons/nginx_proxy.markdown index f306fccbe5..e1d8a5f01c 100644 --- a/source/_addons/nginx_proxy.markdown +++ b/source/_addons/nginx_proxy.markdown @@ -11,13 +11,14 @@ footer: true Setup an SSL proxy with NGINX and redirect port 80 to 443. Make sure you have generated a certificate before you start this add-on. -In the `http` section of the `configuration.yaml` file remove `ssl_certificate` and `ssl_key` and don't enter the port in the `base_url` to avoid a HTTP 502 error. +In the `http` section of the `configuration.yaml` file remove `ssl_certificate` and `ssl_key` and don't enter the port in the `base_url` to avoid an HTTP 502 error. ```json { "domain": "home.example.com", "certfile": "fullchain.pem", "keyfile": "privkey.pem", + "hsts": "max-age=31536000; includeSubDomains", "customize": { "active": false, "default": "nginx_proxy_default*.conf", @@ -31,6 +32,7 @@ Configuration variables: - **domain** (*Required*): Domain they will proxy run with it. - **certfile** (*Required*): Certificate file to use in the /ssl dir. - **keyfile** (*Required*): Private key file to use in the /ssl dir. +- **hsts** (*Optional*): Value for the [`Strict-Transport-Security`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Strict-Transport-Security) HTTP header to send. If empty or `null`, the header is not sent. - **customize** (*Optional*): If true, additional NGINX configuration files for the default server and additional servers are read from files in the /share dir specified by the `default` and `servers` variables.

diff --git a/source/_addons/samba.markdown b/source/_addons/samba.markdown index a8cd931cbe..9d0f18923f 100644 --- a/source/_addons/samba.markdown +++ b/source/_addons/samba.markdown @@ -35,7 +35,7 @@ Configuration variables: - **name** (*Optional*): Set netbios name of Hass.io device. Default is `hassio`. - **workgroup** (*Optional*): Set network workgroup name. Default is `WORKGROUP`. - **guest** (*Optional*): Allow login without a username or password. Default is `true`. -- **map** (*Optional*): Control which folders will be exposed. `config` shares the Home Assistant configuration folder. `addons` shares the local custom repositiory. `share` shares a folder that can be accessed by add-ons and Home Assistant. `backup` shares access to snapshot files. `ssl` shares certificate storage. Be careful with the `ssl` option! Defaults are all set to `true`, except for `ssl`. +- **map** (*Optional*): Control which folders will be exposed. `config` shares the Home Assistant configuration folder. `addons` shares the local custom repository. `share` shares a folder that can be accessed by add-ons and Home Assistant. `backup` shares access to snapshot files. `ssl` shares certificate storage. Be careful with the `ssl` option! Defaults are all set to `true`, except for `ssl`. - **username** (*Optional*): Username for logging in if guest login is not used. - **password** (*Optional*): Password for `username`. An empty password is not supported. - **interface** (*Optional*): Interface that will start the share. Normally this is `eth0` for ethernet wired connection and `wlan0` for wireless connection. diff --git a/source/_addons/snips.markdown b/source/_addons/snips.markdown index 954d04d613..851afd8e7d 100644 --- a/source/_addons/snips.markdown +++ b/source/_addons/snips.markdown @@ -2,51 +2,39 @@ layout: page title: "Snips.ai" description: "Enhance your Hass.io installation with a local voice assistant." -date: 2017-04-30 13:28 +date: 2018-05-02 13:28 sidebar: true comments: false sharing: true footer: true --- -[Snips.ai] is an AI-powered voice assistant that runs on the Raspberry Pi 3 and x86 platforms. It runs on-device and is Private by Design. +[Snips.ai](https://snips.ai/) is an AI-powered voice assistant that runs on the Raspberry Pi 3 and x86 platforms. It runs on-device and is Private by Design. -To get started, follow [their tutorial] to create an assistant and download the training data. +The Snips add-on depends on the Mosquitto add on to bridge to Home Assistant, so make sure that is installed. -Now install and activate the [Samba] add-on so you can upload your training data. Connect to the "share" Samba share and copy your training data over. Name the file `assistant.zip`. +HomeAssistant 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). -Now it's time to start Snips for the first time. When the Snips add-on starts, it will output your audio devices: +The Snips addon 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 component is enabled. -```text -**** List of PLAYBACK Hardware Devices **** -card 0: ALSA [bcm2835 ALSA], device 0: bcm2835 ALSA [bcm2835 ALSA] - Subdevices: 8/8 - Subdevice #0: subdevice #0 - Subdevice #1: subdevice #1 - Subdevice #2: subdevice #2 - Subdevice #3: subdevice #3 - Subdevice #4: subdevice #4 - Subdevice #5: subdevice #5 - Subdevice #6: subdevice #6 - Subdevice #7: subdevice #7 -card 0: ALSA [bcm2835 ALSA], device 1: bcm2835 ALSA [bcm2835 IEC958/HDMI] - Subdevices: 1/1 - Subdevice #0: subdevice #0 +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: + +``` +Turn on kitchen light +Open garage door +What is on my shopping list ``` -You need to use this information to point the add-on at the right speakers and microphone. The information describes different cards and devices. On a Raspberry Pi 3, card 0 - device 0 is the built-in headset port, card 0 - device 1 is the HDMI port. In the example above, the USB microphone showed up as card 1 - device 0. +To get started creating your own configuration, follow [their tutorial](https://snips.gitbook.io/documentation/console) to create an assistant and download the training data. You can also add the HomeAssistant Skill to your assistant to enable the built-in intents, and add or create your own intents to do more complex tasks. -Find the microphone and speakers that you want to use and note down their device and card number. We will need that to configure the add-on options `mic` (microphone to use) and `speaker` (speaker to use). The format for these options is `,`. Change the configuration options and click save. +Now install and activate the [Samba](/addons/samba/) add-on so you can upload your training data. Connect to the "share" Samba share and copy your assistant over. Name the file `assistant.zip` or whatever you have configured in the configuration options. -Now start the add-on. +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. -### Add-On configuration +### {% linkable_title Add-On configuration %} ```json { - "mic": "1,0", - "speaker": "1,0", - "assistant": "assistant.zip", "mqtt_bridge": { "active": true, "host": "172.17.0.1", @@ -54,23 +42,76 @@ Now start the add-on. "user": "", "password": "" }, + "assistant": "assistant.zip", + "language": "en", + "custom_tts": false, + "tts_platform": "amazon_polly" } ``` Configuration variables: -- **mqtt_bridge** (*Optional*): Snips uses MQTT to communicate and defaults to their own broker. Use this config option to bridge their broker to your own. -- **mic**: This is the hardware address of your microphone. Look at the Snips +- **mqtt_bridge**: Snips uses MQTT to communicate and defaults to their own broker. Use this config option to bridge their broker to your the Mosquitto add-on. +- **assistant**: The name of your custom assistant in `/share`. If no assistant is found then a default assistant will be used. +- **language**: Language. This is used to select the default custom assistant, Currently `en`, `de` and `fr` are supported. +- **custom_tts**: Whether to use a TTS provider from Home Assistant for a variety of voices. +- **tts_platform**: Which TTS platform to use. ### {% linkable_title Home Assistant configuration %} -Use the Home Assistant [Snips.ai component][comp] to integrate the add-on into Home Assistant. +A simple configuration just requires this. Consult [Snips.ai component](/components/snips/) for more options. ```yaml snips: ``` -[Snips.ai]: https://snips.ai/ -[their tutorial]: https://github.com/snipsco/snips-platform-documentation/wiki/2.-Running-your-first-end-to-end-assistant -[Samba]: /addons/samba/ -[comp]: /components/snips/ +### {% linkable_title Home Assistant configuration %} + +There is an active [discord](https://discordapp.com/invite/3939Kqx) channel for further support. + +### {% linkable_title 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 addon. + +Next create a weather sensor, e.g., one for (Dark Sky)[/components/sensor.darksky/] and put the `api_key` in your `secrets.yaml` file. + +```yaml +- platform: darksky + name: "Dark Sky Weather" + api_key: !secret dark_sky_key + update_interval: + minutes: 10 + monitored_conditions: + - summary + - hourly_summary + - temperature + - temperature_max + - 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. + +```yaml +intent_script: !include intent_script.yaml +``` + +Finally, create this `intent_script.yaml` file in your configuration directory. + +{% raw %} +```yaml +searchWeatherForecast: + speech: + type: plain + text: > + The weather is currently + {{ states('sensor.dark_sky_weather_temperature') | round(0) }} + degrees outside and {{ states('sensor.dark_sky_weather_summary') }}. + The high today will be + {{ states('sensor.dark_sky_weather_daily_high_temperature') | round(0)}} + and {{ states('sensor.dark_sky_weather_hourly_summary') }} +``` +{% endraw %} + +Now just restart HassIO and ask it what the weather is like. + +[their tutorial]: https://github.com/snipsco/snips-platform-documentation/wiki/2.-Create-an-assistant-using-an-existing-bundle + diff --git a/source/_addons/tellstick.markdown b/source/_addons/tellstick.markdown index 407bb73dee..49764d93da 100644 --- a/source/_addons/tellstick.markdown +++ b/source/_addons/tellstick.markdown @@ -19,9 +19,9 @@ After any changes have been made to the configuration, you need to restart the a Configuration variables: -- **id** (*Required*): A number and must be unique for each device. -- **name** (*Required*): A name for easy identification of the device. -- **protocol** (*Required*): This is the protocol the device uses. More on the different protocols later down. +- **id** (*Required*): A number and must be unique for each device. +- **name** (*Required*): A name for easy identification of the device. +- **protocol** (*Required*): This is the protocol the device uses. More on the different protocols later down. - **model** (*Optional*): The model parameter is only used by some protocols where there exists different types of devices using the same protocol. This can be dimmers versus non-dimmers, codeswitch versus self-learning, etc. - **house** (*Optional*): Depending on protocol the values here can vary a lot to identify or group per house or type. - **unit** (*Optional*): Unit identifier, in most cases a value between 1 to 16 and often used in combination with the house. @@ -37,10 +37,10 @@ You will need to add internal communication details to `configuration.yaml` to e tellstick: host: core-tellstick port: [50800, 50801] - + ``` -To add [lights](https://home-assistant.io/components/light.tellstick/), [sensors](https://home-assistant.io/components/sensor.tellstick/) and [switches](https://home-assistant.io/components/switch.tellstick/) you follow the guidelines for each type individually that is [described for Home Assistant](https://home-assistant.io/components/tellstick/) +To add [lights](/components/light.tellstick/), [sensors](/components/sensor.tellstick/) and [switches](/components/switch.tellstick/) you follow the guidelines for each type individually that is [described for Home Assistant](/components/tellstick/) 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. diff --git a/source/_components/abode.markdown b/source/_components/abode.markdown index 34ceaada84..87b689230b 100644 --- a/source/_components/abode.markdown +++ b/source/_components/abode.markdown @@ -24,7 +24,7 @@ There is currently support for the following device types within Home Assistant: - [Camera](/components/camera.abode/): Reports on `Camera` devices and will download and show the latest captured still image. - [Cover](/components/cover.abode/): Reports on `Secure Barriers` and can be used to open and close the cover. - [Lock](/components/cover.abode/): Reports on `Door Locks` and can be used to lock and unlock the door. -- [Light](/components/light.abode/): Reports on `Dimmer` lights and can be used to dim, change color, or turn the light on and off. +- [Light](/components/light.abode/): Reports on `Dimmer` lights and can be used to dim or turn the light on and off. - [Switch](/components/switch.abode/): 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](/components/sensor.abode/): Reports on `Temperature`, `Humidity`, and `Light` sensors. diff --git a/source/_components/alarm_control_panel.abode.markdown b/source/_components/alarm_control_panel.abode.markdown index 5df73f1c05..588eb46f40 100644 --- a/source/_components/alarm_control_panel.abode.markdown +++ b/source/_components/alarm_control_panel.abode.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Abode Alarm Control Panel" -description: "Instructions how to setup the Abode Alarm control panel within Home Assistant." +description: "Instructions on how to setup the Abode Alarm control panel within Home Assistant." date: 2017-08-26 0:28 sidebar: true comments: false diff --git a/source/_components/alarm_control_panel.alarmdecoder.markdown b/source/_components/alarm_control_panel.alarmdecoder.markdown index d677173ebb..98810aaa2a 100644 --- a/source/_components/alarm_control_panel.alarmdecoder.markdown +++ b/source/_components/alarm_control_panel.alarmdecoder.markdown @@ -1,7 +1,7 @@ --- layout: page title: "AlarmDecoder Alarm Control Panel" -description: "Instructions how to setup the AlarmDecoder Alarm control panel within Home Assistant." +description: "Instructions on how to setup the AlarmDecoder Alarm control panel within Home Assistant." date: 2017-04-02 13:28 sidebar: true comments: false @@ -27,7 +27,9 @@ The Alarm Decoder component gives you access to several services for you to cont - `alarm_disarm`: Disarms the alarm from any state. Also clears a `check_zone` flag after an alarm was triggered. - `alarmdecoder_alarm_toggle_chime`: Toggles the alarm's chime state. -**Note**: `alarm_arm_custom_bypass` and `alarm_trigger`, while available in the services list in Home Assistant, are not currently implemented in the Alarm Decoder component. +

+`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. +

### {% linkable_title Attributes %} diff --git a/source/_components/alarm_control_panel.alarmdotcom.markdown b/source/_components/alarm_control_panel.alarmdotcom.markdown index 895cde8e35..82e1a7774e 100644 --- a/source/_components/alarm_control_panel.alarmdotcom.markdown +++ b/source/_components/alarm_control_panel.alarmdotcom.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Alarm.com Alarm Control Panel" -description: "Instructions how to integrate Alarm.com into Home Assistant." +description: "Instructions on how to integrate Alarm.com into Home Assistant." date: 2016-01-14 22:00 sidebar: true comments: false diff --git a/source/_components/alarm_control_panel.arlo.markdown b/source/_components/alarm_control_panel.arlo.markdown index 6d66bef11b..e47a6322d6 100644 --- a/source/_components/alarm_control_panel.arlo.markdown +++ b/source/_components/alarm_control_panel.arlo.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Arlo Control Panel" -description: "Instructions how to setup the Netgear Arlo Base Stations as a control panel within Home Assistant." +description: "Instructions on how to setup the Netgear Arlo Base Stations as a control panel within Home Assistant." date: 2017-10-05 17:45 sidebar: true comments: false @@ -27,11 +27,11 @@ alarm_control_panel: {% configuration %} home_mode_name: - description: "Arlo base station does not have a built-in home mode. You can map one of your custom modes to home assistant's home mode by setting the name of the custom mode in this configuration variable. The name of the custom mode should match exactly as you set it up in the Arlo app." + description: "Arlo base station does not have a built-in home mode. You can map one of your custom modes to Home Assistant's home mode by setting the name of the custom mode in this configuration variable. The name of the custom mode should match exactly as you set it up in the Arlo app." required: false type: string away_mode_name: - description: "Arlo base station does not have a built-in away mode. You can map one of your custom modes to home assistant's away mode by setting the name of the custom mode in this configuration variable. The name of the custom mode should match eactly as you set it up in the Arlo app." + description: "Arlo base station does not have a built-in away mode. You can map one of your custom modes to Home Assistant's away mode by setting the name of the custom mode in this configuration variable. The name of the custom mode should match eactly as you set it up in the Arlo app." required: false type: string default: "`Armed` mode in Arlo" @@ -74,4 +74,3 @@ Setting Arlo to a custom mode (mapped to `home_mode_name` in `configuration.yaml You can also completely disarm the Arlo base station by calling the `alarm_control_panel.alarm_disarm` service, and trigger the alarm by calling the `alarm_control_panel.alarm_trigger` service. More examples and configuration options can be found on the [Manual Alarm Control page](/components/alarm_control_panel.manual/#examples). - diff --git a/source/_components/alarm_control_panel.concord232.markdown b/source/_components/alarm_control_panel.concord232.markdown index 86be0b7517..36f897e21e 100644 --- a/source/_components/alarm_control_panel.concord232.markdown +++ b/source/_components/alarm_control_panel.concord232.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Concord232 Alarm Control Panel" -description: "Instructions how to integrate Interlogix/GE Concord4 with RS-232 Automation Control Module into Home Assistant." +description: "Instructions on how to integrate Interlogix/GE Concord4 with RS-232 Automation Control Module into Home Assistant." date: 2016-10-11 10:00 sidebar: true comments: false @@ -16,7 +16,7 @@ The `concord232` platform provides integration with GE, Interlogix (and other br To use this platform, you will need to have the external concord232 client and server installed. The server must be running on the device which is connected to the automation module's serial port. The client must be installed on the machine running Home Assistant. These may often be the same machine, but do not have to be. For additional details in setting up and testing the client and server, see -To enable this platform in home assistant, add the following lines to your `configuration.yaml`: +To enable this platform in Home Assistant, add the following lines to your `configuration.yaml`: ```yaml # Example configuration.yaml entry diff --git a/source/_components/alarm_control_panel.egardia.markdown b/source/_components/alarm_control_panel.egardia.markdown index 314a1fcd11..bef700af16 100644 --- a/source/_components/alarm_control_panel.egardia.markdown +++ b/source/_components/alarm_control_panel.egardia.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Egardia / Woonveilig Alarm Control Panel" -description: "Instructions how to integrate Egardia / Woonveilig into Home Assistant." +description: "Instructions on how to integrate Egardia / Woonveilig into Home Assistant." date: 2016-07-02 22:00 sidebar: true comments: false diff --git a/source/_components/alarm_control_panel.envisalink.markdown b/source/_components/alarm_control_panel.envisalink.markdown index b5b6b3d593..fe58c6fb4d 100644 --- a/source/_components/alarm_control_panel.envisalink.markdown +++ b/source/_components/alarm_control_panel.envisalink.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Envisalink Alarm" -description: "Instructions how to setup the Envisalink Alarm control panel within Home Assistant." +description: "Instructions on how to setup the Envisalink Alarm control panel within Home Assistant." date: 2016-07-01 08:00 sidebar: true comments: false diff --git a/source/_components/alarm_control_panel.ialarm.markdown b/source/_components/alarm_control_panel.ialarm.markdown index db0288b47f..d72261c908 100644 --- a/source/_components/alarm_control_panel.ialarm.markdown +++ b/source/_components/alarm_control_panel.ialarm.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Antifurto365 iAlarm Control Panel" -description: "Instructions how to integrate iAlarms alarms into Home Assistant." +description: "Instructions on how to integrate iAlarms alarms into Home Assistant." date: 2017-11-30 20:00 sidebar: true comments: false diff --git a/source/_components/alarm_control_panel.ifttt.markdown b/source/_components/alarm_control_panel.ifttt.markdown new file mode 100644 index 0000000000..9dcf52521f --- /dev/null +++ b/source/_components/alarm_control_panel.ifttt.markdown @@ -0,0 +1,93 @@ +--- +layout: page +title: "IFTTT Alarm Control Panel" +description: "Instructions on how to integrate IFTTT-controlled security systems into Home Assistant." +date: 2018-03-10 21:00 +sidebar: true +comments: false +sharing: true +footer: true +logo: ifttt.png +ha_category: Alarm +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. + +

+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. +

+ +To enable this, setup the required IFTTT applets as listed below and add the following lines to your `configuration.yaml` file: + +```yaml +# Example configuration.yaml entry +ifttt: + key: YOUR_WEBHOOK_KEY + +alarm_control_panel: + - platform: ifttt + name: YOUR_ALARM_NAME + code: YOUR_ALARM_CODE + event_arm_away: YOUR_ARM_AWAY_EVENT + event_arm_home: YOUR_ARM_HOME_EVENT + event_arm_night: YOUR_ARM_NIGHT_EVENT + event_disarm: YOUR_DISARM_EVENT +``` + +

+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 adviced to [setup encryption using Let's Encrypt](https://home-assistant.io/blog/2017/09/27/effortless-encryption-with-lets-encrypt-and-duckdns/). +

+ +{% linkable_title Required IFTTT applets %} + +This platform supports the services `alarm_disarm`, `alarm_arm_away`, `alarm_arm_home` and `alarm_arm_night`. For each of these services, an IFTTT webhook will be triggered. + +For this system to operate correctly, the following IFTTT applets have to be setup. Obviously, if your alarm device does not support some states, no applets have to be provided for those. +* **IF** Webhook event `YOUR_DISARM_EVENT` is called, **THEN** disarm the alarm system. +* **IF** Webhook event `YOUR_ARM_HOME_EVENT` is called, **THEN** set the alarm system to armed home. +* **IF** Webhook event `YOUR_ARM_NIGHT_EVENT` is called, **THEN** set the alarm system to armed away. +* **IF** Webhook event `YOUR_DISARM_EVENT` is called, **THEN** set the alarm system to armed night. +* **IF** the alarm system was disarmed, **THEN** perform a Webhook `POST` web request to url `https://HASS_URL/api/services/alarm_control_panel/ifttt_push_alarm_state?api_password=API_PASSWORD` with content type `application/json` and body `{"entity_id": "alarm_control_panel.DEVICE_NAME", "state": "disarmed"}`. +* **IF** the alarm system state changed to armed home, **THEN** perform a Webhook `POST` web request to url `https://HASS_URL/api/services/alarm_control_panel/ifttt_push_alarm_state?api_password=API_PASSWORD` with content type `application/json` and body `{"entity_id": "alarm_control_panel.DEVICE_NAME", "state": "armed_home"}`. +* **IF** the alarm system state changed to armed away, **THEN** perform a Webhook `POST` web request to url `https://HASS_URL/api/services/alarm_control_panel/ifttt_push_alarm_state?api_password=API_PASSWORD` with content type `application/json` and body `{"entity_id": "alarm_control_panel.DEVICE_NAME", "state": "armed_away"}`. +* **IF** the alarm system state changed to armed night, **THEN** perform a Webhook `POST` web request to url `https://HASS_URL/api/services/alarm_control_panel/ifttt_push_alarm_state?api_password=API_PASSWORD` with content type `application/json` and body `{"entity_id": "alarm_control_panel.DEVICE_NAME", "state": "armed_night"}`. + + +{% configuration %} + name: + description: The name of your Home Assistant alarm control panel. + required: false + type: string + code: + description: The code for the alarm control panel. + required: false + type: string + event_arm_away: + description: IFTTT webhook event to call when the state is set to armed away. + required: false + type: string + default: alarm_arm_away + event_arm_home: + description: IFTTT webhook event to call when the state is set to armed home. + required: false + type: string + default: alarm_arm_home + event_arm_night: + description: IFTTT webhook event to call when the state is set to armed night. + required: false + type: string + default: alarm_arm_night + event_disarm: + description: IFTTT webhook event to call when the state is set to disarmed. + required: false + type: string + default: alarm_disarm + optimistic: + description: Specify if the state will be updated by a ifttt_push_alarm_state call (false) or can be set immediately (true). + required: false + type: boolean + default: false +{% endconfiguration %} diff --git a/source/_components/alarm_control_panel.manual.markdown b/source/_components/alarm_control_panel.manual.markdown index 86509ebe62..feeda4b768 100644 --- a/source/_components/alarm_control_panel.manual.markdown +++ b/source/_components/alarm_control_panel.manual.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Manual Alarm Control Panel" -description: "Instructions how to integrate manual alarms into Home Assistant." +description: "Instructions on how to integrate manual alarms into Home Assistant." date: 2015-10-13 19:10 sidebar: true comments: false diff --git a/source/_components/alarm_control_panel.manual_mqtt.markdown b/source/_components/alarm_control_panel.manual_mqtt.markdown index 5a1a7d139c..5ceaa64e3a 100644 --- a/source/_components/alarm_control_panel.manual_mqtt.markdown +++ b/source/_components/alarm_control_panel.manual_mqtt.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Manual Alarm Control Panel with MQTT Support" -description: "Instructions how to integrate manual alarms into Home Assistant with MQTT support." +description: "Instructions on how to integrate manual alarms into Home Assistant with MQTT support." date: 2017-07-02 9:10 sidebar: true comments: false diff --git a/source/_components/alarm_control_panel.markdown b/source/_components/alarm_control_panel.markdown index ba5f469915..bdc1adf398 100644 --- a/source/_components/alarm_control_panel.markdown +++ b/source/_components/alarm_control_panel.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Alarm Control Panels" -description: "Instructions how to integrate Alarm Control Panels into Home Assistant." +description: "Instructions on how to integrate Alarm Control Panels into Home Assistant." date: 2015-10-13 19:10 sidebar: true comments: false diff --git a/source/_components/alarm_control_panel.mqtt.markdown b/source/_components/alarm_control_panel.mqtt.markdown index 199ebacaee..cb93a1b595 100644 --- a/source/_components/alarm_control_panel.mqtt.markdown +++ b/source/_components/alarm_control_panel.mqtt.markdown @@ -1,7 +1,7 @@ --- layout: page title: "MQTT Alarm Control Panel" -description: "Instructions how to integrate MQTT capable Alarm Panels into Home Assistant." +description: "Instructions on how to integrate MQTT capable Alarm Panels into Home Assistant." date: 2015-09-14 19:10 sidebar: true comments: false diff --git a/source/_components/alarm_control_panel.nx584.markdown b/source/_components/alarm_control_panel.nx584.markdown index 0a14c880db..a98ad9050a 100644 --- a/source/_components/alarm_control_panel.nx584.markdown +++ b/source/_components/alarm_control_panel.nx584.markdown @@ -1,7 +1,7 @@ --- layout: page title: "NX584 Alarm Control Panel" -description: "Instructions how to integrate NX584 into Home Assistant." +description: "Instructions on how to integrate NX584 into Home Assistant." date: 2016-02-07 10:00 sidebar: true comments: false diff --git a/source/_components/alarm_control_panel.satel_integra.markdown b/source/_components/alarm_control_panel.satel_integra.markdown index 77752ae7d0..a5f8915d08 100644 --- a/source/_components/alarm_control_panel.satel_integra.markdown +++ b/source/_components/alarm_control_panel.satel_integra.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Satel Integra Alarm Control Panel" -description: "Instructions how to setup the Satel Integra control panel within Home Assistant." +description: "Instructions on how to setup the Satel Integra control panel within Home Assistant." date: 2017-09-07 13:28 sidebar: true comments: false diff --git a/source/_components/alarm_control_panel.simplisafe.markdown b/source/_components/alarm_control_panel.simplisafe.markdown index af38f6ad37..ac5c14183a 100644 --- a/source/_components/alarm_control_panel.simplisafe.markdown +++ b/source/_components/alarm_control_panel.simplisafe.markdown @@ -1,7 +1,7 @@ --- layout: page title: "SimpliSafe Alarm Control Panel" -description: "Instructions how to integrate SimpliSafe into Home Assistant." +description: "Instructions on how to integrate SimpliSafe into Home Assistant." date: 2016-07-02 22:00 sidebar: true comments: false diff --git a/source/_components/alarm_control_panel.spc.markdown b/source/_components/alarm_control_panel.spc.markdown index 78e7066f00..5cc4025f00 100644 --- a/source/_components/alarm_control_panel.spc.markdown +++ b/source/_components/alarm_control_panel.spc.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Vanderbilt SPC Alarm" -description: "Instructions how to setup the Vanderbilt SPC Alarm control panel within Home Assistant." +description: "Instructions on how to setup the Vanderbilt SPC Alarm control panel within Home Assistant." date: 2017-05-18 22:01 sidebar: true comments: false diff --git a/source/_components/alarm_control_panel.totalconnect.markdown b/source/_components/alarm_control_panel.totalconnect.markdown index 668b749205..821d38075e 100644 --- a/source/_components/alarm_control_panel.totalconnect.markdown +++ b/source/_components/alarm_control_panel.totalconnect.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Honeywell TotalConnect Alarm Control Panel" -description: "Instructions how to integrate TotalConnect alarms into Home Assistant." +description: "Instructions on how to integrate TotalConnect alarms into Home Assistant." date: 2017-04-02 22:00 sidebar: true comments: false diff --git a/source/_components/alarm_control_panel.verisure.markdown b/source/_components/alarm_control_panel.verisure.markdown index 0c06294c3e..669de86761 100644 --- a/source/_components/alarm_control_panel.verisure.markdown +++ b/source/_components/alarm_control_panel.verisure.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Verisure Alarm" -description: "Instructions how to setup the Verisure Alarm control panel within Home Assistant." +description: "Instructions on how to setup the Verisure Alarm control panel within Home Assistant." date: 2016-02-15 22:00 sidebar: true comments: false diff --git a/source/_components/alarm_control_panel.wink.markdown b/source/_components/alarm_control_panel.wink.markdown index 032bbd3cb3..e6fee5cdb5 100644 --- a/source/_components/alarm_control_panel.wink.markdown +++ b/source/_components/alarm_control_panel.wink.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Wink Alarm" -description: "Instructions how to setup the Wink alarms within Home Assistant." +description: "Instructions on how to setup the Wink alarms within Home Assistant." date: 2017-01-14 12:00 sidebar: true comments: false diff --git a/source/_components/alert.markdown b/source/_components/alert.markdown index acdf983305..4c59259cde 100644 --- a/source/_components/alert.markdown +++ b/source/_components/alert.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Alert" -description: "Instructions how to setup automatic alerts within Home Assistant." +description: "Instructions on how to setup automatic alerts within Home Assistant." date: 2017-01-15 20:00 sidebar: true comments: false diff --git a/source/_components/alexa.markdown b/source/_components/alexa.markdown index e7bfbfa746..23c8bc9c86 100644 --- a/source/_components/alexa.markdown +++ b/source/_components/alexa.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Alexa / Amazon Echo" -description: "Instructions how to connect Alexa/Amazon Echo to Home Assistant." +description: "Instructions on how to connect Alexa/Amazon Echo to Home Assistant." date: 2015-12-13 13:02 sidebar: true comments: false @@ -46,7 +46,7 @@ Additionally, note that at the time of this writing, your Alexa skill endpoint * OR 2. Change your Home Assistant serving port to 443 this is done in the [`http`](/components/http/) section with the `server_port` entry in your `configuration.yaml` file -[blog-lets-encrypt]: https://home-assistant.io/blog/2015/12/13/setup-encryption-using-lets-encrypt/ +[blog-lets-encrypt]: /blog/2015/12/13/setup-encryption-using-lets-encrypt/ To get started with Alexa skills: @@ -167,7 +167,7 @@ intent_script: text: OK ``` -Here we are using [templates] to take the name we gave to Alexa e.g. `downstairs on` and replace the space with an underscore so it becomes `downstairs_on` as Home Assistant expects. +Here we are using [templates] to take the name we gave to Alexa e.g., `downstairs on` and replace the space with an underscore so it becomes `downstairs_on` as Home Assistant expects. Now say `Alexa ask Home Assistant to activate ` and Alexa will activate that scene for you. diff --git a/source/_components/amcrest.markdown b/source/_components/amcrest.markdown index c910e10647..74c76e70dd 100644 --- a/source/_components/amcrest.markdown +++ b/source/_components/amcrest.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Amcrest IP Camera" -description: "Instructions how to integrate Amcrest IP cameras within Home Assistant." +description: "Instructions on how to integrate Amcrest IP cameras within Home Assistant." date: 2017-06-24 10:00 sidebar: true comments: false @@ -13,23 +13,28 @@ ha_iot_class: "Local Polling" ha_release: 0.49 --- -The `amcrest` platform allows you to integrate your [Amcrest](https://amcrest.com/) IP camera in Home Assistant. +The `amcrest` camera platform allows you to integrate your [Amcrest](https://amcrest.com/) IP camera in Home Assistant. + +## {% linkable_title Configuration %} To enable your camera in your installation, add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry amcrest: - - host: IP_ADDRESS - username: USERNAME - password: PASSWORD + - host: IP_ADDRESS_CAMERA_1 + username: YOUR_USERNAME + password: YOUR_PASSWORD sensors: - motion_detector - sdcard + switches: + - motion_detection + - motion_recording - - host: IP_ADDRESS - username: USERNAME - password: PASSWORD + - host: IP_ADDRESS_CAMERA_2 + username: YOUR_USERNAME + password: YOUR_PASSWORD resolution: low stream_source: snapshot sensors: @@ -45,18 +50,21 @@ Configuration variables: - **port** (*Optional*): The port that the camera is running on. The default is 80. - **resolution** (*Optional*): This parameter allows you to specify the camera resolution. For a high resolution (1080/720p), specify the option `high`. For VGA resolution (640x480p), specify the option `low`. If omitted, it defaults to *high*. - **stream_source** (*Optional*): The data source for the live stream. `mjpeg` will use the camera's native MJPEG stream, whereas `snapshot` will use the camera's snapshot API to create a stream from still images. You can also set the `rtsp` option to generate the streaming via RTSP protocol. If omitted, it defaults to *snapshot*. -- **ffmpeg_arguments**: (*Optional*): Extra options to pass to ffmpeg, e.g. image quality or video filter options. +- **ffmpeg_arguments**: (*Optional*): Extra options to pass to ffmpeg, e.g., image quality or video filter options. - **authentication**: (*Optional*): Defines which authentication method to use only when **stream_source** is **mjpeg**. Currently, *aiohttp* only support *basic*. It defaults to *basic*. - **scan_interval** (*Optional*): Defines the update interval of the sensor in seconds. The default is 10 seconds. - **sensors** array (*Optional*): Conditions to display in the frontend. By default, *none* of the conditions are enabled. The following conditions can be monitored. - **motion_detector**: Return True/False when a motion is detected - **sdcard**: Return the SD card usage by reporting the total and used space - **ptz_preset**: Return the number of PTZ preset positions configured for the given camera +- **switches** array (*Optional*): Switches to display in the frontend. By default, *none* of the switches are shown. The following switches can be monitored. + - **motion_detection**: Enable/disable motion detection setting + - **motion_recording**: Enable/disable recording on motion detection setting **Note:** Amcrest cameras with newer firmware no longer have the ability to stream `high` definition video with MJPEG encoding. You may need to use `low` resolution stream or the `snapshot` stream source instead. If the quality seems too poor, lower the `Frame Rate (FPS)` and max out the `Bit Rate` settings in your camera's configuration manager. If you defined the *stream_source* to **mjpeg**, make sure your camera supports *Basic* HTTP authentication. Newer Amcrest firmware may not work, then **rtsp** is recommended instead. **Note:** If you set the `stream_source` option to `rtsp`, make sure to follow the steps mentioned at -[FFMPEG](https://home-assistant.io/components/ffmpeg/) documentation to install the `ffmpeg`. +[FFMPEG](/components/ffmpeg/) documentation to install the `ffmpeg`. Finish its configuration by visiting the [Amcrest sensor page](/components/sensor.amcrest/) or [Amcrest camera page](/components/camera.amcrest/). diff --git a/source/_components/android_ip_webcam.markdown b/source/_components/android_ip_webcam.markdown index 5a62ccefde..c616b33a35 100644 --- a/source/_components/android_ip_webcam.markdown +++ b/source/_components/android_ip_webcam.markdown @@ -48,6 +48,9 @@ Sensors: - light - motion - pressure +- proximity +- sound +- video_connections Settings (Switches): @@ -76,6 +79,9 @@ android_ip_webcam: - light - motion - pressure + - proximity + - sound + - video_connections switches: - exposure_lock - ffc diff --git a/source/_components/api.markdown b/source/_components/api.markdown index cdac55a1b4..ba1097738e 100644 --- a/source/_components/api.markdown +++ b/source/_components/api.markdown @@ -1,7 +1,7 @@ --- layout: page title: "API" -description: "Instructions how to setup the RESTful API within Home Assistant." +description: "Instructions on how to setup the RESTful API within Home Assistant." date: 2018-01-21 08:00 sidebar: true comments: false diff --git a/source/_components/apple_tv.markdown b/source/_components/apple_tv.markdown index bba7b7ac78..93d192a00c 100644 --- a/source/_components/apple_tv.markdown +++ b/source/_components/apple_tv.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Apple TV" -description: "Instructions how to integrate Apple TV devices into Home Assistant." +description: "Instructions on how to integrate Apple TV devices into Home Assistant." date: 2017-06-26 20:47 sidebar: true comments: false @@ -13,7 +13,7 @@ ha_iot_class: "Local Push" ha_release: 0.49 --- -The `apple_tv` platform allows you to control an Apple TV (3rd and 4th generation). See the [remote platform](/components/remote.apple_tv/) if you want to send remote control buttons, e.g. arrow keys. +The `apple_tv` platform allows you to control an Apple TV (3rd and 4th generation). See the [remote platform](/components/remote.apple_tv/) if you want to send remote control buttons, e.g., arrow keys.

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. @@ -92,7 +92,7 @@ then device authentication is required. Press the icon in the upper left corner -Select `apple_tv` as domain, `apple_tv_authenticate` as service and enter `{"entity_id": "XXX"}` into "Service Data", but replace XXX with the entity id of your device (e.g. `media_player.apple_tv`). Press the button and hopefully you are presented with an input dialog asking for a pin code: +Select `apple_tv` as domain, `apple_tv_authenticate` as service and enter `{"entity_id": "XXX"}` into "Service Data", but replace XXX with the entity id of your device (e.g., `media_player.apple_tv`). Press the button and hopefully you are presented with an input dialog asking for a pin code: @@ -143,4 +143,3 @@ To play media on an Apple TV with device authentication enabled (e.g., ATV4 with ### {% linkable_title Service `apple_tv_scan` %} Scans the local network for Apple TVs. All found devices are presented as a persistent notification. - diff --git a/source/_components/arduino.markdown b/source/_components/arduino.markdown index 5105f19c4c..ca16dd32b7 100644 --- a/source/_components/arduino.markdown +++ b/source/_components/arduino.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Arduino" -description: "Instructions how to setup an Arduino boards within Home Assistant." +description: "Instructions on how to setup an Arduino boards within Home Assistant." date: 2015-06-27 10:28 sidebar: true comments: false @@ -43,7 +43,7 @@ The exact number can be determined with the command shown below. $ ls /dev/ttyACM* ``` -If that's not working, check your `dmesg` or `journalctl -f` output. Keep in mind that Arduino clones are often using a different name for the port (e.g. `/dev/ttyUSB*`). +If that's not working, check your `dmesg` or `journalctl -f` output. Keep in mind that Arduino clones are often using a different name for the port (e.g., `/dev/ttyUSB*`).

A word of caution: The Arduino boards are not storing states. This means that with every initialization the pins are set to off/low. diff --git a/source/_components/arlo.markdown b/source/_components/arlo.markdown index 479a771329..e82ade68d1 100644 --- a/source/_components/arlo.markdown +++ b/source/_components/arlo.markdown @@ -15,19 +15,27 @@ ha_iot_class: "Cloud Polling" The `arlo` implementation allows you to integrate your [Arlo](https://arlo.netgear.com/) devices in Home Assistant. +## {% linkable_title Configuration %} + To enable device linked in your [Arlo](https://arlo.netgear.com/) account, add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry arlo: - username: you@example.com - password: secret + username: YOUR_USERNAME + password: YOUR_PASSWORD ``` -Configuration variables: - -- **username** (*Required*): The username for accessing your Arlo account. -- **password** (*Required*): The password for accessing your Arlo account. +{% configuration %} +username: + description: The username for accessing your Arlo account. + required: true + type: string +password: + description: The password for accessing your Arlo account. + required: true + type: string +{% endconfiguration %} It is recommended to create a dedicated user on Arlo website to be used within Home Assistant and then share your Arlo cameras. diff --git a/source/_components/asterisk_mbox.markdown b/source/_components/asterisk_mbox.markdown index d0d7ba72fe..2361dfe0c9 100644 --- a/source/_components/asterisk_mbox.markdown +++ b/source/_components/asterisk_mbox.markdown @@ -1,31 +1,32 @@ --- layout: page title: "Asterisk Voicemail" -description: "Instructions how to integrate your existing Asterisk voicemail within Home Assistant." +description: "Instructions on how to integrate your existing Asterisk voicemail within Home Assistant." date: 2017-06-30 18:30 sidebar: true comments: false sharing: true footer: true +logo: asterisk.png ha_category: Other ha_version: 0.51 ha_iot_class: "Local Push" --- -The 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 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. 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) +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) Once that is complete, add the following entry `configuration.yaml` file: ```yaml # Example configuration.yaml entry asterisk_mbox: - password: ASTERISK_PBX_PASSWORD - host: ASTERISK_PBX_SERVER_IP_ADDRESS - port: ASTERISK_PBX_SERVER_PORT + password: ASTERISK_PBX_PASSWORD + host: ASTERISK_PBX_SERVER_IP_ADDRESS + port: ASTERISK_PBX_SERVER_PORT ``` This will add a new 'Mailbox' side-panel, as well as a sensor to indicate # of messages available. diff --git a/source/_components/august.markdown b/source/_components/august.markdown index cbac63c935..818002e14c 100644 --- a/source/_components/august.markdown +++ b/source/_components/august.markdown @@ -15,6 +15,12 @@ ha_iot_class: "Cloud Polling" The `august` component allows you to integrate your [August](http://august.com) devices in Home Assistant. Currently this component supports August Lock and Doorbell. +

+August Lock 2nd Gen will need either August Connect or Doorbell to connect to Home Assistant. +

+ +## {% linkable_title Configuration %} + You will need your August login information (username (either phone# or email), and password) to use this module. To set it up, add the following to your `configuration.yaml` file: @@ -24,27 +30,27 @@ To set it up, add the following to your `configuration.yaml` file: august: login_method: phone username: "+16041234567" - password: secret + password: YOUR_PASSWORD ``` {% configuration %} - login_method: - description: Method to login to your August account, either "email" or "phone". A verification code will be sent to your email or phone during setup. - required: true - type: string - username: - description: The username for accessing your August account. This depends on your login_method, if login_method is email, this will be your email of the account. Otherwise, this will be your phone number. - required: true - type: string - password: - description: The password for accessing your August account. - required: true - type: string - timeout: - description: Timeout to wait for connections. - required: false - type: int - default: 10 +login_method: + description: Method to login to your August account, either "email" or "phone". A verification code will be sent to your email or phone during setup. + required: true + type: string +username: + description: The username for accessing your August account. This depends on your login_method, if login_method is email, this will be your email of the account. Otherwise, this will be your phone number. + required: true + type: string +password: + description: The password for accessing your August account. + required: true + type: string +timeout: + description: Timeout to wait for connections. + required: false + type: int + default: 10 {% endconfiguration %} 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. diff --git a/source/_components/automation.markdown b/source/_components/automation.markdown index 181d28ba12..658c0ebc63 100644 --- a/source/_components/automation.markdown +++ b/source/_components/automation.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Automation" -description: "Instructions how to setup automation within Home Assistant." +description: "Instructions on how to setup automation within Home Assistant." date: 2015-01-20 22:36 sidebar: true comments: false @@ -19,7 +19,7 @@ Starting with 0.28 your automation rules can be controlled with the frontend.

-This allows one to reload the automation without restarting Home Assistant itself. If you don't want to see the automation rule in your frontend use `hide_entity: True` to hide it. You can also use `initial_state: 'off'` so that the automation is not automatically turned on after a Home assistant reboot. +This allows one to reload the automation without restarting Home Assistant itself. If you don't want to see the automation rule in your frontend use `hide_entity: True` to hide it. You can also use `initial_state: 'off'` so that the automation is not automatically turned on after a Home Assistant reboot. ```yaml automation: diff --git a/source/_components/bbb_gpio.markdown b/source/_components/bbb_gpio.markdown index ab6a13d94e..785aec4f2d 100644 --- a/source/_components/bbb_gpio.markdown +++ b/source/_components/bbb_gpio.markdown @@ -1,7 +1,7 @@ --- layout: page title: "BeagleBone Black GPIO" -description: "Instructions how to integrate the GPIO capability of a BeagleBone Black into Home Assistant." +description: "Instructions on how to integrate the GPIO capability of a BeagleBone Black into Home Assistant." date: 2017-01-14 10:00 sidebar: true comments: false diff --git a/source/_components/binary_sensor.abode.markdown b/source/_components/binary_sensor.abode.markdown index 14e8e14533..def5cabb19 100644 --- a/source/_components/binary_sensor.abode.markdown +++ b/source/_components/binary_sensor.abode.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Abode Binary Sensor" -description: "Instructions how to integrate Abode binary sensors into Home Assistant." +description: "Instructions on how to integrate Abode binary sensors into Home Assistant." date: 2017-08-26 0:28 sidebar: true comments: false diff --git a/source/_components/binary_sensor.alarmdecoder.markdown b/source/_components/binary_sensor.alarmdecoder.markdown index 1bfbd1be9f..92cfa7fa4e 100644 --- a/source/_components/binary_sensor.alarmdecoder.markdown +++ b/source/_components/binary_sensor.alarmdecoder.markdown @@ -1,7 +1,7 @@ --- layout: page title: "AlarmDecoder Binary Sensor" -description: "Instructions how to integrate AlarmDecoder binary sensors into Home Assistant." +description: "Instructions on how to integrate AlarmDecoder binary sensors into Home Assistant." date: 2017-04-02 13:28 sidebar: true comments: false diff --git a/source/_components/binary_sensor.android_ip_webcam.markdown b/source/_components/binary_sensor.android_ip_webcam.markdown index 80775c3b2e..0c5c2abbe8 100644 --- a/source/_components/binary_sensor.android_ip_webcam.markdown +++ b/source/_components/binary_sensor.android_ip_webcam.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Android IP Webcam Binary Sensor" -description: "Instructions how to integrate binary motion sensors for Android IP webcam within Home Assistant." +description: "Instructions on how to integrate binary motion sensors for Android IP webcam within Home Assistant." date: 2017-03-10 00:00 sidebar: true comments: false diff --git a/source/_components/binary_sensor.arest.markdown b/source/_components/binary_sensor.arest.markdown index 8b359f464a..d18a2d321a 100644 --- a/source/_components/binary_sensor.arest.markdown +++ b/source/_components/binary_sensor.arest.markdown @@ -1,7 +1,7 @@ --- layout: page title: "aREST Binary Sensor" -description: "Instructions how to integrate aREST binary sensors within Home Assistant." +description: "Instructions on how to integrate aREST binary sensors within Home Assistant." date: 2015-11-20 18:15 sidebar: true comments: false @@ -28,7 +28,7 @@ binary_sensor: Configuration variables: -- **resource** (*Required*): IP address and schema of the device that is exposing an aREST API, e.g. http://192.168.1.10. +- **resource** (*Required*): IP address and schema of the device that is exposing an aREST API, e.g., http://192.168.1.10. - **pin** (*Required*): Number of the pin to monitor. - **name** (*Optional*): Let you overwrite the name of the device. By default *name* from the device is used. diff --git a/source/_components/binary_sensor.axis.markdown b/source/_components/binary_sensor.axis.markdown index 77ece6d147..939cc8f76d 100644 --- a/source/_components/binary_sensor.axis.markdown +++ b/source/_components/binary_sensor.axis.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Axis Binary Sensor" -description: "Instructions how to integrate Axis binary sensors into Home Assistant." +description: "Instructions on how to integrate Axis binary sensors into Home Assistant." date: 2017-04-01 19:00 sidebar: true comments: false diff --git a/source/_components/binary_sensor.bayesian.markdown b/source/_components/binary_sensor.bayesian.markdown index 0d2858e982..ad52a8e85f 100644 --- a/source/_components/binary_sensor.bayesian.markdown +++ b/source/_components/binary_sensor.bayesian.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Bayesian Binary Sensor" -description: "Instructions how to integrate threshold Bayesian sensors into Home Assistant." +description: "Instructions on how to integrate threshold Bayesian sensors into Home Assistant." date: 2017-08-27 20:05 sidebar: true comments: false diff --git a/source/_components/binary_sensor.bbb_gpio.markdown b/source/_components/binary_sensor.bbb_gpio.markdown index b7236d5468..be2a9bd9fb 100644 --- a/source/_components/binary_sensor.bbb_gpio.markdown +++ b/source/_components/binary_sensor.bbb_gpio.markdown @@ -1,7 +1,7 @@ --- layout: page title: "BeagleBone Black GPIO Binary Sensor" -description: "Instructions how to integrate the GPIO sensor capability of a BeagleBone Black into Home Assistant." +description: "Instructions on how to integrate the GPIO sensor capability of a BeagleBone Black into Home Assistant." date: 2017-01-14 10:00 sidebar: true comments: false diff --git a/source/_components/binary_sensor.bmw_connected_drive.markdown b/source/_components/binary_sensor.bmw_connected_drive.markdown new file mode 100755 index 0000000000..74330ec563 --- /dev/null +++ b/source/_components/binary_sensor.bmw_connected_drive.markdown @@ -0,0 +1,20 @@ +--- +layout: page +title: "BMW Connected Drive Binary Sensor" +description: "Instructions on how to setup your BMW Connected Drive account with Home Assistant." +date: 2018-02-22 23:00 +sidebar: true +comments: false +sharing: true +footer: true +logo: bmw.png +ha_category: Binary Sensor +ha_release: 0.66 +--- + + +The `bmw_connected_drive` platform allows you to import data on your BMW into Home Assistant. + +The binary sensors will be automatically configured if `bmw_connected_drive` component is configured. + +For more configuration information see the [`bmw_connected_drive` component](/components/bmw_connected_drive/) documentation. diff --git a/source/_components/binary_sensor.command_line.markdown b/source/_components/binary_sensor.command_line.markdown index f966144470..b37d6e40bb 100644 --- a/source/_components/binary_sensor.command_line.markdown +++ b/source/_components/binary_sensor.command_line.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Command line Binary Sensor" -description: "Instructions how to integrate Command binary sensors within Home Assistant." +description: "Instructions on how to integrate Command binary sensors within Home Assistant." date: 2016-01-13 12:15 sidebar: true comments: false diff --git a/source/_components/binary_sensor.concord232.markdown b/source/_components/binary_sensor.concord232.markdown index 4378b5fb14..39320bb672 100644 --- a/source/_components/binary_sensor.concord232.markdown +++ b/source/_components/binary_sensor.concord232.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Concord232 Binary Sensor" -description: "Instructions how to integrate Interlogix/GE Concord4 binary sensors into Home Assistant." +description: "Instructions on how to integrate Interlogix/GE Concord4 binary sensors into Home Assistant." date: 2016-10-11 10:00 sidebar: true comments: false diff --git a/source/_components/binary_sensor.ecobee.markdown b/source/_components/binary_sensor.ecobee.markdown index 189c943bf9..25f58c42cb 100644 --- a/source/_components/binary_sensor.ecobee.markdown +++ b/source/_components/binary_sensor.ecobee.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Ecobee Binary Sensor" -description: "Instructions how to setup the Ecobee sensors within Home Assistant." +description: "Instructions on how to setup the Ecobee sensors within Home Assistant." date: 2015-11-30 18:00 sidebar: true comments: false diff --git a/source/_components/binary_sensor.egardia.markdown b/source/_components/binary_sensor.egardia.markdown index 8df482bf5b..d418559f8e 100644 --- a/source/_components/binary_sensor.egardia.markdown +++ b/source/_components/binary_sensor.egardia.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Egardia Binary Sensor" -description: "Instructions how to integrate Egardia / Woonveilig binary sensors into Home Assistant." +description: "Instructions on how to integrate Egardia / Woonveilig binary sensors into Home Assistant." date: 2018-03-02 09:00 sidebar: true comments: false diff --git a/source/_components/binary_sensor.eight_sleep.markdown b/source/_components/binary_sensor.eight_sleep.markdown index fa949ae66e..cf9f2c52bf 100644 --- a/source/_components/binary_sensor.eight_sleep.markdown +++ b/source/_components/binary_sensor.eight_sleep.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Eight Sleep Binary Sensor" -description: "Instructions how to integrate binary motion sensors for Eight Sleep within Home Assistant." +description: "Instructions on how to integrate binary motion sensors for Eight Sleep within Home Assistant." date: 2017-04-24 00:00 sidebar: true comments: false diff --git a/source/_components/binary_sensor.envisalink.markdown b/source/_components/binary_sensor.envisalink.markdown index 6e56da0b94..52735a8dbf 100644 --- a/source/_components/binary_sensor.envisalink.markdown +++ b/source/_components/binary_sensor.envisalink.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Envisalink Binary Sensor" -description: "Instructions how to integrate Envisalink binary sensors into Home Assistant." +description: "Instructions on how to integrate Envisalink binary sensors into Home Assistant." date: 2016-07-01 08:00 sidebar: true comments: false diff --git a/source/_components/binary_sensor.ffmpeg_motion.markdown b/source/_components/binary_sensor.ffmpeg_motion.markdown index 453c76d7e0..6635bae9e6 100644 --- a/source/_components/binary_sensor.ffmpeg_motion.markdown +++ b/source/_components/binary_sensor.ffmpeg_motion.markdown @@ -42,7 +42,7 @@ Configuration variables: - **reset** (*Optional*): The time to reset the state after no new motion is detected. Defaults to 20 seconds. - **repeat** (*Optional*): How many events need to be detected in *repeat_time* in order to trigger a motion. Defaults to 0 repeats (deactivated). - **repeat_time** (*Optional*): The span of time *repeat* events need to occur in before triggering a motion. Defaults to 0 seconds (deactivated). -- **extra_arguments** (*Optional*): Extra options to pass to `ffmpeg`, e.g. video denoise filtering. +- **extra_arguments** (*Optional*): Extra options to pass to `ffmpeg`, e.g., video denoise filtering. To experiment with values (changes/100 is the scene value in `ffmpeg`): diff --git a/source/_components/binary_sensor.ffmpeg_noise.markdown b/source/_components/binary_sensor.ffmpeg_noise.markdown index 16b1876143..d68ec7d163 100644 --- a/source/_components/binary_sensor.ffmpeg_noise.markdown +++ b/source/_components/binary_sensor.ffmpeg_noise.markdown @@ -39,7 +39,7 @@ Configuration variables: - **duration** (*Optional*): Default 1 second. How long the noise needs to be over the peak to trigger the state. - **reset** (*Optional*): Default 20 seconds. The time to reset the state after no new noise is over the peak. - **extra_arguments** (*Optional*): Extra options to pass to `ffmpeg`, like audio frequency filtering. -- **output** (*Optional*): Allows you to send the audio output of this sensor to an Icecast server or other FFmpeg-supported output, e.g. to stream with Sonos after a state is triggered. +- **output** (*Optional*): Allows you to send the audio output of this sensor to an Icecast server or other FFmpeg-supported output, e.g., to stream with Sonos after a state is triggered. To experiment with values: diff --git a/source/_components/binary_sensor.flic.markdown b/source/_components/binary_sensor.flic.markdown index 558c30b3a0..3767ed7476 100644 --- a/source/_components/binary_sensor.flic.markdown +++ b/source/_components/binary_sensor.flic.markdown @@ -1,7 +1,7 @@ --- layout: page title: Flic Smart Button -description: "Instructions how to integrate flic buttons within Home Assistant." +description: "Instructions on how to integrate flic buttons within Home Assistant." date: 2016-12-02 22:03 sidebar: true comments: false diff --git a/source/_components/binary_sensor.hikvision.markdown b/source/_components/binary_sensor.hikvision.markdown index 803e8b40a2..7e93130271 100644 --- a/source/_components/binary_sensor.hikvision.markdown +++ b/source/_components/binary_sensor.hikvision.markdown @@ -15,22 +15,22 @@ ha_iot_class: "Local Push" The Hikvision Binary Sensor is a platform that parses the event stream of a [Hikvision IP Camera or NVR](http://www.hikvision.com/) and presents the camera/nvr events to Home Assistant as binary sensors with either an "off" or "on" state. -The platform will automatically add all sensors to Home Assistant that are configured within the camera/nvr interface to "Notify the surveillance center" as a trigger. If you would like to hide a sensor type you can do so by either unchecking "Notify the surveillance center" in the camera configuration or by using the "ignored" customize option detailed below. +The platform will automatically add all sensors to Home Assistant that are configured within the camera/nvr interface to "Notify the surveillance center" as a trigger. If you would like to hide a sensor type you can do so by either unchecking "Notify the surveillance center" in the camera configuration or by using the "ignored" customize option detailed below.

-In order for the sensors to work the hikvision user must have the 'Remote: Notify Surveillance Center / Trigger Alarm Output' permission which can be enabled from the user managment section of the web interace. Also the 'WEB Authentication' needs to be set to 'digest/basic' in the security / authentication section. +In order for the sensors to work the hikvision user must have the 'Remote: Notify Surveillance Center/Trigger Alarm Output' permission which can be enabled from the user management section of the web interface. Also the 'WEB Authentication' needs to be set to 'digest/basic' in the security/authentication section.

For example, if you configure a camera with the name "Front Porch" that has motion detection and line crossing events enabled to notify the surveillance center the following binary sensors will be added to Home Assistant: -``` +```text binary_sensor.front_porch_motion binary_sensor.front_port_line_crossing ``` -When used with a NVR device the sensors will be appended with the channel number they represent. For example, if you configure an NVR with the name "Home" that supports 2 cameras with motion detection and line crossing events enabled to notify the surveillance center the following binary sensors will be added to Home Assistant: +When used with a NVR device the sensors will be appended with the channel number they represent. For example, if you configure an NVR with the name "Home" that supports 2 cameras with motion detection and line crossing events enabled to notify the surveillance center the following binary sensors will be added to Home Assistant: -``` +```text binary_sensor.home_motion_1 binary_sensor.home_motion_2 binary_sensor.home_line_crossing_1 @@ -38,35 +38,37 @@ binary_sensor.home_line_crossing_2 ``` This platform should work with all Hikvision cameras and nvrs, and has been confirmed to work with the following models: + - DS-2CD3132-I - DS-2CD2232-I5 - DS-2CD2032-I - DS-2CD2042WD-I - DS-2CD2142FWD-I -To enable this sensor, the following lines are required in your `configuration.yaml`: +To enable this sensor, the following lines are required in your `configuration.yaml` file: ```yaml binary_sensor: - platform: hikvision - host: IP_ADDRESS - username: user - password: pass + - platform: hikvision + host: IP_ADDRESS + username: user + password: pass ``` Configuration options for a Hikvision Sensor: -- **name** (*Optional*): The name you'd like to give the camera in Home Assistant, defaults to name defined in the camera. - **host** (*Required*): The IP address of the camera you would like to connect to. -- **port** (*Optional*): The port to connect to the camera on, defaults to 80. -- **ssl** (*Optional*): True if you want to connect with https. Be sure to set the port also. - **username** (*Required*): The username to authenticate with. - **password** (*Required*): The password to authenticate with. +- **name** (*Optional*): The name you'd like to give the camera in Home Assistant, defaults to name defined in the camera. +- **port** (*Optional*): The port to connect to the camera on, defaults to 80. +- **ssl** (*Optional*): True if you want to connect with https. Be sure to set the port also. - **customize** (*Optional*): This attribute contains sensor-specific override values. Only sensor name needs defined: - **ignored** (*Optional*): Ignore this sensor completely. It won't be shown in the Web Interface and no events are generated for it. - **delay** (*Optional*): Specify the delay to wait after a sensor event ends before notifying Home Assistant. This is useful to catch multiple quick trips in one window without the state toggling on and off. The default delay is 5 seconds. Supported sensor/event types are: + - Motion - Line Crossing - Field Detection @@ -84,37 +86,36 @@ Supported sensor/event types are: - Face Detection - Scene Change Detection - Example of a configuration in your `configuration.yaml` that utilizes the customize options for a camera: ```yaml binary_sensor: - platform: hikvision - host: 192.168.X.X - port: 80 - ssl: False - username: user - password: pass - customize: - motion: - delay: 30 - line_crossing: - ignored: True + - platform: hikvision + host: 192.168.X.X + port: 80 + ssl: False + username: user + password: pass + customize: + motion: + delay: 30 + line_crossing: + ignored: True ``` Example of a configuration in your `configuration.yaml` that utilizes the customize options for a nvr: ```yaml binary_sensor: - platform: hikvision - host: 192.168.X.X - port: 80 - ssl: False - username: user - password: pass - customize: - motion_1: - delay: 30 - field_detection_2: - ignored: True + - platform: hikvision + host: 192.168.X.X + port: 80 + ssl: False + username: user + password: pass + customize: + motion_1: + delay: 30 + field_detection_2: + ignored: True ``` diff --git a/source/_components/binary_sensor.hive.markdown b/source/_components/binary_sensor.hive.markdown index ef695f4601..49486d62d7 100644 --- a/source/_components/binary_sensor.hive.markdown +++ b/source/_components/binary_sensor.hive.markdown @@ -14,11 +14,12 @@ ha_iot_class: "Cloud Polling" --- -The 'hive' binary sensor component integrates your Hive sensors into Home Assistant. +The `hive` binary sensor component integrates your Hive sensors into Home Assistant. -The Hive sensor component supports the following Hive products: -- **Hive Window or Door Sensor** -- **Hive Motion Sensor** +The platform supports the following Hive products: + +- Hive Window or Door Sensor +- Hive Motion Sensor

diff --git a/source/_components/binary_sensor.homematic.markdown b/source/_components/binary_sensor.homematic.markdown index 37140c8433..5155aedeea 100644 --- a/source/_components/binary_sensor.homematic.markdown +++ b/source/_components/binary_sensor.homematic.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Homematic Binary Sensor" -description: "Instructions how to integrate binary Homematic sensors within Home Assistant." +description: "Instructions on how to integrate binary Homematic sensors within Home Assistant." date: 2016-06-28 08:30 sidebar: true comments: false diff --git a/source/_components/binary_sensor.http.markdown b/source/_components/binary_sensor.http.markdown index aaddf8a725..c2442aa881 100644 --- a/source/_components/binary_sensor.http.markdown +++ b/source/_components/binary_sensor.http.markdown @@ -1,7 +1,7 @@ --- layout: page title: "HTTP Binary Sensor" -description: "Instructions how to integrate HTTP binary sensors within Home Assistant." +description: "Instructions on how to integrate HTTP binary sensors within Home Assistant." date: 2016-02-05 12:15 sidebar: true comments: false diff --git a/source/_components/binary_sensor.ihc.markdown b/source/_components/binary_sensor.ihc.markdown index 5a3d7769de..da5aac7615 100644 --- a/source/_components/binary_sensor.ihc.markdown +++ b/source/_components/binary_sensor.ihc.markdown @@ -1,7 +1,7 @@ --- layout: page title: "IHC Binary Sensor" -description: "Instructions how to integrate IHC Binary Sensors within Home Assistant." +description: "Instructions on how to integrate IHC Binary Sensors within Home Assistant." date: 2017-11-27 13:35 sidebar: true comments: false diff --git a/source/_components/binary_sensor.insteon_plm.markdown b/source/_components/binary_sensor.insteon_plm.markdown index e2930b02dc..d06c324a44 100644 --- a/source/_components/binary_sensor.insteon_plm.markdown +++ b/source/_components/binary_sensor.insteon_plm.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Insteon PLM Binary Sensor" -description: "Instructions how to setup the Insteon PLM binary sensors locally within Home Assistant." +description: "Instructions on how to setup the Insteon PLM binary sensors locally within Home Assistant." date: 2017-02-19 17:00 sidebar: true comments: false diff --git a/source/_components/binary_sensor.isy994.markdown b/source/_components/binary_sensor.isy994.markdown index 1318ef67d1..2cb7345d0e 100644 --- a/source/_components/binary_sensor.isy994.markdown +++ b/source/_components/binary_sensor.isy994.markdown @@ -1,7 +1,7 @@ --- layout: page title: "ISY994 Binary Sensor" -description: "Instructions how to integrate ISY994 binary sensors into Home Assistant." +description: "Instructions on how to integrate ISY994 binary sensors into Home Assistant." date: 2016-09-03 23:00 sidebar: true comments: false diff --git a/source/_components/binary_sensor.knx.markdown b/source/_components/binary_sensor.knx.markdown index 902d59eded..d51c9effbb 100644 --- a/source/_components/binary_sensor.knx.markdown +++ b/source/_components/binary_sensor.knx.markdown @@ -1,7 +1,7 @@ --- layout: page title: "KNX Binary Sensor" -description: "Instructions how to setup the KNX binary sensors within Home Assistant." +description: "Instructions on how to setup the KNX binary sensors within Home Assistant." date: 2016-07-13 07:00 sidebar: true comments: false @@ -32,7 +32,7 @@ Configuration variables: - **name** (*Optional*): A name for this device used within Home Assistant. - **address**: KNX group address of the binary sensor. -- **device_class** (Optional): HASS device class e.g. "motion". +- **device_class** (Optional): HASS device class e.g., "motion". - **significant_bit** (Optional): Specify which significant bit of the KNX value should be used. Default is 1. - **reset_after** (Optional): Reset back to OFF state after specified milliseconds. diff --git a/source/_components/binary_sensor.markdown b/source/_components/binary_sensor.markdown index 9781df8e23..fe8f4a5107 100644 --- a/source/_components/binary_sensor.markdown +++ b/source/_components/binary_sensor.markdown @@ -11,6 +11,8 @@ footer: true 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 %} + 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: - **None**: Generic on/off. This is the default and doesn't need to be set. @@ -38,4 +40,9 @@ 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](https://home-assistant.io/components/#sensor). +For analog sensors please check the [component overview](/components/#sensor). + +

+ +Example of various device classes icons in `On` and `Off` state. +

diff --git a/source/_components/binary_sensor.modbus.markdown b/source/_components/binary_sensor.modbus.markdown index 55450b908e..62f5765dd3 100644 --- a/source/_components/binary_sensor.modbus.markdown +++ b/source/_components/binary_sensor.modbus.markdown @@ -15,10 +15,12 @@ ha_iot_class: "Local Push" The `modbus` binary sensor allows you to gather data from [Modbus](http://www.modbus.org/) coils. +## {% linkable_title Configuration %} + To use your Modbus binary sensors in your installation, add the following to your `configuration.yaml` file: ```yaml -# Example configuration.yml entry +# Example configuration.yaml entry binary_sensor: - platform: modbus coils: @@ -39,7 +41,7 @@ Configuration variables: 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 %} +## {% linkable_title Full example %} Example a sensor with a 10 seconds scan interval: diff --git a/source/_components/binary_sensor.mqtt.markdown b/source/_components/binary_sensor.mqtt.markdown index 60b6477ea0..92ac12ccb0 100644 --- a/source/_components/binary_sensor.mqtt.markdown +++ b/source/_components/binary_sensor.mqtt.markdown @@ -1,7 +1,7 @@ --- layout: page title: "MQTT Binary Sensor" -description: "Instructions how to integrate MQTT binary sensors within Home Assistant." +description: "Instructions on how to integrate MQTT binary sensors within Home Assistant." date: 2015-05-30 23:21 sidebar: true comments: false @@ -17,6 +17,8 @@ The `mqtt` binary sensor platform uses an MQTT message payload to set the binary The binary sensor state will be updated only after a new message is published on `state_topic` matching `payload_on` or `payload_off`. If these messages are published with the `retain` flag set, 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 %} + 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 cover 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. To use an MQTT binary sensor in your installation, add the following to your `configuration.yaml` file: @@ -42,12 +44,12 @@ payload_on: description: The payload that represents the on state. required: false type: string - default: ON + default: "ON" payload_off: description: The payload that represents the off state. required: false type: string - default: OFF + default: "OFF" availability_topic: description: "The MQTT topic subscribed to receive birth and LWT messages from the MQTT device. If `availability_topic` is not defined, the binary sensor availability state will always be `available`. If `availability_topic` is defined, the binary sensor availability state will be `unavailable` by default." required: false @@ -131,7 +133,7 @@ The configuration will look like the example below: {% raw %} ```yaml -# Example configuration.yml entry +# Example configuration.yaml entry binary_sensor: - platform: mqtt name: Bathroom diff --git a/source/_components/binary_sensor.mysensors.markdown b/source/_components/binary_sensor.mysensors.markdown index 488bb713f6..6138b927af 100644 --- a/source/_components/binary_sensor.mysensors.markdown +++ b/source/_components/binary_sensor.mysensors.markdown @@ -1,7 +1,7 @@ --- layout: page title: "MySensors Binary Sensor" -description: "Instructions how to integrate MySensors binary sensors into Home Assistant." +description: "Instructions on how to integrate MySensors binary sensors into Home Assistant." date: 2016-04-13 14:20 +0100 sidebar: true comments: false diff --git a/source/_components/binary_sensor.mystrom.markdown b/source/_components/binary_sensor.mystrom.markdown index 6d093a2f25..f46df4afc1 100644 --- a/source/_components/binary_sensor.mystrom.markdown +++ b/source/_components/binary_sensor.mystrom.markdown @@ -1,7 +1,7 @@ --- layout: page title: "myStrom Binary Sensor" -description: "Instructions how to integrate myStrom buttons into Home Assistant." +description: "Instructions on how to integrate myStrom buttons into Home Assistant." date: 2017-04-14 08:15 sidebar: true comments: false diff --git a/source/_components/binary_sensor.nest.markdown b/source/_components/binary_sensor.nest.markdown index fa0a264474..4cb47776c6 100644 --- a/source/_components/binary_sensor.nest.markdown +++ b/source/_components/binary_sensor.nest.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Nest Binary Sensor" -description: "Instructions how to integrate Nest binary sensors within Home Assistant." +description: "Instructions on how to integrate Nest binary sensors within Home Assistant." date: 2016-01-26 08:00 sidebar: true comments: false diff --git a/source/_components/binary_sensor.netatmo.markdown b/source/_components/binary_sensor.netatmo.markdown index 57d01bbd08..da2f8ab1fe 100644 --- a/source/_components/binary_sensor.netatmo.markdown +++ b/source/_components/binary_sensor.netatmo.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Netatmo Binary Sensor" -description: "Instructions how to integrate Netatmo binary sensor into Home Assistant." +description: "Instructions on how to integrate Netatmo binary sensor into Home Assistant." date: 2016-09-19 15:10 sidebar: true comments: false diff --git a/source/_components/binary_sensor.octoprint.markdown b/source/_components/binary_sensor.octoprint.markdown index c4bf736c3b..369205ad94 100644 --- a/source/_components/binary_sensor.octoprint.markdown +++ b/source/_components/binary_sensor.octoprint.markdown @@ -1,7 +1,7 @@ --- layout: page title: "OctoPrint Binary Sensor" -description: "Instructions how to integrate OctoPrint binary sensors within Home Assistant." +description: "Instructions on how to integrate OctoPrint binary sensors within Home Assistant." date: 2016-05-05 08:00 sidebar: true comments: false diff --git a/source/_components/binary_sensor.pilight.markdown b/source/_components/binary_sensor.pilight.markdown index 4ccf527392..ee7a729196 100644 --- a/source/_components/binary_sensor.pilight.markdown +++ b/source/_components/binary_sensor.pilight.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Pilight Binary Sensor" -description: "Instructions how to integrate Pilight binary sensors within Home Assistant." +description: "Instructions on how to integrate Pilight binary sensors within Home Assistant." date: 2017-03-24 20:41 sidebar: true comments: false @@ -15,10 +15,12 @@ ha_iot_class: "Local Polling" The `pilight` binary sensor platform implement the [pilight hub](/components/pilight/) binary sensor functionality. Two type of Pilight binary sensor configuration available. A normal sensor which send the on and off state cyclical and a trigger sensor which send only a trigger when an event happened (for example lots of cheap PIR motion detector). + + To enable a Pilight binary sensor in your installation, add the following to your `configuration.yaml` file: ```yaml -# Example configuration.yml entry +# Example configuration.yaml entry binary_sensor: - platform: pilight variable: 'state' diff --git a/source/_components/binary_sensor.ping.markdown b/source/_components/binary_sensor.ping.markdown index d8d8ec310b..b0be627136 100644 --- a/source/_components/binary_sensor.ping.markdown +++ b/source/_components/binary_sensor.ping.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Ping (ICMP) Binary sensor" -description: "Instructions how to integrate Ping (ICMP)-based binary sensors into Home Assistant." +description: "Instructions on how to integrate Ping (ICMP)-based binary sensors into Home Assistant." date: 2017-04-11 08:00 sidebar: true comments: false diff --git a/source/_components/binary_sensor.qwikswitch.markdown b/source/_components/binary_sensor.qwikswitch.markdown new file mode 100644 index 0000000000..e3fd446a3b --- /dev/null +++ b/source/_components/binary_sensor.qwikswitch.markdown @@ -0,0 +1,18 @@ +--- +layout: page +title: "QwikSwitch Binary Sensor" +description: "Instructions on how to integrate Qwikswitch dimmers and relays as sensors into Home Assistant." +date: 2016-05-04 00:00 +sidebar: true +comments: false +sharing: true +footer: true +logo: qwikswitch.png +ha_category: Sensor +ha_iot_class: "Local Push" +ha_release: "0.68" +--- + +The `qwikswitch` binary_sensor platform allows you to use your [QwikSwitch](http://www.qwikswitch.co.za/) sensors within Home Assistant. + +The platform is configured through the [QwikSwitch component](/components/qwikswitch/). diff --git a/source/_components/binary_sensor.random.markdown b/source/_components/binary_sensor.random.markdown index ea8de4b90c..b1208681a8 100644 --- a/source/_components/binary_sensor.random.markdown +++ b/source/_components/binary_sensor.random.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Random Binary Sensor" -description: "Instructions how to integrate random state sensors into Home Assistant." +description: "Instructions on how to integrate random state sensors into Home Assistant." date: 2017-10-27 08:00 sidebar: true comments: false @@ -16,6 +16,8 @@ ha_release: 0.57 The `random` binary sensor platform is creating random states (`True`, 1, `on` or `False`, 0, `off`). This can be useful if you want to test automation rules. It generates a new state every time it is polled. +## {% linkable_title Configuration %} + To enable the random binary sensor, add the following lines to your `configuration.yaml`: ```yaml diff --git a/source/_components/binary_sensor.raspihats.markdown b/source/_components/binary_sensor.raspihats.markdown index 83f355aaf5..50d031c457 100644 --- a/source/_components/binary_sensor.raspihats.markdown +++ b/source/_components/binary_sensor.raspihats.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Raspihats Binary Sensor" -description: "Instructions how to integrate Raspihats add-on boards for Raspberry Pi into Home Assistant as a binary_sensor." +description: "Instructions on how to integrate Raspihats add-on boards for Raspberry Pi into Home Assistant as a binary_sensor." date: 2017-05-01 04:09 sidebar: true comments: false diff --git a/source/_components/binary_sensor.rest.markdown b/source/_components/binary_sensor.rest.markdown index 4739781d2f..d882e5b406 100644 --- a/source/_components/binary_sensor.rest.markdown +++ b/source/_components/binary_sensor.rest.markdown @@ -1,7 +1,7 @@ --- layout: page title: "RESTful Binary Sensor" -description: "Instructions how to integrate REST binary sensors into Home Assistant." +description: "Instructions on how to integrate REST binary sensors into Home Assistant." date: 2015-12-17 19:10 sidebar: true comments: false diff --git a/source/_components/binary_sensor.rfxtrx.markdown b/source/_components/binary_sensor.rfxtrx.markdown index c676c46cec..296af16317 100644 --- a/source/_components/binary_sensor.rfxtrx.markdown +++ b/source/_components/binary_sensor.rfxtrx.markdown @@ -1,7 +1,7 @@ --- layout: page title: "RFXtrx Binary Sensor" -description: "Instructions how to integrate RFXtrx binary sensors into Home Assistant." +description: "Instructions on how to integrate RFXtrx binary sensors into Home Assistant." date: 2017-03-26 12:45 sidebar: true comments: false diff --git a/source/_components/binary_sensor.rpi_gpio.markdown b/source/_components/binary_sensor.rpi_gpio.markdown index dbae9b1b8d..a59333d82c 100644 --- a/source/_components/binary_sensor.rpi_gpio.markdown +++ b/source/_components/binary_sensor.rpi_gpio.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Raspberry Pi GPIO Binary Sensor" -description: "Instructions how to integrate the GPIO sensor capability of a Raspberry Pi into Home Assistant." +description: "Instructions on how to integrate the GPIO sensor capability of a Raspberry Pi into Home Assistant." date: 2015-08-30 19:00 sidebar: true comments: false diff --git a/source/_components/binary_sensor.rpi_pfio.markdown b/source/_components/binary_sensor.rpi_pfio.markdown index 84404f4d78..d02cfaf2da 100644 --- a/source/_components/binary_sensor.rpi_pfio.markdown +++ b/source/_components/binary_sensor.rpi_pfio.markdown @@ -1,7 +1,7 @@ --- layout: page title: "PiFace Digital I/O Binary Sensor" -description: "Instructions how to integrate the PiFace Digital I/O module into Home Assistant as a binary sensor." +description: "Instructions on how to integrate the PiFace Digital I/O module into Home Assistant as a binary sensor." date: 2016-05-08 15:00 sidebar: true comments: false diff --git a/source/_components/binary_sensor.satel_integra.markdown b/source/_components/binary_sensor.satel_integra.markdown index 84744aaa9e..5d879e4966 100644 --- a/source/_components/binary_sensor.satel_integra.markdown +++ b/source/_components/binary_sensor.satel_integra.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Satel Integra Binary Sensor" -description: "Instructions how to integrate Satel Integra binary sensors into Home Assistant." +description: "Instructions on how to integrate Satel Integra binary sensors into Home Assistant." date: 2017-09-07 13:28 sidebar: true comments: false diff --git a/source/_components/binary_sensor.spc.markdown b/source/_components/binary_sensor.spc.markdown index 507f568dd9..624bebfff2 100644 --- a/source/_components/binary_sensor.spc.markdown +++ b/source/_components/binary_sensor.spc.markdown @@ -1,7 +1,7 @@ --- layout: page title: "SPC Binary Sensor" -description: "Instructions how to integrate Vanderbilt SPC binary sensors into Home Assistant." +description: "Instructions on how to integrate Vanderbilt SPC binary sensors into Home Assistant." date: 2017-05-18 22:05 sidebar: true comments: false diff --git a/source/_components/binary_sensor.tapsaff.markdown b/source/_components/binary_sensor.tapsaff.markdown index b8e8636af6..233596e6bd 100644 --- a/source/_components/binary_sensor.tapsaff.markdown +++ b/source/_components/binary_sensor.tapsaff.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Taps Aff" -description: "Instructions how to use the Taps Aff binary sensor in Home Assistant." +description: "Instructions on how to use the Taps Aff binary sensor in Home Assistant." date: 2017-05-28 18:00 sidebar: true comments: false diff --git a/source/_components/binary_sensor.tellduslive.markdown b/source/_components/binary_sensor.tellduslive.markdown index 2a73bea7f4..fc0b988bbf 100644 --- a/source/_components/binary_sensor.tellduslive.markdown +++ b/source/_components/binary_sensor.tellduslive.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Telldus Binary Sensor" -description: "Instructions how to integrate Telldus Live binary sensors into Home Assistant." +description: "Instructions on how to integrate Telldus Live binary sensors into Home Assistant." date: 2017-10-24 10:09 sidebar: true comments: false diff --git a/source/_components/binary_sensor.template.markdown b/source/_components/binary_sensor.template.markdown index 8a28a6fbff..7cc7af6285 100644 --- a/source/_components/binary_sensor.template.markdown +++ b/source/_components/binary_sensor.template.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Template Binary Sensor" -description: "Instructions how to integrate Template Binary Sensors into Home Assistant." +description: "Instructions on how to integrate Template Binary Sensors into Home Assistant." date: 2016-02-25 15:00 sidebar: true comments: false diff --git a/source/_components/binary_sensor.threshold.markdown b/source/_components/binary_sensor.threshold.markdown index aa12fad99f..21cc02b9fd 100644 --- a/source/_components/binary_sensor.threshold.markdown +++ b/source/_components/binary_sensor.threshold.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Threshold Binary Sensor" -description: "Instructions how to integrate threshold binary sensors into Home Assistant." +description: "Instructions on how to integrate threshold binary sensors into Home Assistant." date: 2016-11-26 12:10 sidebar: true comments: false diff --git a/source/_components/binary_sensor.trend.markdown b/source/_components/binary_sensor.trend.markdown index 5cad94a3b6..ae8e37c55a 100644 --- a/source/_components/binary_sensor.trend.markdown +++ b/source/_components/binary_sensor.trend.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Trend Binary Sensor" -description: "Instructions how to integrate Trend binary sensors into Home Assistant." +description: "Instructions on how to integrate Trend binary sensors into Home Assistant." date: 2016-09-05 10:00 sidebar: true comments: false diff --git a/source/_components/binary_sensor.vera.markdown b/source/_components/binary_sensor.vera.markdown index f28c1978fa..d5e5d9fb14 100644 --- a/source/_components/binary_sensor.vera.markdown +++ b/source/_components/binary_sensor.vera.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Vera Binary Sensor" -description: "Instructions how to integrate Vera binary sensors into Home Assistant." +description: "Instructions on how to integrate Vera binary sensors into Home Assistant." date: 2016-03-26 23:00 sidebar: true comments: false diff --git a/source/_components/binary_sensor.verisure.markdown b/source/_components/binary_sensor.verisure.markdown index 026ad16ab4..1f9b9f0f4e 100644 --- a/source/_components/binary_sensor.verisure.markdown +++ b/source/_components/binary_sensor.verisure.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Verisure Binary Sensor" -description: "Instructions how to integrate Verisure binary sensors into Home Assistant." +description: "Instructions on how to integrate Verisure binary sensors into Home Assistant." date: 2016-02-23 21:31 +0100 sidebar: true comments: false diff --git a/source/_components/binary_sensor.wink.markdown b/source/_components/binary_sensor.wink.markdown index 862a6b258e..1d23f5bf7c 100644 --- a/source/_components/binary_sensor.wink.markdown +++ b/source/_components/binary_sensor.wink.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Wink Binary Sensor" -description: "Instructions how to setup the Wink binary sensors within Home Assistant." +description: "Instructions on how to setup the Wink binary sensors within Home Assistant." date: 2015-01-20 22:36 sidebar: true comments: false diff --git a/source/_components/binary_sensor.workday.markdown b/source/_components/binary_sensor.workday.markdown index 0d4782bc12..1ba1f8bd8c 100644 --- a/source/_components/binary_sensor.workday.markdown +++ b/source/_components/binary_sensor.workday.markdown @@ -15,6 +15,10 @@ ha_release: 0.41 The `workday` binary sensor indicates, whether the current day is a workday or not. It allows specifying, which days of the week counts as workdays and also uses the python module [holidays](https://pypi.python.org/pypi/holidays) to incorporate information about region-specific public holidays. +## {% linkable_title Configuration %} + +Check the [country list](https://github.com/dr-prodigy/python-holidays#available-countries) for available province. + To enable the `workday` sensor in your installation, add the following to your `configuration.yaml` file: ```yaml @@ -22,14 +26,14 @@ To enable the `workday` sensor in your installation, add the following to your ` binary_sensor: - platform: workday country: DE - workdays: [ mon, wed, fri ] + workdays: [mon, wed, fri] ``` Configuration variables: - **name** (*Optional*): A name for this sensor. Defaults to *Workday Sensor* -- **country** (*Required*): Country code according to [holidays](https://pypi.python.org/pypi/holidays/0.9.3) notation. -- **province** (*Optional*): Province code according to [holidays](https://pypi.python.org/pypi/holidays/0.9.3) notation. Defaults to None. +- **country** (*Required*): Country code according to [holidays](https://pypi.python.org/pypi/holidays/0.9.4) notation. +- **province** (*Optional*): Province code according to [holidays](https://pypi.python.org/pypi/holidays/0.9.4) notation. Defaults to None. - **workdays** (*Optional*): List of workdays. Defaults to `mon`, `tue`, `wed`, `thu`, `fri`. - **excludes** (*Optional*): List of workday excludes. Defaults to `sat`, `sun`, `holiday`. - **days_offset** (*Optional*): Set days offset. Defaults to `0`. diff --git a/source/_components/binary_sensor.xiaomi_aqara.markdown b/source/_components/binary_sensor.xiaomi_aqara.markdown index a43874ff55..6f33659f78 100644 --- a/source/_components/binary_sensor.xiaomi_aqara.markdown +++ b/source/_components/binary_sensor.xiaomi_aqara.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Xiaomi Binary Sensor" -description: "Instructions how to setup the Xiaomi binary sensors within Home Assistant." +description: "Instructions on how to setup the Xiaomi binary sensors within Home Assistant." date: 2017-07-21 16:34 sidebar: true comments: false diff --git a/source/_components/binary_sensor.zha.markdown b/source/_components/binary_sensor.zha.markdown index 755e4396ed..df5853d670 100644 --- a/source/_components/binary_sensor.zha.markdown +++ b/source/_components/binary_sensor.zha.markdown @@ -1,7 +1,7 @@ --- layout: page title: "ZigBee Home Automation Binary Sensor" -description: "Instructions how to setup ZigBee Home Automation binary sensors within Home Assistant." +description: "Instructions on how to setup ZigBee Home Automation binary sensors within Home Assistant." date: 2017-02-22 00:00 sidebar: true comments: false diff --git a/source/_components/binary_sensor.zwave.markdown b/source/_components/binary_sensor.zwave.markdown index 233411d4f2..85c4cc30bb 100644 --- a/source/_components/binary_sensor.zwave.markdown +++ b/source/_components/binary_sensor.zwave.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Z-Wave Binary Sensor" -description: "Instructions how to setup the Z-Wave binary sensors within Home Assistant." +description: "Instructions on how to setup the Z-Wave binary sensors within Home Assistant." date: 2016-02-22 07:00 sidebar: true comments: false diff --git a/source/_components/bloomsky.markdown b/source/_components/bloomsky.markdown index 25ab683a22..90ebd17355 100644 --- a/source/_components/bloomsky.markdown +++ b/source/_components/bloomsky.markdown @@ -1,7 +1,7 @@ --- layout: page title: "BloomSky" -description: "Instructions how to integrate the BloomSky within Home Assistant." +description: "Instructions on how to integrate the BloomSky within Home Assistant." date: 2016-02-03 20:00 sidebar: true comments: false diff --git a/source/_components/bmw_connected_drive.markdown b/source/_components/bmw_connected_drive.markdown index 21e7e04ecf..94f493ff24 100644 --- a/source/_components/bmw_connected_drive.markdown +++ b/source/_components/bmw_connected_drive.markdown @@ -1,7 +1,7 @@ --- layout: page -title: "BMW connected drive" -description: "Instructions on how to setup your BMW connected drive account with Home Assistant." +title: "BMW Connected Drive" +description: "Instructions on how to setup your BMW Connected Drive account with Home Assistant." date: 2018-01-10 23:00 sidebar: true comments: false @@ -12,9 +12,9 @@ ha_category: Hub ha_release: 0.64 --- -This component lets you retrieve data on your BMW vehicle from the BMW Connected Drive portal. You need to have a working BMW Connected Drive account and a Connected Drive enabled vehicle for this to work. +This component lets you retrieve data on your BMW vehicle from the BMW Connected Drive portal. You need to have a working BMW Connected Drive account, and a Connected Drive enabled vehicle for this to work. -For compatibility with your BMW vehicle check the (bimmer_connected page)[https://github.com/ChristianKuehnel/bimmer_connected] on github. +For compatibility with your BMW vehicle check the [bimmer_connected page](https://github.com/m1n3rva/bimmer_connected) on github. To enable this component in your installation, add the following to your `configuration.yaml` file: @@ -25,7 +25,7 @@ bmw_connected_drive: name: username: USERNAME_BMW_CONNECTED_DRIVE password: PASSWORD_BMW_CONNECTED_DRIVE - country: COUNTRY_BMW_CONNECTED_DRIVE + region: one of "north_america", "china" , "rest_of_world" ``` {% configuration %} @@ -46,12 +46,44 @@ bmw_connected_drive: description: Your BMW Connected Drive password. required: true type: string - country: - description: "The country of your Connected Drive account. Please use the exact names for the country as listed on the [Connected Drive website](https://www.bmw-connecteddrive.com/)." + region: + description: "The region of your Connected Drive account. Please use of these values: `north_america`, `china`, `rest_of_world`" required: true type: string {% endconfiguration %} +## {% linkable_title Services %} + +The `bmw_connected_drive` component offers several services. In case you need to provide the vehicle identification number (VIN) as a parameter, you can see the VIN in the attributes of the device tracker for the vehicle. The VIN is a 17 digit alphanumeric string, e.g., `WBANXXXXXX1234567`. + +Using these services will impact the state of your vehicle. So use these services with care! + +### {% linkable_title Locking and unlocking %} + +The vehicle can be locked and unlocked via the lock component that is created automatically for each vehicle. Before invoking these services, make sure it's safe to lock/unlock the vehicle in the current situation. + +### {% linkable_title Air condition %} + +The air condition of the vehicle can be activated with the service `bmw_connected_drive.activate_air_conditioning`. + +What exactly is started here depends on the type of vehicle. It might range from just ventilation over auxiliary heating to real air conditioning. If your vehicle is equipped with auxiliary heating, only trigger this service if the vehicle is parked in a location where it is safe to use it (e.g., not in an underground parking or closed garage). + +The vehicle is identified via the parameter `vin`. + +### {% linkable_title Sound the horn %} + +The service `bmw_connected_drive.sound_horn` sounds the horn of the vehicle. Use this feature responsibly, as it might annoy your neighbors. The vehicle is identified via the parameter `vin`. + +### {% linkable_title Flash the lights %} + +The service `bmw_connected_drive.light_flash' flashes the lights of the vehicle. The vehicle is identified via the parameter `vin`. + +### {% linkable_title Update the state %} + +The service `bmw_connected_drive.update_state`fetches the last state of the vehicles of all your accounts from the BMW server. This does *not* trigger an update from the vehicle; it gets the data from the BMW servers. So this service does *not* interact with your vehicles. + +This service does not require any attributes. + ## {% linkable_title Disclaimer %} This software is not affiliated with or endorsed by BMW Group. diff --git a/source/_components/browser.markdown b/source/_components/browser.markdown index c5fa4b424e..6325fef367 100644 --- a/source/_components/browser.markdown +++ b/source/_components/browser.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Browser" -description: "Instructions how to setup the browser component with Home Assistant." +description: "Instructions on how to setup the browser component with Home Assistant." date: 2015-01-24 14:39 sidebar: true comments: false diff --git a/source/_components/calendar.google.markdown b/source/_components/calendar.google.markdown index acad749e7c..9825c5f9cc 100644 --- a/source/_components/calendar.google.markdown +++ b/source/_components/calendar.google.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Google Calendar Event" -description: "Instructions how to use Google Calendars in Home Assistant." +description: "Instructions on how to use Google Calendars in Home Assistant." date: 2015-05-08 17:15 sidebar: true comments: false @@ -14,9 +14,9 @@ ha_release: 0.33 --- -This platform allows you to connect to your [Google Calendars](https://calendar.google.com) and generate binary sensors. The sensors created can trigger based on any event on the calendar or only for matching events. When you first setup this component it will generate a new configuration file *google_calendars.yaml* that will contain information about all of the calendars you can see. +The `google` calendar platform allows you to connect to your [Google Calendars](https://calendar.google.com) and generate binary sensors. The sensors created can trigger based on any event on the calendar or only for matching events. When you first setup this component it will generate a new configuration file `google_calendars.yaml` that will contain information about all of the calendars you can see. -### {% linkable_title Prerequisites %} +## {% linkable_title Prerequisites %} Generate a Client ID and Client Secret on [Google Developers Console](https://console.developers.google.com/start/api?id=calendar). @@ -27,43 +27,53 @@ Generate a Client ID and Client Secret on [Google Developers Console](https://co 1. Save this page. You don't have to fill out anything else there. 1. Click 'Create credentials' -> OAuth client ID. 1. Set the Application type to 'Other' and give this credential set a name then click Create. -1. Save the client ID and secret as you will need to put these in your configuration.yaml file. +1. Save the client ID and secret as you will need to put these in your `configuration.yaml` file. 1. Click on "Library", search for "Google Calendar API" and enable it. -### {% linkable_title Basic Setup %} +## {% linkable_title Configuration %} To integrate Google Calendar in Home Assistant, add the following section to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry google: - client_id: *Value_created_from_steps_above* - client_secret: *Value_created_from_steps_above* + client_id: YOUR_CLIENT_ID + client_secret: YOUR_CLIENT_SECRET ``` -Configuration variables: - -- **client_id** (*Required*): Use the value you generated in the Prerequisites stage. -- **client_secret** (*Required*): Use the value you generated in the Prerequisites stage. -- **track_new_calendar** (*Optional*): Will automatically generate a binary sensor when a new calendar is detected. The system scans for new calendars on startup. By default this is set to `True`. +{% configuration %} +client_id: + description: Use the value you generated in the Prerequisites stage. + required: true + type: string +minimum: + description: Use the value you generated in the Prerequisites stage. + required: true + type: string +track_new_calendar: + description: Will automatically generate a binary sensor when a new calendar is detected. The system scans for new calendars only on startup. + required: false + type: boolean + default: true +{% endconfiguration %} The next steps will require you to have Home Assistant running. After you have it running complete the Google authentication that pops up. It will give you a URL and a code to enter. This will grant your Home Assistant service access to all the Google Calendars that the account you authenticate with can read. This is a Read-Only view of these calendars. +## {% linkable_title Calendar Configuration %} -### {% linkable_title Calendar Configuration %} -Editing `google_calendars.yaml` +Editing the `google_calendars.yaml` file. A basic entry for a single calendar looks like: ```yaml -- cal_id: "***************************@group.calendar.google.com" +- cal_id: "*****@group.calendar.google.com" entities: - device_id: test_everything name: Give me everything track: true -- cal_id: "***************************@group.calendar.google.com" +- cal_id: "*****@group.calendar.google.com" entities: - device_id: test_important name: Important Stuff @@ -79,38 +89,28 @@ A basic entry for a single calendar looks like: Variables: - **cal_id**: The Google generated unique id for this calendar. **DO NOT CHANGE** - - **entities**: Yes, you can have multiple sensors for a calendar! - - **device_id**: (*Required*): The name that all your automations/scripts will use to reference this device. - - **name**: (*Required*): What is the name of your sensor that you'll see in the frontend. - - **track**: (*Required*): Should we create a sensor `True` or ignore it `False`? - - **search**: (*Optional*): If set will only trigger for matched events. - - **offset**: (*Optional*): A set of characters that precede a number in the event title for designating a pre-trigger state change on the sensor. (Default: `!!`) - +  - **ignore_availablilty**: (*Optional*): Should we respect `free`/`busy` flags? (Defaults to `true`) +   From this we will end up with the binary sensors `calendar.test_unimportant` and `calendar.test_important` which will toggle themselves on/off based on events on the same calendar that match the search value set for each. You'll also have a sensor `calendar.test_everything` that will not filter events out and always show the next event available. But what if you only wanted it to toggle based on all events? Just leave out the *search* parameter. -**Note**: If you use a `#` sign for `search` then wrap the whole search term in quotes. Otherwise everything following the hash sign would be considered a YAML comment. - +

+If you use a `#` sign for `search` then wrap the whole search term in quotes. Otherwise everything following the hash sign would be considered a YAML comment. +

### {% linkable_title Sensor attributes %} - **offset_reached**: If set in the event title and parsed out will be `on`/`off` once the offset in the title in minutes is reached. So the title `Very important meeting #Important !!-10` would trigger this attribute to be `on` 10 minutes before the event starts. - - **all_day**: `True`/`False` if this is an all day event. Will be `False` if there is no event found. - - **message**: The event title with the `search` and `offset` values extracted. So in the above example for **offset_reached** the **message** would be set to `Very important meeting` - - **description**: The event description. - - **location**: The event Location. - - **start_time**: Start time of event. - - **end_time**: End time of event. diff --git a/source/_components/calendar.markdown b/source/_components/calendar.markdown index f18e94902c..4b69b5e6fe 100644 --- a/source/_components/calendar.markdown +++ b/source/_components/calendar.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Calendar" -description: "Instructions how to integrate calendars within Home Assistant." +description: "Instructions on how to integrate calendars within Home Assistant." date: 2016-11-19 08:36 sidebar: true comments: false diff --git a/source/_components/calendar.todoist.markdown b/source/_components/calendar.todoist.markdown index 00bdca07f7..c416ddb50d 100644 --- a/source/_components/calendar.todoist.markdown +++ b/source/_components/calendar.todoist.markdown @@ -63,7 +63,7 @@ calendar: - Calculus II ``` -(See [here](https://home-assistant.io/docs/configuration/secrets/) for more details about what that `!secret` does -- it's not exclusive to Todoist, and can help keep your API keys and passwords a little safer!) +(See [here](/docs/configuration/secrets/) for more details about what that `!secret` does -- it's not exclusive to Todoist, and can help keep your API keys and passwords a little safer!) As you can see, there are 4 custom projects here: @@ -111,7 +111,7 @@ Home Assistant does its best to determine what task in each project is "most" im Todoist also comes with access to a service, `calendar.todoist_new_task`. This service can be used to create a new Todoist task. You can specify labels and a project, or you can leave them blank, and the task will go to your "Inbox" project. -Here's an example JSON payload: +Here are two example JSON payloads resulting in the same task: ```json { @@ -123,6 +123,17 @@ Here's an example JSON payload: } ``` +```json +{ + "content": "Pick up the mail", + "project": "Errands", + "labels":"Homework,School", + "priority":3, + "due_date_string":"tomorrow at 14:00", + "due_date_lang":"en" +} +``` + - **content** (*Required*): The name of the task you want to create. - **project** (*Optional*): The project to put the task in. @@ -131,6 +142,11 @@ Here's an example JSON payload: - **priority** (*Optional*): The priority of the task, from 1-4. Again, 1 means least important, and 4 means most important. -- **due_date** (*Optional*): When the task should be due, in either YYYY-MM-DD format or YYYY-MM-DD HH:MM format. +- **due_date_string** (*Optional*): When the task should be due, in [natural language](https://support.todoist.com/hc/en-us/articles/205325931-Dates-and-Times). Mutually exclusive with `due_date` + +- **due_date_lang** (*Optional*): When `due_date_string` is set, it is posisble to set the language. + Valid languages are: `en`, `da`, `pl`, `zh`, `ko`, `de`, `pt`, `ja`, `it`, `fr`, `sv`, `ru`, `es`, `nl` + +- **due_date** (*Optional*): When the task should be due, in either YYYY-MM-DD format or YYYY-MM-DD HH:MM format. Mutually exclusive with `due_date_string`. Note that there's (currently) no way to mark tasks as done through Home Assistant; task names do not necessarily have to be unique, so you could find yourself in a situation where you close the wrong task. diff --git a/source/_components/camera.abode.markdown b/source/_components/camera.abode.markdown index a95b6d2fcf..2aa3da2313 100644 --- a/source/_components/camera.abode.markdown +++ b/source/_components/camera.abode.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Abode Camera" -description: "Instructions how to integrate Abode cameras into Home Assistant." +description: "Instructions on how to integrate Abode cameras into Home Assistant." date: 2017-08-26 13:28 sidebar: true comments: false diff --git a/source/_components/camera.amcrest.markdown b/source/_components/camera.amcrest.markdown index 2c1a042c87..73a6ca444f 100644 --- a/source/_components/camera.amcrest.markdown +++ b/source/_components/camera.amcrest.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Amcrest IP Camera" -description: "Instructions how to integrate Amcrest IP cameras within Home Assistant." +description: "Instructions on how to integrate Amcrest IP cameras within Home Assistant." date: 2016-11-24 10:00 sidebar: true comments: false diff --git a/source/_components/camera.android_ip_webcam.markdown b/source/_components/camera.android_ip_webcam.markdown index 04c6e41d8e..8aa3455faa 100644 --- a/source/_components/camera.android_ip_webcam.markdown +++ b/source/_components/camera.android_ip_webcam.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Android IP Webcam Camera" -description: "Instructions how to integrate Android IP Webcam cameras within Home Assistant." +description: "Instructions on how to integrate Android IP Webcam cameras within Home Assistant." date: 2015-07-11 0:36 sidebar: true comments: false diff --git a/source/_components/camera.arlo.markdown b/source/_components/camera.arlo.markdown index 1d66a90bbf..a634e8d8d9 100644 --- a/source/_components/camera.arlo.markdown +++ b/source/_components/camera.arlo.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Arlo Camera" -description: "Instructions how to integrate your Netgear Arlo cameras within Home Assistant." +description: "Instructions on how to integrate your Netgear Arlo cameras within Home Assistant." date: 2016-05-30 10:00 sidebar: true comments: false @@ -30,4 +30,4 @@ Configuration variables: - **ffmpeg_arguments**: (*Optional*): Extra options to pass to ffmpeg, e.g., image quality or video filter options. -**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](https://home-assistant.io/components/ffmpeg/) documentation. +**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. diff --git a/source/_components/camera.axis.markdown b/source/_components/camera.axis.markdown index 23695c7905..ec725b06ec 100644 --- a/source/_components/camera.axis.markdown +++ b/source/_components/camera.axis.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Axis Camera" -description: "Instructions how to setup Axis cameras within Home Assistant." +description: "Instructions on how to setup Axis cameras within Home Assistant." date: 2017-05-01 19:09 sidebar: true comments: false diff --git a/source/_components/camera.bloomsky.markdown b/source/_components/camera.bloomsky.markdown index 8661690eb6..bd6f8a58b9 100644 --- a/source/_components/camera.bloomsky.markdown +++ b/source/_components/camera.bloomsky.markdown @@ -1,7 +1,7 @@ --- layout: page title: "BloomSky Camera" -description: "Instructions how to integrate the BloomSky camera within Home Assistant." +description: "Instructions on how to integrate the BloomSky camera within Home Assistant." date: 2016-02-03 20:00 sidebar: true comments: false diff --git a/source/_components/camera.canary.markdown b/source/_components/camera.canary.markdown index 3e7eac2e79..8e5f07f461 100644 --- a/source/_components/camera.canary.markdown +++ b/source/_components/camera.canary.markdown @@ -26,7 +26,7 @@ camera: {% configuration %} ffmpeg_arguments: - description: Extra options to pass to `ffmpeg`, e.g. image quality or video filter options. More details in [FFmpeg component](/components/ffmpeg). + description: Extra options to pass to `ffmpeg`, e.g., image quality or video filter options. More details in [FFmpeg component](/components/ffmpeg). required: false type: string {% endconfiguration %} diff --git a/source/_components/camera.dispatcher.markdown b/source/_components/camera.dispatcher.markdown index 2672c6c48e..26eb74febc 100644 --- a/source/_components/camera.dispatcher.markdown +++ b/source/_components/camera.dispatcher.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Dispatcher IP Camera" -description: "Instructions how to integrate internal dispatcher cameras within Home Assistant." +description: "Instructions on how to integrate internal dispatcher cameras within Home Assistant." date: 2017-03-08 00:00 sidebar: true comments: false diff --git a/source/_components/camera.doorbird.markdown b/source/_components/camera.doorbird.markdown index d96a1ebe9b..ce23d94672 100644 --- a/source/_components/camera.doorbird.markdown +++ b/source/_components/camera.doorbird.markdown @@ -1,7 +1,7 @@ --- layout: page title: "DoorBird Camera" -description: "Instructions how to integrate DoorBird video doorbell images into Home Assistant." +description: "Instructions on how to integrate DoorBird video doorbell images into Home Assistant." date: 2017-08-06 11:30 sidebar: true comments: false diff --git a/source/_components/camera.ffmpeg.markdown b/source/_components/camera.ffmpeg.markdown index 86e6355c8d..481c835a15 100644 --- a/source/_components/camera.ffmpeg.markdown +++ b/source/_components/camera.ffmpeg.markdown @@ -29,7 +29,7 @@ Configuration variables: - **input** (*Required*): An FFmpeg-compatible input file, stream, or feed. - **name** (*Optional*): Override the name of your camera. -- **extra_arguments** (*Optional*): Extra options to pass to `ffmpeg`, e.g. image quality or video filter options. +- **extra_arguments** (*Optional*): Extra options to pass to `ffmpeg`, e.g., image quality or video filter options. ### {% linkable_title Image quality %} diff --git a/source/_components/camera.foscam.markdown b/source/_components/camera.foscam.markdown index ea90a82984..c9d1aabd50 100644 --- a/source/_components/camera.foscam.markdown +++ b/source/_components/camera.foscam.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Foscam IP Camera" -description: "Instructions how to integrate Foscam IP cameras within Home Assistant." +description: "Instructions on how to integrate Foscam IP cameras within Home Assistant." date: 2015-09-17 08:01 sidebar: true comments: false @@ -15,6 +15,8 @@ ha_iot_class: "Local Polling" The `foscam` platform allows you to watch the live stream of your [Foscam](http://www.foscam.com/) IP camera in Home Assistant. +## {% linkable_title Configuration %} + To enable your Foscam IP camera in your installation, add the following to your `configuration.yaml` file: ```yaml @@ -22,8 +24,8 @@ To enable your Foscam IP camera in your installation, add the following to your camera: - platform: foscam ip: IP_ADDRESS - username: USERNAME - password: PASSWORD + username: YOUR_USERNAME + password: YOUR_PASSWORD ``` Configuration variables: @@ -39,4 +41,5 @@ There seems to be some issues within Foscam with lengthy passwords and passwords

### {% linkable_title Control Foscam PTZ (Pan/Tilt/Zoom) - Home/Away %} + Foscam Webcams which support CGI Commands can be controlled by Home Assistant ([Source](http://www.ipcamcontrol.net/files/Foscam%20IPCamera%20CGI%20User%20Guide-V1.0.4.pdf)). For an example of how this can be done, see the [Foscam IP Camera Pan, Tilt, Zoom Control](/cookbook/foscam_away_mode_PTZ/) Cookbook entry. diff --git a/source/_components/camera.generic.markdown b/source/_components/camera.generic.markdown index 71a16ba40e..bec1ec5ffe 100644 --- a/source/_components/camera.generic.markdown +++ b/source/_components/camera.generic.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Generic IP Camera" -description: "Instructions how to integrate IP cameras within Home Assistant." +description: "Instructions on how to integrate IP cameras within Home Assistant." date: 2015-07-11 0:36 sidebar: true comments: false diff --git a/source/_components/camera.local_file.markdown b/source/_components/camera.local_file.markdown index 6dade4b4c5..b2b953041d 100644 --- a/source/_components/camera.local_file.markdown +++ b/source/_components/camera.local_file.markdown @@ -13,9 +13,9 @@ ha_iot_class: "Local Polling" ha_release: 0.22 --- -The `local_file` camera platform allows you to integrate any readable image file from disk into Home Assistant as a camera. If the image is updated on the file system the image displayed in Home Assistant will also be updated. +The `local_file` camera platform allows you to integrate an image file from disk into Home Assistant as a camera. If the image is updated on the file system the image displayed in Home Assistant will also be updated. The service `local_file_update_file_path` can be used to update the image using an automation. -This can for example be used with various camera platforms that save a temporary images locally. It can also be used to display a graph that you render periodically and will then be displayed in Home Assistant. +The `local_file` camera can for example be used with various camera platforms that save a temporary images locally. It can also be used to display a graph that you render periodically and will then be displayed in Home Assistant. To enable this camera in your installation, add the following to your `configuration.yaml` file: @@ -31,7 +31,11 @@ Configuration variables: - **file_path** (*Required*): File to serve as the camera. - **name** (*Optional*): Name of the camera -

-The given `file_path` must be an existing file because the camera platform setup make a readable check on it. -

+### {% linkable_title Service `camera.local_file_update_file_path` %} +Use this service to change the file displayed by the camera. + +| Service data attribute | Description | +| -----------------------| ----------- | +| `entity_id` | String of the `entity_id` of the camera to update. | +| `file_path` | The full path to the new image file to be displayed. | diff --git a/source/_components/camera.markdown b/source/_components/camera.markdown index 2d92253993..8d3c12c7e6 100644 --- a/source/_components/camera.markdown +++ b/source/_components/camera.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Camera" -description: "Instructions how to integrate cameras within Home Assistant." +description: "Instructions on how to integrate cameras within Home Assistant." date: 2015-11-09 08:36 sidebar: true comments: false diff --git a/source/_components/camera.mjpeg.markdown b/source/_components/camera.mjpeg.markdown index 6a01c70872..de03528200 100644 --- a/source/_components/camera.mjpeg.markdown +++ b/source/_components/camera.mjpeg.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Generic MJPEG IP Camera" -description: "Instructions how to integrate IP cameras within Home Assistant." +description: "Instructions on how to integrate IP cameras within Home Assistant." date: 2015-11-09 08:36 sidebar: true comments: false diff --git a/source/_components/camera.mqtt.markdown b/source/_components/camera.mqtt.markdown index 852140ddf9..f0e903a37a 100644 --- a/source/_components/camera.mqtt.markdown +++ b/source/_components/camera.mqtt.markdown @@ -1,7 +1,7 @@ --- layout: page title: "MQTT Camera" -description: "Instructions how to use an MQTT image message as a Camera within Home Assistant." +description: "Instructions on how to use an MQTT image message as a Camera within Home Assistant." date: 2017-04-14 00:45 sidebar: true comments: false diff --git a/source/_components/camera.neato.markdown b/source/_components/camera.neato.markdown index 4fccb0b413..3b959c0bc3 100644 --- a/source/_components/camera.neato.markdown +++ b/source/_components/camera.neato.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Neato Camera" -description: "Instructions how to setup the Neato cleaning maps within Home Assistant." +description: "Instructions on how to setup the Neato cleaning maps within Home Assistant." date: 2017-04-05 13:10 sidebar: true comments: false diff --git a/source/_components/camera.nest.markdown b/source/_components/camera.nest.markdown index e597fcb19d..607a88c516 100644 --- a/source/_components/camera.nest.markdown +++ b/source/_components/camera.nest.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Nest Camera" -description: "Instructions how to integrate Nest cameras into Home Assistant." +description: "Instructions on how to integrate Nest cameras into Home Assistant." date: 2016-12-03 08:10 sidebar: true comments: false diff --git a/source/_components/camera.netatmo.markdown b/source/_components/camera.netatmo.markdown index 5ad8ebe38e..e452d26b41 100644 --- a/source/_components/camera.netatmo.markdown +++ b/source/_components/camera.netatmo.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Netatmo Camera" -description: "Instructions how to integrate Netatmo cameras into Home Assistant." +description: "Instructions on how to integrate Netatmo cameras into Home Assistant." date: 2016-06-02 08:10 sidebar: true comments: false diff --git a/source/_components/camera.onvif.markdown b/source/_components/camera.onvif.markdown index 6b772dfda6..ed01e31d37 100644 --- a/source/_components/camera.onvif.markdown +++ b/source/_components/camera.onvif.markdown @@ -32,7 +32,7 @@ Configuration variables: - **password** (*Optional*): The password for the camera. - **port** (*Optional*): The port for the camera. This defaults to 5000. - **profile** (*Optional*): Video profile that will be used to obtain the stream. This defaults to 0. More details below. -- **extra_arguments** (*Optional*): Extra options to pass to `ffmpeg`, e.g. image quality or video filter options. More details in [FFmpeg component](/components/ffmpeg). +- **extra_arguments** (*Optional*): Extra options to pass to `ffmpeg`, e.g., image quality or video filter options. More details in [FFmpeg component](/components/ffmpeg). Most of the Onvif cameras support more than one audio/video Profile. Each profile provides different image quality. Usually, the first profile has the highest quality, and it is the profile used by default. However, you may want to use a lower quality image. One of the reasons may be that your hardware isn't able to render the highest quality image in real-time - especially when running on Raspberry Pi. Therefore you can choose which profile do you want to use by setting in config `profile` variable. diff --git a/source/_components/camera.proxy.markdown b/source/_components/camera.proxy.markdown index 41719935d3..e8a38d4b23 100644 --- a/source/_components/camera.proxy.markdown +++ b/source/_components/camera.proxy.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Camera Proxy" -description: "Instructions how to integrate a camera proxy within Home Assistant." +description: "Instructions on how to integrate a camera proxy within Home Assistant." date: 2018-03-08 19:00 sidebar: true comments: false @@ -29,17 +29,46 @@ camera: max_image_width: 720 ``` -Configuration variables: - -- **entity_id** (*Required*): The ID of another Home Assistant camera to post-process. -- **name** (*Optional*): This parameter allows you to override the name of your camera. -- **max_image_width** (*Optional*): The maximum width of single images taken from the camera (aspect ratio will be maintained). -- **max_stream_width** (*Optional*): The maximum width of the MJPEG stream from the camera (aspect ratio will be maintained). -- **image_quality** (*Optional*): The quality level used for resulting JPEG for snapshots (default: 75). -- **stream_quality** (*Optional*): The quality level used for resulting MJPEG streams (default: 75). -- **image_refresh_rate** (*Optional*): The minimum time in seconds between generating successive image snapshots. -- **force_resize** (*Optional*): Resize the image even if the resulting image would take up more bandwidth than the original. -- **cache_images** (*Optional*): Preserve the last image and re-send in the case the camera is not responding. +{% configuration %} + entity_id: + description: The ID of another Home Assistant camera to post-process. + required: true + type: string + name: + description: This parameter allows you to override the name of your camera. + required: false + type: string + max_image_width: + description: The maximum width of single images taken from the camera (aspect ratio will be maintained). + required: false + type: integer + max_stream_width: + description: The maximum width of the MJPEG stream from the camera (aspect ratio will be maintained). + required: false + type: integer + image_quality: + description: The quality level used for resulting JPEG for snapshots. + required: false + type: integer + default: 75 + stream_quality: + description: The quality level used for resulting MJPEG streams. + required: false + type: integer + default: 75 + image_refresh_rate: + description: The minimum time in seconds between generating successive image snapshots. + required: false + type: float + force_resize: + description: Resize the image even if the resulting image would take up more bandwidth than the original. + required: false + type: boolean + cache_images: + description: Preserve the last image and re-send in the case the camera is not responding. + required: false + type: boolean +{% endconfiguration %} ## {% linkable_title Examples %} diff --git a/source/_components/camera.ring.markdown b/source/_components/camera.ring.markdown index eb7fc03162..cd4844ae4b 100644 --- a/source/_components/camera.ring.markdown +++ b/source/_components/camera.ring.markdown @@ -13,7 +13,7 @@ ha_release: 0.57 ha_iot_class: "Cloud Polling" --- -To get your [Ring.com](https://ring.com/) cameras working within Home Assistant, please follow the instructions for the general [Ring component](/components/ring). Please note that downloading and playing Ring video will require a Ring Protect plan. +To get your [Ring.com](https://ring.com/) cameras working within Home Assistant, please follow the instructions for the general [Ring component](/components/ring). Please note that downloading and playing Ring video will require a Ring Protect plan. Once you have enabled the [Ring component](/components/ring), add the following to your `configuration.yaml` file: @@ -28,7 +28,7 @@ Configuration variables: - **ffmpeg_arguments**: (*Optional*): Extra options to pass to ffmpeg, e.g., image quality or video filter options. - **scan_interval**: (*Optional*): How frequently to query for new video. Defaults to 90 seconds. -**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](https://home-assistant.io/components/ffmpeg/) documentation. +**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. Currently it supports doorbell and stickup cameras. diff --git a/source/_components/camera.rpi_camera.markdown b/source/_components/camera.rpi_camera.markdown index 7dd981077f..2033dc5d28 100644 --- a/source/_components/camera.rpi_camera.markdown +++ b/source/_components/camera.rpi_camera.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Raspberry Pi Camera" -description: "Instructions how to integrate Raspberry Pi within Home Assistant." +description: "Instructions on how to integrate Raspberry Pi within Home Assistant." date: 2016-04-08 10:00 sidebar: true comments: false diff --git a/source/_components/camera.synology.markdown b/source/_components/camera.synology.markdown index 258bc1e832..93a2e78ff3 100644 --- a/source/_components/camera.synology.markdown +++ b/source/_components/camera.synology.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Synology Camera" -description: "Instructions how to integrate Synology Surveillance Station cameras within Home Assistant." +description: "Instructions on how to integrate Synology Surveillance Station cameras within Home Assistant." date: 2016-10-13 08:01 sidebar: true comments: false @@ -14,7 +14,7 @@ ha_iot_class: "Local Polling" --- 　 -The `synology` platform allows you to watch the live streams of your [Synology](https://www.synology.com/) Surveillance Station based IP cameras in Home Assistant. +The `synology` camera platform allows you to watch the live streams of your [Synology](https://www.synology.com/) Surveillance Station based IP cameras in Home Assistant. To enable your Surveillance Station cameras in your installation, add the following to your `configuration.yaml` file: @@ -22,9 +22,9 @@ To enable your Surveillance Station cameras in your installation, add the follow # Minimum configuration.yaml entry camera: - platform: synology - url: SYNOLOGY_URL - username: USERNAME - password: PASSWORD + url: IP_ADDRESS_OF_SYNOLOGY_NAS + username: YOUR_USERNAME + password: YOUR_PASSWORD ``` Configuration variables: @@ -43,8 +43,8 @@ A full sample configuration for the `synology` platform is shown below: camera: - platform: synology url: https://192.168.1.120:5001 - username: USERNAME - password: PASSWORD + username: YOUR_USERNAME + password: YOUR_PASSWORD timeout: 15 verify_ssl: False ``` diff --git a/source/_components/camera.uvc.markdown b/source/_components/camera.uvc.markdown index 367f4472ca..02743bda45 100644 --- a/source/_components/camera.uvc.markdown +++ b/source/_components/camera.uvc.markdown @@ -1,7 +1,7 @@ --- layout: page title: "UniFi Video Camera" -description: "Instructions how to integrate UVC cameras within Home Assistant." +description: "Instructions on how to integrate UVC cameras within Home Assistant." date: 2016-02-07 10:00 sidebar: true comments: false diff --git a/source/_components/camera.verisure.markdown b/source/_components/camera.verisure.markdown index e96a8725f7..35b4c25e4e 100644 --- a/source/_components/camera.verisure.markdown +++ b/source/_components/camera.verisure.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Verisure Camera" -description: "Instructions how to setup the Verisure cameras within Home Assistant." +description: "Instructions on how to setup the Verisure cameras within Home Assistant." date: 2016-10-22 09:00 sidebar: true comments: false diff --git a/source/_components/camera.yi.markdown b/source/_components/camera.yi.markdown index 052e3b26d6..cb8975a86c 100644 --- a/source/_components/camera.yi.markdown +++ b/source/_components/camera.yi.markdown @@ -34,6 +34,10 @@ Once installed, please ensure that you have enabled FTP and Telnet on your devic Currently, version 0.1.4-beta2 of the custom firmware is the highest supported. Firmwares higher than this version use [Pure-FTPd](https://www.pureftpd.org/project/pure-ftpd), which has a bug that prevents FFmpeg from correctly rendering video files.

+

+Hassbian users: don't forget to install ffmpeg support on your platform, otherwise, you'll not see video. +

+

Some alternative Yi firmwares enable an experimental RTSP server, which will allow you to connect to your camera via other Home Assistant camera platforms. However, this RTSP server disables the ability to use the supremely-useful Yi Home app. In order to maintain both Home Assistant compatibility _and_ the native app, this platform retrieves videos via FTP.

@@ -68,7 +72,7 @@ Configuration variables: - **password** (*Required*): The password to the FTP server on the camera (from above). - **path** (*Optional*): The path to the raw MP4 files. Defaults to `/tmp/sd/record`. - **username** (*Optional*): The user that can access the FTP server. Defaults to `root`. -- **ffmpeg_arguments** (*Optional*): Extra options to pass to `ffmpeg` (e.g. image quality or video filter options). +- **ffmpeg_arguments** (*Optional*): Extra options to pass to `ffmpeg` (e.g., image quality or video filter options). ## {% linkable_title Image quality %} diff --git a/source/_components/canary.markdown b/source/_components/canary.markdown index 425055f48a..186d704e17 100644 --- a/source/_components/canary.markdown +++ b/source/_components/canary.markdown @@ -15,6 +15,8 @@ ha_iot_class: "Cloud Polling" The `canary` component allows you to integrate your [Canary](https://canary.is) devices in Home Assistant. +## {% linkable_title Configuration %} + You will need your Canary login information (username, usually your email address, and password) to use this module. To set it up, add the following to your `configuration.yaml` file: @@ -22,8 +24,8 @@ To set it up, add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry canary: - username: you@example.com - password: secret + username: YOUR_USERNAME + password: YOUR_PASSWORD ``` {% configuration %} @@ -42,8 +44,6 @@ canary: default: 10 {% endconfiguration %} - - Once loaded, your front end will have the following components: * A camera image triggered by motion for each camera. diff --git a/source/_components/climate.ecobee.markdown b/source/_components/climate.ecobee.markdown index e8711168e7..b92b001f37 100644 --- a/source/_components/climate.ecobee.markdown +++ b/source/_components/climate.ecobee.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Ecobee Thermostat" -description: "Instructions how to setup the Ecobee thermostats within Home Assistant." +description: "Instructions on how to setup the Ecobee thermostats within Home Assistant." date: 2016-08-26 18:00 sidebar: true comments: false diff --git a/source/_components/climate.econet.markdown b/source/_components/climate.econet.markdown index 3feb4aa643..704c6ebf0e 100644 --- a/source/_components/climate.econet.markdown +++ b/source/_components/climate.econet.markdown @@ -1,7 +1,7 @@ --- layout: page title: "EcoNet water heater" -description: "Instructions how to integrate Rheem EcoNet water heaters into Home Assistant." +description: "Instructions on how to integrate Rheem EcoNet water heaters into Home Assistant." date: 2017-12-28 14:51 sidebar: true comments: false diff --git a/source/_components/climate.eq3btsmart.markdown b/source/_components/climate.eq3btsmart.markdown index 5cfa52ae40..ce833566ff 100644 --- a/source/_components/climate.eq3btsmart.markdown +++ b/source/_components/climate.eq3btsmart.markdown @@ -1,7 +1,7 @@ --- layout: page title: "EQ3 Bluetooth Smart Thermostats" -description: "Instructions how to integrate EQ3 Bluetooth Smart Thermostats into Home Assistant." +description: "Instructions on how to integrate EQ3 Bluetooth Smart Thermostats into Home Assistant." date: 2016-04-18 22:00 sidebar: true comments: false diff --git a/source/_components/climate.flexit.markdown b/source/_components/climate.flexit.markdown index 078b840985..0281b50756 100644 --- a/source/_components/climate.flexit.markdown +++ b/source/_components/climate.flexit.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Flexit A/C controller" -description: "Instructions how to integrate Flexit A/C unit into Home Assistant." +description: "Instructions on how to integrate Flexit A/C unit into Home Assistant." date: 2017-06-02 16:30 +0200 sidebar: true comments: false diff --git a/source/_components/climate.fritzbox.markdown b/source/_components/climate.fritzbox.markdown new file mode 100644 index 0000000000..65975ca77c --- /dev/null +++ b/source/_components/climate.fritzbox.markdown @@ -0,0 +1,28 @@ +--- +layout: page +title: "Fritzbox Thermostat" +description: "Instructions on how to integrate the AVM Fritzbox thermostat." +date: 2017-11-12 17:10 +sidebar: true +comments: false +sharing: true +footer: true +logo: avm.png +ha_category: Climate +ha_release: 0.68 +ha_iot_class: "Local Polling" +--- + +

+To get AVM fritzbox thermostat follow the instructions for the general [Fritzbox](/components/fritzbox/). +

+ +### {% linkable_title Attributes %} + +The are several attributes that can be useful for automations and templates. + +| Attribute | Description | +| --------- | ----------- | +| `device_locked` | The state of the key lock at the device. +| `locked` | The state of the lock for configuring the device via the app or the Fritzbox web interface. +| `low_battery` | The low battery state indication. diff --git a/source/_components/climate.heatmiser.markdown b/source/_components/climate.heatmiser.markdown index b772e9923b..b1478034e9 100644 --- a/source/_components/climate.heatmiser.markdown +++ b/source/_components/climate.heatmiser.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Heatmiser Thermostat" -description: "Instructions how to integrate Heatmiser thermostats within Home Assistant." +description: "Instructions on how to integrate Heatmiser thermostats within Home Assistant." date: 2015-12-11 12:35 sidebar: true comments: false diff --git a/source/_components/climate.hive.markdown b/source/_components/climate.hive.markdown index dd3fd41ca5..12f4688553 100644 --- a/source/_components/climate.hive.markdown +++ b/source/_components/climate.hive.markdown @@ -14,13 +14,15 @@ ha_iot_class: "Cloud Polling" --- -The 'hive' climate component integrates your Hive thermostat and hot water into Home Assistant, enabling control of setting the **mode** and setting the **target temperature**. +The `hive` climate platform integrates your Hive thermostat and hot water into Home Assistant, enabling control of setting the **mode** and setting the **target temperature**. + A short boost for Hive Heating or Hive Hot water can be set by using the **Aux Heat** function, this will turn on the boost feature for Hive Heating or Hive Hot water for 30 minutes at 0.5 degrees higher than the current temperature. -The Hive climate component supports the following Hive products: -- **Hive Active Heating** -- **Hive Multizone** -- **Hot water control** +The platform supports the following Hive products: + +- Hive Active Heating +- Hive Multizone +- Hot water control

diff --git a/source/_components/climate.homematic.markdown b/source/_components/climate.homematic.markdown index ac5458d592..86e38fdb49 100644 --- a/source/_components/climate.homematic.markdown +++ b/source/_components/climate.homematic.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Homematic Thermostats" -description: "Instructions how to integrate Homematic thermostats within Home Assistant." +description: "Instructions on how to integrate Homematic thermostats within Home Assistant." date: 2016-06-28 08:30 sidebar: true comments: false diff --git a/source/_components/climate.honeywell.markdown b/source/_components/climate.honeywell.markdown index 8104a6a77f..855d009cda 100644 --- a/source/_components/climate.honeywell.markdown +++ b/source/_components/climate.honeywell.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Honeywell Thermostat" -description: "Instructions how to integrate Honeywell thermostats within Home Assistant." +description: "Instructions on how to integrate Honeywell thermostats within Home Assistant." date: 2016-02-07 22:01 sidebar: true comments: false diff --git a/source/_components/climate.markdown b/source/_components/climate.markdown index 53cfc08013..fd41b437cd 100644 --- a/source/_components/climate.markdown +++ b/source/_components/climate.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Climate" -description: "Instructions how to setup climate control devices within Home Assistant." +description: "Instructions on how to setup climate control devices within Home Assistant." date: 2016-08-26 19:00 sidebar: true comments: false diff --git a/source/_components/climate.modbus.markdown b/source/_components/climate.modbus.markdown new file mode 100644 index 0000000000..eeb376ef8e --- /dev/null +++ b/source/_components/climate.modbus.markdown @@ -0,0 +1,71 @@ +--- +layout: page +title: "Modbus" +description: "Instructions how to integrate a Modbus thermostat within Home Assistant." +date: 2018-01-29 9:35 +sidebar: true +comments: false +sharing: true +footer: true +logo: modbus.png +ha_category: Thermostat +ha_release: 0.68 +ha_iot_class: "Local Polling" +--- + + +The `modbus` thermostat allows you to use a sensor value (current temperature) and target value (target temperature) from [Modbus](http://www.modbus.org/) registers. + +## {% linkable_title Configuration %} + +To use your Modbus thermostat in your installation, add the following to your `configuration.yaml` file: + +```yaml +# Example configuration.yaml entry +climate: + - platform: modbus + name: Watlow F4T + slave: 1 + target_temp_register: 2782 + current_temp_register: 27586 +``` + +{% configuration %} +name: + description: Name of the device + required: true + type: string +slave: + description: The number of the slave (Optional for tcp and upd Modbus, use 1). + required: true + type: int +target_temp_register: + description: Register number for target temperature (Setpoint). + required: true + type: int +current_temp_register: + description: Register number for current temperature (Process value). + required: true + type: int +data_type: + description: Response representation (int, uint, float, custom). If float selected, value will converted to IEEE 754 floating point format. + required: false + type: string + default: float +count: + description: Number of registers to read. + required: false + type: int +precision: + description: Number of valid decimals. + required: false + type: int + default: 0 +{% endconfiguration %} + + +### {% linkable_title Services %} + +| Service | Description | +| ------- | ----------- | +| set_temperature | Set Temperature. Requires `value` to be passed in, which is the desired target temperature. `value` should be in the same type as `data_type` | diff --git a/source/_components/climate.mqtt.markdown b/source/_components/climate.mqtt.markdown index 504610dea4..958974869a 100644 --- a/source/_components/climate.mqtt.markdown +++ b/source/_components/climate.mqtt.markdown @@ -1,7 +1,7 @@ --- layout: page title: "MQTT HVAC" -description: "Instructions how to integrate MQTT HVAC into Home Assistant." +description: "Instructions on how to integrate MQTT HVAC into Home Assistant." date: 2017-07-31 19:59 sidebar: true comments: false @@ -178,11 +178,11 @@ aux_state_template: #### {% linkable_title Optimistic mode %} -If a property works in *optimistic mode* (when the corresponding state topic is not set), home assistant will assume that any state changes published to the command topics did work and change the internal state of the entity immediately after publishing to the command topic. If it does not work in optimistic mode, the internal state of the entity is only updated when the requested update is confirmed by the device through the state topic. +If a property works in *optimistic mode* (when the corresponding state topic is not set), Home Assistant will assume that any state changes published to the command topics did work and change the internal state of the entity immediately after publishing to the command topic. If it does not work in optimistic mode, the internal state of the entity is only updated when the requested update is confirmed by the device through the state topic. #### {% linkable_title Using Templates %} -For all `*_state_topic`s, a template can be specified that will be used to render the incoming payloads on these topics. Also, a default template that applies to all state topis can be specified as `value_template`. This can be useful if you received payloads are e.g. in JSON format. Since in JSON, a quoted string (e.g. `"foo"`) is just a string, this can also be used for unquoting. +For all `*_state_topic`s, a template can be specified that will be used to render the incoming payloads on these topics. Also, a default template that applies to all state topis can be specified as `value_template`. This can be useful if you received payloads are e.g., in JSON format. Since in JSON, a quoted string (e.g., `"foo"`) is just a string, this can also be used for unquoting. Say you receive the operation mode `"auto"` via your `mode_state_topic`, but the mode is actually called just `auto`, here's what you could do: diff --git a/source/_components/climate.mysensors.markdown b/source/_components/climate.mysensors.markdown index a61fae33f9..6f5379449b 100644 --- a/source/_components/climate.mysensors.markdown +++ b/source/_components/climate.mysensors.markdown @@ -1,7 +1,7 @@ --- layout: page title: "MySensors HVAC" -description: "Instructions how to integrate MySensors climate into Home Assistant." +description: "Instructions on how to integrate MySensors climate into Home Assistant." date: 2016-10-01 15:00 +0200 sidebar: true comments: false diff --git a/source/_components/climate.nest.markdown b/source/_components/climate.nest.markdown index be9adf6d41..4d99423734 100644 --- a/source/_components/climate.nest.markdown +++ b/source/_components/climate.nest.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Nest Thermostat" -description: "Instructions how to integrate Nest thermostats within Home Assistant." +description: "Instructions on how to integrate Nest thermostats within Home Assistant." date: 2015-03-23 19:59 sidebar: true comments: false diff --git a/source/_components/climate.netatmo.markdown b/source/_components/climate.netatmo.markdown index 72c4f0de00..a90a1f4353 100644 --- a/source/_components/climate.netatmo.markdown +++ b/source/_components/climate.netatmo.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Netatmo Thermostat" -description: "Instructions how to integrate Netatmo thermostat into Home Assistant." +description: "Instructions on how to integrate Netatmo thermostat into Home Assistant." date: 2016-10-11 08:10 sidebar: true comments: false diff --git a/source/_components/climate.nuheat.markdown b/source/_components/climate.nuheat.markdown index 51ffd6fee4..46a8e84c5a 100644 --- a/source/_components/climate.nuheat.markdown +++ b/source/_components/climate.nuheat.markdown @@ -1,7 +1,7 @@ --- layout: page title: "NuHeat Thermostat" -description: "Instructions how to integrate your NuHeat Signature thermostats within Home Assistant." +description: "Instructions on how to integrate your NuHeat Signature thermostats within Home Assistant." date: 2017-11-11 18:00 sidebar: true comments: false diff --git a/source/_components/climate.oem.markdown b/source/_components/climate.oem.markdown index be9b8cda21..2b7b401229 100644 --- a/source/_components/climate.oem.markdown +++ b/source/_components/climate.oem.markdown @@ -1,7 +1,7 @@ --- layout: page title: "OpenEnergyMonitor WiFi Thermostat" -description: "Instructions how to integrate an OpenEnergyMonitor thermostat with Home Assistant." +description: "Instructions on how to integrate an OpenEnergyMonitor thermostat with Home Assistant." date: 2017-01-27 11:15 sidebar: true comments: false diff --git a/source/_components/climate.proliphix.markdown b/source/_components/climate.proliphix.markdown index 74227c0a98..b089ef586d 100644 --- a/source/_components/climate.proliphix.markdown +++ b/source/_components/climate.proliphix.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Proliphix Thermostat" -description: "Instructions how to integrate Proliphix thermostats within Home Assistant." +description: "Instructions on how to integrate Proliphix thermostats within Home Assistant." date: 2016-01-15 08:00 sidebar: true comments: false diff --git a/source/_components/climate.radiotherm.markdown b/source/_components/climate.radiotherm.markdown index f3cf3bd919..f4d08db107 100644 --- a/source/_components/climate.radiotherm.markdown +++ b/source/_components/climate.radiotherm.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Radio Thermostat (3M Filtrete) Thermostat" -description: "Instructions how to integrate Radio Thermostat (3M Filtrete) thermostats within Home Assistant." +description: "Instructions on how to integrate Radio Thermostat (3M Filtrete) thermostats within Home Assistant." date: 2015-10-18 17:15 sidebar: true comments: false diff --git a/source/_components/climate.sensibo.markdown b/source/_components/climate.sensibo.markdown index 9b9771bc42..02003d4aa6 100644 --- a/source/_components/climate.sensibo.markdown +++ b/source/_components/climate.sensibo.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Sensibo A/C controller" -description: "Instructions how to integrate Sensibo A/C controller into Home Assistant." +description: "Instructions on how to integrate Sensibo A/C controller into Home Assistant." date: 2017-04-01 15:00 +0200 sidebar: true comments: false diff --git a/source/_components/climate.toon.markdown b/source/_components/climate.toon.markdown index 57d8708aa3..61e4258847 100644 --- a/source/_components/climate.toon.markdown +++ b/source/_components/climate.toon.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Toon Thermostat" -description: "Instructions how to integrate Toon thermostats within Home Assistant." +description: "Instructions on how to integrate Toon thermostats within Home Assistant." date: 2017-10-22 12:00 sidebar: true comments: false diff --git a/source/_components/climate.touchline.markdown b/source/_components/climate.touchline.markdown index ebc48a9df8..0f7f271946 100644 --- a/source/_components/climate.touchline.markdown +++ b/source/_components/climate.touchline.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Roth Touchline" -description: "Instructions how to integrate Roth Touchline within Home Assistant." +description: "Instructions on how to integrate Roth Touchline within Home Assistant." date: 2018-01-03 12:35 sidebar: true comments: false diff --git a/source/_components/climate.vera.markdown b/source/_components/climate.vera.markdown index bc8a9fdc58..c46b8fdff9 100644 --- a/source/_components/climate.vera.markdown +++ b/source/_components/climate.vera.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Vera Thermostat" -description: "Instructions how to integrate Vera thermostats into Home Assistant." +description: "Instructions on how to integrate Vera thermostats into Home Assistant." date: 2016-09-19 21:00 sidebar: true comments: false diff --git a/source/_components/climate.wink.markdown b/source/_components/climate.wink.markdown index 3a41d2c81d..be8623cb08 100644 --- a/source/_components/climate.wink.markdown +++ b/source/_components/climate.wink.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Wink Climate" -description: "Instructions how to setup the Wink climate devices within Home Assistant." +description: "Instructions on how to setup the Wink climate devices within Home Assistant." date: 2016-11-01 22:36 sidebar: true comments: false diff --git a/source/_components/climate.zwave.markdown b/source/_components/climate.zwave.markdown index 0669e0dfc6..e1b20babc6 100644 --- a/source/_components/climate.zwave.markdown +++ b/source/_components/climate.zwave.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Z-Wave Climate" -description: "Instructions how to setup the Z-Wave thermostat or HVAC within Home Assistant." +description: "Instructions on how to setup the Z-Wave thermostat or HVAC within Home Assistant." date: 2016-04-03 9:52 sidebar: true comments: false diff --git a/source/_components/comfoconnect.markdown b/source/_components/comfoconnect.markdown index fcce2b619f..7394042b84 100644 --- a/source/_components/comfoconnect.markdown +++ b/source/_components/comfoconnect.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Zehnder ComfoAir Q Ventilation" -description: "Instructions how to integrate Zehnder ComfoAir Q350/450/600 ventilation systems into Home Assistant." +description: "Instructions on how to integrate Zehnder ComfoAir Q350/450/600 ventilation systems into Home Assistant." date: 2017-06-28 18:00 sidebar: true comments: false diff --git a/source/_components/config.markdown b/source/_components/config.markdown index 514840e7f7..29aa9ce2ae 100644 --- a/source/_components/config.markdown +++ b/source/_components/config.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Config" -description: "Instructions how to setup the configuration panel for Home Assistant." +description: "Instructions on how to setup the configuration panel for Home Assistant." date: 2017-02-24 20:00 sidebar: true comments: false diff --git a/source/_components/configurator.markdown b/source/_components/configurator.markdown index 3d9661d50b..9cabdccbb3 100644 --- a/source/_components/configurator.markdown +++ b/source/_components/configurator.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Configurator" -description: "Instructions how to integrate the configurator in your components." +description: "Instructions on how to integrate the configurator in your components." date: 2015-03-15 00:51 sidebar: true comments: false diff --git a/source/_components/conversation.markdown b/source/_components/conversation.markdown index c4ae729c0f..e9bb86aaab 100644 --- a/source/_components/conversation.markdown +++ b/source/_components/conversation.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Conversation" -description: "Instructions how to have conversations with your Home Assistant." +description: "Instructions on how to have conversations with your Home Assistant." date: 2015-03-15 00:39 sidebar: true comments: false @@ -87,3 +87,9 @@ intent_script: - "{% if color == 'blue' %}255{% else %}0{% endif %}" {% endraw %} ``` + +#### {% linkable_title Service `conversation.process` %} + +| Service data attribute | Optional | Description | +|------------------------|----------|--------------------------------------------------| +| `text` | yes | Transcribed text | diff --git a/source/_components/counter.markdown b/source/_components/counter.markdown index b54dcc4385..f181d4755a 100644 --- a/source/_components/counter.markdown +++ b/source/_components/counter.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Counter" -description: "Instructions how to integrate counters into Home Assistant." +description: "Instructions on how to integrate counters into Home Assistant." date: 2017-08-26 06:00 sidebar: true comments: false diff --git a/source/_components/cover.abode.markdown b/source/_components/cover.abode.markdown index e67998bf0b..a80303a756 100644 --- a/source/_components/cover.abode.markdown +++ b/source/_components/cover.abode.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Abode Cover" -description: "Instructions how to integrate Abode covers into Home Assistant." +description: "Instructions on how to integrate Abode covers into Home Assistant." date: 2017-08-26 13:28 sidebar: true comments: false diff --git a/source/_components/cover.garadget.markdown b/source/_components/cover.garadget.markdown index 6ae25d44e8..0a3b5de358 100644 --- a/source/_components/cover.garadget.markdown +++ b/source/_components/cover.garadget.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Garadget Cover" -description: "Instructions how to integrate Garadget covers within Home Assistant." +description: "Instructions on how to integrate Garadget covers within Home Assistant." date: 2016-10-24 14:25 sidebar: true comments: false @@ -16,6 +16,8 @@ ha_iot_class: "Cloud Polling" The `garadget` cover platform lets you control [Garadget](http://www.garadget.com/) garage door futurizers through Home Assistant. +## {% linkable_title Configuration %} + To enable Garadget Covers in your installation, add the following to your `configuration.yaml` file: ```yaml @@ -24,8 +26,8 @@ cover: - platform: garadget covers: 190028001947343412342341: - username: UseYourLogin@garadget.com - password: abc123 + username: YOUR_USERNAME + password: YOUR_PASSWORD 4c003f001151353432134214: access_token: df4cc785ff818f2b01396c44142342fccdef ``` @@ -44,12 +46,13 @@ Configuration variables: If provided, the **access_token** will be used, otherwise the **username** and **password** will be used to automatically generate an access token at start time. +## {% linkable_title Example %} -**Example with more detail:**

+{% raw %} ```yaml # Related configuration.yaml entry cover: @@ -64,13 +67,13 @@ sensor: sensors: garage_door_status: friendly_name: 'State of the door' - value_template: {% raw %}'{{ states.cover.garage_door.state }}'{% endraw %} + value_template: '{{ states.cover.garage_door.state }}' garage_door_time_in_state: friendly_name: 'Since' - value_template: {% raw %}'{{ states.cover.garage_door.attributes.time_in_state }}'{% endraw %} + value_template: '{{ states.cover.garage_door.attributes.time_in_state }}' garage_door_wifi_signal_strength: friendly_name: 'WiFi strength' - value_template: {% raw %}'{{ states.cover.garage_door.attributes.wifi_signal_strength }}'{% endraw %} + value_template: '{{ states.cover.garage_door.attributes.wifi_signal_strength }}' unit_of_measurement: 'dB' group: @@ -88,6 +91,7 @@ customize: sensor.garage_door_wifi_signal_strength: icon: mdi:wifi ``` +{% endraw %} Some of the Garadget sensors can create a lot of clutter in the logbook. Use this section of code in your `configuration.yaml` to exclude those entries. diff --git a/source/_components/cover.gogogate2.markdown b/source/_components/cover.gogogate2.markdown new file mode 100644 index 0000000000..a24ef1fd02 --- /dev/null +++ b/source/_components/cover.gogogate2.markdown @@ -0,0 +1,49 @@ +--- +layout: page +title: "Gogogate2 Cover" +description: "Instructions on how to integrate Gogogate2-Enabled garage door covers into Home Assistant." +date: 2018-03-26 20:02 +sidebar: true +comments: false +sharing: true +footer: true +logo: gogogate2.png +ha_category: Cover +ha_release: 0.67 +ha_iot_class: Local Polling +--- + +The `gogogate2` cover platform lets you control Gogogate2-Enabled garage doors through Home Assistant. Device names in Home Assistant are generated based on the names defined in your Gogogate2 mobile app. + +## {% linkable_title Configuration %} + +To use your Gogogate2 cover in your installation, add the following to your `configuration.yaml` file: + +```yaml +# Example configuration.yaml entry +cover: + - platform: gogogate2 + username: email@email.com + password: password + ip_address: 192.168.1.200 +``` + +{% configuration %} +username: + description: Your Gogogate2 account username. + required: true + type: string +password: + description: Your Gogogate2 account password. + required: true + type: string +ip_address: + description: The IP Address of your Gogogate2 device. + required: true + type: string +name: + description: Allows you to override the default name. + default: gogogate2 + required: false + type: string +{% endconfiguration %} diff --git a/source/_components/cover.group.markdown b/source/_components/cover.group.markdown new file mode 100644 index 0000000000..c29b4b46a1 --- /dev/null +++ b/source/_components/cover.group.markdown @@ -0,0 +1,43 @@ +--- +layout: page +title: "Cover Group" +description: "Instructions how to setup grouped covers in Home Assistant." +date: 2018-02-11 10:00 +sidebar: true +comments: false +sharing: true +footer: true +ha_category: Cover +ha_release: 0.66 +ha_iot_class: "Local Push" +logo: home-assistant.png +--- + +The `group` platform can create a cover that combines several cover entities into one. + +To enable `Cover Groups` in your installation, add the following to your `configuration.yaml` file: + +```yaml +# Example configuration.yaml entry +cover: + - platform: group + entities: + - cover.hall_window + - cover.living_room_window +``` + +{% configuration %} + name: + description: Name to use in the frontend. + required: false + type: string + default: "Cover Group" + entities: + description: List of all cover entities you want to control. + required: true + type: [string | list] +{% endconfiguration %} + +## {% linkable_title Functionality %} + +It works best if you group covers with the same supported features together (like support for `open`/`close`/`stop`/`position`/`tilt controls`), but is not limited to it. In case you have bundled covers with different features together, the controls will only affect those covers that support the actions. diff --git a/source/_components/cover.homematic.markdown b/source/_components/cover.homematic.markdown index 9ac3fa4aca..e5f3a8930e 100644 --- a/source/_components/cover.homematic.markdown +++ b/source/_components/cover.homematic.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Homematic Cover" -description: "Instructions how to integrate Homematic covers within Home Assistant." +description: "Instructions on how to integrate Homematic covers within Home Assistant." date: 2016-08-24 14:25 sidebar: true comments: false diff --git a/source/_components/cover.isy994.markdown b/source/_components/cover.isy994.markdown index 95aed3d3ba..929afac31d 100644 --- a/source/_components/cover.isy994.markdown +++ b/source/_components/cover.isy994.markdown @@ -1,7 +1,7 @@ --- layout: page title: "ISY994 Cover" -description: "Instructions how to integrate ISY994 covers into Home Assistant." +description: "Instructions on how to integrate ISY994 covers into Home Assistant." date: 2016-09-03 23:00 sidebar: true comments: false diff --git a/source/_components/cover.lutron.markdown b/source/_components/cover.lutron.markdown index 50cb5b1ef9..ffd2c100b2 100644 --- a/source/_components/cover.lutron.markdown +++ b/source/_components/cover.lutron.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Lutron Cover" -description: "Instructions how to setup the Lutron shades within Home Assistant." +description: "Instructions on how to setup the Lutron shades within Home Assistant." date: 2018-01-11 20:00 sidebar: true comments: false diff --git a/source/_components/cover.lutron_caseta.markdown b/source/_components/cover.lutron_caseta.markdown index 713c454472..ee64257f1a 100644 --- a/source/_components/cover.lutron_caseta.markdown +++ b/source/_components/cover.lutron_caseta.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Lutron Caseta Cover" -description: "Instructions how to setup the Lutron Caseta covers within Home Assistant." +description: "Instructions on how to setup the Lutron Caseta covers within Home Assistant." date: 2017-05-20 09:00 sidebar: true comments: false diff --git a/source/_components/cover.markdown b/source/_components/cover.markdown index 8024b67a3b..a530768096 100644 --- a/source/_components/cover.markdown +++ b/source/_components/cover.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Covers" -description: "Instructions how to integrate covers into Home Assistant." +description: "Instructions on how to integrate covers into Home Assistant." date: 2016-06-28 17:30 sidebar: true comments: false diff --git a/source/_components/cover.mqtt.markdown b/source/_components/cover.mqtt.markdown index f06204cfaa..81358f8776 100755 --- a/source/_components/cover.mqtt.markdown +++ b/source/_components/cover.mqtt.markdown @@ -1,7 +1,7 @@ --- layout: page title: "MQTT Cover" -description: "Instructions how to integrate MQTT covers into Home Assistant." +description: "Instructions on how to integrate MQTT covers into Home Assistant." date: 2016-09-28 17:30 sidebar: true comments: false @@ -15,6 +15,8 @@ ha_release: 0.18 The `mqtt` cover platform allows you to control an MQTT cover (such as blinds, a rollershutter, or a garage door). +## {% linkable_title Configuration %} + The device state (`open` or `closed`) will be updated only after a new message is published on `state_topic` matching `state_open` or `state_closed`. If these messages are published with the `retain` flag set, the cover 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`. There is an attribute that stores the relative position of the device, where 0 means the device is `closed` and all other intermediate positions means the device is `open`. @@ -164,7 +166,7 @@ In this section you will find some real life examples of how to use this platfor The example below shows a full configuration for a cover without tilt. ```yaml -# Example configuration.yml entry +# Example configuration.yaml entry cover: - platform: mqtt name: "MQTT Cover" @@ -188,8 +190,9 @@ cover: The example below shows a full configuration for a cover. +{% raw %} ```yaml -# Example configuration.yml entry +# Example configuration.yaml entry cover: - platform: mqtt name: "MQTT Cover" @@ -206,7 +209,7 @@ cover: payload_available: "online" payload_not_available: "offline" optimistic: false - value_template: '{% raw %}{{ value.x }}{% endraw %}' + value_template: '{{ value.x }}' tilt_command_topic: 'home-assistant/cover/tilt' tilt_status_topic: 'home-assistant/cover/tilt-state' tilt_min: 0 @@ -214,6 +217,7 @@ cover: tilt_closed_value: 70 tilt_opened_value: 180 ``` +{% endraw %} To test, you can use the command line tool `mosquitto_pub` shipped with `mosquitto` or the `mosquitto-clients` package to send MQTT messages. This allows you to operate your cover manually: diff --git a/source/_components/cover.myq.markdown b/source/_components/cover.myq.markdown index 405065d88a..419e65ef7a 100644 --- a/source/_components/cover.myq.markdown +++ b/source/_components/cover.myq.markdown @@ -1,7 +1,7 @@ --- layout: page title: "MyQ Cover" -description: "Instructions how to integrate MyQ-Enabled garage door covers into Home Assistant." +description: "Instructions on how to integrate MyQ-Enabled garage door covers into Home Assistant." date: 2017-02-14 14:21 sidebar: true comments: false @@ -15,19 +15,31 @@ ha_iot_class: Cloud Polling The `myq` cover platform lets you control MyQ-Enabled garage doors through Home Assistant. Device names in Home Assistant are generated based on the names defined in your MyQ Device mobile app. +## {% linkable_title Configuration %} + To use your MyQ cover in your installation, add the following to your `configuration.yaml` file: ```yaml -# Example configuration.yml entry +# Example configuration.yaml entry cover: - platform: myq - username: email@email.com - password: password + username: YOUR_USERNAME + password: YOUR_PASSWORD type: chamberlain ``` -Configuration variables: +{% configuration %} +username: + description: Your MyQ account username. + required: true + type: string +password: + description: Your MyQ account password. + required: true + type: string +password: + description: "Your device type/brand. Supported types are `chamberlain`, `liftmaster`, `craftsman` and `merlin`." + required: true + type: string +{% endconfiguration %} -- **username** (*Required*): Your MyQ account username. -- **password** (*Required*): Your MyQ account password. -- **type** (*Required*): Your device type/brand. Supported types are `chamberlain`, `liftmaster`, `craftsman` and `merlin`. diff --git a/source/_components/cover.mysensors.markdown b/source/_components/cover.mysensors.markdown index c94ec4f57f..b4ded3e1b4 100644 --- a/source/_components/cover.mysensors.markdown +++ b/source/_components/cover.mysensors.markdown @@ -1,7 +1,7 @@ --- layout: page title: "MySensors Cover" -description: "Instructions how to integrate MySensors covers into Home Assistant." +description: "Instructions on how to integrate MySensors covers into Home Assistant." date: 2016-10-01 15:00 +0200 sidebar: true comments: false diff --git a/source/_components/cover.opengarage.markdown b/source/_components/cover.opengarage.markdown index 7ee7fccb49..815b1e1e64 100644 --- a/source/_components/cover.opengarage.markdown +++ b/source/_components/cover.opengarage.markdown @@ -1,7 +1,7 @@ --- layout: page title: "OpenGarage Cover" -description: "Instructions how to integrate OpenGarage.io covers within Home Assistant." +description: "Instructions on how to integrate OpenGarage.io covers within Home Assistant." date: 2017-04-07 14:25 sidebar: true comments: false diff --git a/source/_components/cover.rflink.markdown b/source/_components/cover.rflink.markdown index 1bd3a1a50c..bc4d18538d 100644 --- a/source/_components/cover.rflink.markdown +++ b/source/_components/cover.rflink.markdown @@ -1,7 +1,7 @@ --- layout: page title: "RFLink Cover" -description: "Instructions how to integrate RFLink Somfy RTS Cover into Home Assistant." +description: "Instructions on how to integrate RFLink Somfy RTS Cover into Home Assistant." date: 2017-08-08 sidebar: true comments: false diff --git a/source/_components/cover.rfxtrx.markdown b/source/_components/cover.rfxtrx.markdown index 115332a8e0..dd31090f86 100644 --- a/source/_components/cover.rfxtrx.markdown +++ b/source/_components/cover.rfxtrx.markdown @@ -1,7 +1,7 @@ --- layout: page title: "RFXtrx Cover" -description: "Instructions how to integrate RFXtrx covers into Home Assistant." +description: "Instructions on how to integrate RFXtrx covers into Home Assistant." date: 2016-08-24 14:30 sidebar: true comments: false diff --git a/source/_components/cover.rpi_gpio.markdown b/source/_components/cover.rpi_gpio.markdown index 581c6f3698..ac953405f0 100644 --- a/source/_components/cover.rpi_gpio.markdown +++ b/source/_components/cover.rpi_gpio.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Raspberry Pi Cover" -description: "Instructions how to setup the Raspberry Pi covers within Home Assistant." +description: "Instructions on how to setup the Raspberry Pi covers within Home Assistant." date: 2016-08-24 14:28 sidebar: true comments: false diff --git a/source/_components/cover.scsgate.markdown b/source/_components/cover.scsgate.markdown index 52f198b7ed..96b49a7158 100644 --- a/source/_components/cover.scsgate.markdown +++ b/source/_components/cover.scsgate.markdown @@ -1,7 +1,7 @@ --- layout: page title: "SCSGate Cover" -description: "Instructions how to integrate SCSGate motorized devices into Home Assistant." +description: "Instructions on how to integrate SCSGate motorized devices into Home Assistant." date: 2016-06-28 17:30 sidebar: true comments: false diff --git a/source/_components/cover.tahoma.markdown b/source/_components/cover.tahoma.markdown index 1176153355..a67537ca11 100644 --- a/source/_components/cover.tahoma.markdown +++ b/source/_components/cover.tahoma.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Tahoma Cover" -description: "Instructions how to integrate Tahoma covers into Home Assistant." +description: "Instructions on how to integrate Tahoma covers into Home Assistant." date: 2017-07-18 12:00 sidebar: true comments: false diff --git a/source/_components/cover.tellstick.markdown b/source/_components/cover.tellstick.markdown index 2008ef2a73..1d2660cda5 100644 --- a/source/_components/cover.tellstick.markdown +++ b/source/_components/cover.tellstick.markdown @@ -1,7 +1,7 @@ --- layout: page title: "TellStick Cover" -description: "Instructions how to integrate TellStick covers into Home Assistant." +description: "Instructions on how to integrate TellStick covers into Home Assistant." date: 2017-11-29 16:23 sidebar: true comments: false diff --git a/source/_components/cover.template.markdown b/source/_components/cover.template.markdown index 25dd15b787..06a4c09d9c 100644 --- a/source/_components/cover.template.markdown +++ b/source/_components/cover.template.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Template Cover" -description: "Instructions how to integrate Template Covers into Home Assistant." +description: "Instructions on how to integrate Template Covers into Home Assistant." date: 2017-06-19 20:32 sidebar: true comments: false diff --git a/source/_components/cover.vera.markdown b/source/_components/cover.vera.markdown index 32eee4bcae..a982c83a41 100644 --- a/source/_components/cover.vera.markdown +++ b/source/_components/cover.vera.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Vera Cover" -description: "Instructions how to integrate Vera covers into Home Assistant." +description: "Instructions on how to integrate Vera covers into Home Assistant." date: 2016-09-19 21:00 sidebar: true comments: false diff --git a/source/_components/cover.wink.markdown b/source/_components/cover.wink.markdown index 758f01b844..8c82634187 100644 --- a/source/_components/cover.wink.markdown +++ b/source/_components/cover.wink.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Wink Cover" -description: "Instructions how to setup the Wink garage doors within Home Assistant." +description: "Instructions on how to setup the Wink garage doors within Home Assistant." date: 2016-06-28 17:30 sidebar: true comments: false @@ -13,24 +13,20 @@ ha_release: 0.13 ha_iot_class: "Cloud Polling" --- -Wink cover/garage door functionality depends on the product you're using. With GoControl/Linear Home Assistant can open, close, and view state. Chamberlain is currently limited to view only. Meaning Home Assistant will only show the current state of the door and control has been disabled (by Chamberlain). If you have a Chamberlain garage door, and would like to control it via Home Assistant, please contact Chamberlain and request that they re-enabled third-party control. +Wink Cover garage door functionality varies on the product. Home Assistant can open, close, and view state of GoControl/Linear openers. For Chamberlain MyQ-enabled openers, Home Assistant is limited to show current state (open or closed) only using this Wink cover. This restriction was imposed by Chamberlain for third party control. Wink suggests that MyQ customers should contact Chamberlain directly to inquire about expanding permissions. -The following quote is from Wink. - -> As part of our agreement with Chamberlain, third-party access to control Chamberlain garage doors has been restricted. Please contact Chamberlain directly to inquire about permissions. +The [MyQ Cover](/components/cover.myq/) does provide full functionality for opening and closing Chamberlain MyQ-enabled garage doors. If installed along with the Wink Component, a duplicate garage door entity may exist. In that case, the semi-functional Wink garage door entity can be hidden via customize.yaml. The requirement is that you have setup [Wink](/components/wink/). - ### {% linkable_title Supported cover devices %} - Bali window treatments - Lutron shades - Pella motorized blinds and shades - GoControl garage door opener -- Chamberlain (Limited functionality) (No Wink hub required) +- Chamberlain MyQ (Limited functionality) (No Wink hub required)

The above devices are confirmed to work, but others may work as well.

- diff --git a/source/_components/cover.xiaomi_aqara.markdown b/source/_components/cover.xiaomi_aqara.markdown index d2bbdf5fa9..6f5353b9c8 100644 --- a/source/_components/cover.xiaomi_aqara.markdown +++ b/source/_components/cover.xiaomi_aqara.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Xiaomi Cover" -description: "Instructions how to setup the Xiaomi cover within Home Assistant." +description: "Instructions on how to setup the Xiaomi cover within Home Assistant." date: 2017-07-21 16:34 sidebar: true comments: false diff --git a/source/_components/cover.zwave.markdown b/source/_components/cover.zwave.markdown index 90547584ce..53477e1e00 100644 --- a/source/_components/cover.zwave.markdown +++ b/source/_components/cover.zwave.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Z-Wave Cover" -description: "Instructions how to setup the Z-Wave covers within Home Assistant." +description: "Instructions on how to setup the Z-Wave covers within Home Assistant." date: 2016-12-18 19:41 sidebar: true comments: false diff --git a/source/_components/datadog.markdown b/source/_components/datadog.markdown index 511d51608a..7a3ec052c7 100644 --- a/source/_components/datadog.markdown +++ b/source/_components/datadog.markdown @@ -35,7 +35,7 @@ datadog: Configuration variables: -- **host** (*Optional*): The IP address or hostname of your Datadog host, e.g. 192.168.1.23. Defaults to `localhost`. +- **host** (*Optional*): The IP address or hostname of your Datadog host, e.g., 192.168.1.23. Defaults to `localhost`. - **port** (*Optional*): Port to use. Defaults to 8125. - **prefix** (*Optional*): Prefix to use. Defaults to `hass`. - **rate** (*Optional*): The sample rate of UDP packets sent to Datadog. Defaults to 1. diff --git a/source/_components/deconz.markdown b/source/_components/deconz.markdown index abebcec803..d1fde01521 100644 --- a/source/_components/deconz.markdown +++ b/source/_components/deconz.markdown @@ -17,29 +17,33 @@ ha_iot_class: "Local Push" [deCONZ REST API](http://dresden-elektronik.github.io/deconz-rest-doc/). +### {% linkable_title Supported device types %} + +- [Zigbee Lights](/components/light.deconz/) +- [Consumption Sensors](/components/sensor.deconz/) +- [Humidity Sensors](/components/sensor.deconz/) +- [Light Level Sensors](/components/sensor.deconz/) +- [OpenClose Detectors](/components/binary_sensor.deconz/) +- [Power Sensors](/components/sensor.deconz/) +- [Presence Detectors](/components/binary_sensor.deconz/) +- [Pressure Sensors](/components/sensor.deconz/) +- [Switches (Remote Controls)](/components/sensor.deconz/) +- [Temperature Sensors](/components/sensor.deconz/) + +## {% linkable_title Configuration %} + Home Assistant will automatically discover deCONZ presence on your network, if `discovery:` is present in your `configuration.yaml` file. -If you don't have the API key, you can generate an API key for deCONZ by using the one-click functionality similar to Philips Hue. Go to Menu->Settings->Unlock Gateway in deCONZ and then use the deCONZ configurator in Home Assistant GUI to create an API key. When you've generated the API key from Home Assistant, the API key will be stored in deconz.conf inside the home-assistant folder. +If you don't have the API key, you can generate an API key for deCONZ by using the one-click functionality similar to Philips Hue. Go to **Menu** -> **Settings** -> **Unlock Gateway** in deCONZ and then use the deCONZ configurator in Home Assistant frontend to create an API key. When you've generated the API key from Home Assistant, the API key will be stored in `.config_entries.json` inside the `.homeassistant` folder. You can add the following to your configuration.yaml file if you are not using the `discovery:` component: ```yaml # Example configuration.yaml entry deconz: - host: IP ADDRESS + host: IP_ADDRESS ``` -#### {% linkable_title Supported Device types %} - -- [Zigbee Lights](/components/light.deconz/) -- [Humidity Sensors](/components/sensor.deconz/) -- [Light Level Sensors](/components/sensor.deconz/) -- [OpenClose Detectors](/components/binary_sensor.deconz/) -- [Presence Detectors](/components/binary_sensor.deconz/) -- [Pressure Sensors](/components/sensor.deconz/) -- [Switches (Remote Controls)](/components/sensor.deconz/) -- [Temperature Sensors](/components/sensor.deconz/) - {% configuration %} host: description: The IP address of your deCONZ web server. @@ -66,10 +70,24 @@ deconz: port: 80 ``` +## {% linkable_title Debugging component %} + +If you have problems with deCONZ or the component you can add debug prints to the log. + +```yaml +logger: + default: info + logs: + pydeconz: debug +    homeassistant.components.deconz: debug +``` + ## {% linkable_title Device services %} + Available services: `configure`. -#### {% linkable_title Service `deconz/configure` %} +#### {% linkable_title Service `deconz.configure` %} + Set attribute of device in Deconz using [Rest API](http://dresden-elektronik.github.io/deconz-rest-doc/rest/). | Service data attribute | Optional | Description | @@ -86,7 +104,7 @@ Field and entity are exclusive, i.e you can only use one in a request. { "field": "/config", "data": {"permitjoin": 60} } -## {% linkable_title Remote control devices%} +## {% linkable_title Remote control devices %} Remote controls (ZHASwitch category) will be not be exposed as a regular entity, but as events named 'deconz_event' with a payload of 'id' and 'event'. Id will be the device name from deCONZ and Event will be the momentary state of the switch. However, a sensor entity will be created that shows the battery level of the switch as reported by deCONZ, named sensor.device_name_battery_level. @@ -107,6 +125,7 @@ For the IKEA Tradfri remote, 1 is the middle button, 2 is up, 3 is down, 4 is le ### {% linkable_title Step up and step down input number with wireless dimmer %} +{% raw %} ```yaml automation: - alias: 'Toggle lamp from dimmer' @@ -133,9 +152,9 @@ automation: - service: light.turn_on data_template: entity_id: light.lamp - brightness: {% raw %}> + brightness: > {% set bri = states.light.lamp.attributes.brightness | int %} - {{ [bri+30, 249] | min }}{% endraw %} + {{ [bri+30, 249] | min }} - alias: 'Decrease brightness of lamp from dimmer' initial_state: 'on' @@ -149,7 +168,8 @@ automation: - service: light.turn_on data_template: entity_id: light.lamp - brightness: {% raw %}> + brightness: > {% set bri = states.light.lamp.attributes.brightness | int %} - {{ [bri-30, 0] | max }}{% endraw %} + {{ [bri-30, 0] | max }} ``` +{% endraw %} diff --git a/source/_components/demo.markdown b/source/_components/demo.markdown index b399c9485c..f1c2573720 100644 --- a/source/_components/demo.markdown +++ b/source/_components/demo.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Demo platforms" -description: "Instructions how to use the Platform demos with Home Assistant." +description: "Instructions on how to use the Platform demos with Home Assistant." date: 2016-02-24 07:00 sidebar: true comments: false @@ -12,7 +12,7 @@ ha_category: Other --- -The `demo` platform allows you to use components which are providing a demo of their implementation. The demo entities are dummies but show you how the actual platform looks like. This way you can run own demonstration instance like the online [Home Assistant demo](https://home-assistant.io/demo/) or `hass --demo-mode` but combined with your own real/functional platforms. +The `demo` platform allows you to use components which are providing a demo of their implementation. The demo entities are dummies but show you how the actual platform looks like. This way you can run own demonstration instance like the online [Home Assistant demo](/demo/) or `hass --demo-mode` but combined with your own real/functional platforms. Available demo platforms: diff --git a/source/_components/device_sun_light_trigger.markdown b/source/_components/device_sun_light_trigger.markdown index e0a75a093c..d49c4e1565 100644 --- a/source/_components/device_sun_light_trigger.markdown +++ b/source/_components/device_sun_light_trigger.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Presence based lights" -description: "Instructions how to automate your lights with Home Assistant." +description: "Instructions on how to automate your lights with Home Assistant." date: 2015-01-20 22:36 sidebar: true comments: false diff --git a/source/_components/device_tracker.actiontec.markdown b/source/_components/device_tracker.actiontec.markdown index b292353585..fbf2119650 100644 --- a/source/_components/device_tracker.actiontec.markdown +++ b/source/_components/device_tracker.actiontec.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Actiontec" -description: "Instructions how to integrate Actiontec routers into Home Assistant." +description: "Instructions on how to integrate Actiontec routers into Home Assistant." date: 2015-08-30 19:00 sidebar: true comments: false diff --git a/source/_components/device_tracker.aruba.markdown b/source/_components/device_tracker.aruba.markdown index 0dd6102555..e84c37954b 100644 --- a/source/_components/device_tracker.aruba.markdown +++ b/source/_components/device_tracker.aruba.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Aruba" -description: "Instructions how to integrate Aruba routers into Home Assistant." +description: "Instructions on how to integrate Aruba routers into Home Assistant." date: 2015-08-31 08:45 sidebar: true comments: false @@ -36,7 +36,7 @@ device_tracker: Configuration variables: -- **host** (*Required*): The IP address of your router, e.g. `192.168.1.1`. +- **host** (*Required*): The IP address of your router, e.g., `192.168.1.1`. - **username** (*Required*): The username of an user with administrative privileges, usually `admin`. - **password** (*Required*): The password for your given admin account. diff --git a/source/_components/device_tracker.asuswrt.markdown b/source/_components/device_tracker.asuswrt.markdown index a49a066309..7889253ce9 100644 --- a/source/_components/device_tracker.asuswrt.markdown +++ b/source/_components/device_tracker.asuswrt.markdown @@ -1,7 +1,7 @@ --- layout: page title: "ASUSWRT" -description: "Instructions how to integrate ASUSWRT based routers into Home Assistant." +description: "Instructions on how to integrate ASUSWRT based routers into Home Assistant." date: 2015-08-06 19:00 sidebar: true comments: false @@ -19,6 +19,8 @@ The `asuswrt` platform offers presence detection by looking at connected devices This platform is **NOT** available for [Microsoft Windows installations](http://pexpect.readthedocs.io/en/stable/overview.html#pexpect-on-windows).

+### {% linkable_title Configuration %} + To use an ASUSWRT router in your installation, add the following to your `configuration.yaml` file: ```yaml @@ -29,15 +31,44 @@ device_tracker: username: YOUR_ADMIN_USERNAME ``` -Configuration variables: - -- **host** (*Required*): The IP address of your router, eg. `192.168.1.1`. -- **username** (*Required*: The username of an user with administrative privileges, usually `admin`. -- **password** (*Optional*): The password for your given admin account (use this if no SSH key is given). -- **protocol** (*Optional*): The protocol (`ssh` or `telnet`) to use. Defaults to `ssh`. -- **port** (*Optional*): SSH port to use. Defaults to `22`. -- **mode** (*Optional*): The operating mode of the router (`router` or `ap`). Defaults to `router`. -- **ssh_key** (*Optional*): The path to your SSH private key file associated with your given admin account (instead of password). +{% configuration %} +host: + description: "The IP address of your router, eg. `192.168.1.1`." + required: true + type: string +username: + description: "The username of an user with administrative privileges, usually `admin`." + required: true + type: string +password: + description: "The password for your given admin account (use this if no SSH key is given)." + required: false + type: string +protocol: + description: "The protocol (`ssh` or `telnet`) to use." + required: false + type: string + default: ssh +port: + description: SSH port to use. + required: false + type: int + default: 22 +mode: + description: "The operating mode of the router (`router` or `ap`)." + required: false + type: string + default: router +ssh_key: + description: The path to your SSH private key file associated with your given admin account (instead of password). + required: false + type: string +require_ip: + description: If the router is in access point mode. + required: false + type: boolean + default: true +{% endconfiguration %}

You need to [enable telnet](https://www.asus.com/support/faq/1005449/) on your router if you choose to use `protocol: telnet`. diff --git a/source/_components/device_tracker.bbox.markdown b/source/_components/device_tracker.bbox.markdown index 7a5cc91649..35bae013f0 100644 --- a/source/_components/device_tracker.bbox.markdown +++ b/source/_components/device_tracker.bbox.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Bbox" -description: "Instructions how to integrate Bouygues Bbox routers into Home Assistant." +description: "Instructions on how to integrate Bouygues Bbox routers into Home Assistant." date: 2016-10-13 23:00 sidebar: true comments: false diff --git a/source/_components/device_tracker.bluetooth_le_tracker.markdown b/source/_components/device_tracker.bluetooth_le_tracker.markdown index 03b844f667..ce1dab5000 100644 --- a/source/_components/device_tracker.bluetooth_le_tracker.markdown +++ b/source/_components/device_tracker.bluetooth_le_tracker.markdown @@ -48,7 +48,7 @@ Configuration variables: - **interval_seconds** (*Optional*): Seconds between each scan for new devices. Defaults to `12` seconds. As some BT LE devices change their MAC address regularly, a new device is only discovered when it has been seen 5 times. -Some BTLE devices (e.g. fitness trackers) are only visible to the devices that they are paired with. In this case, the BTLE tracker won't see this device. +Some BTLE devices (e.g., fitness trackers) are only visible to the devices that they are paired with. In this case, the BTLE tracker won't see this device. ## {% linkable_title Rootless Setup %} diff --git a/source/_components/device_tracker.bluetooth_tracker.markdown b/source/_components/device_tracker.bluetooth_tracker.markdown index 0a2a2d0632..45bd09eae3 100644 --- a/source/_components/device_tracker.bluetooth_tracker.markdown +++ b/source/_components/device_tracker.bluetooth_tracker.markdown @@ -27,6 +27,14 @@ device_tracker: - platform: bluetooth_tracker ``` +{% configuration %} +request_rssi: + description: Performs a request for the "Received signal strength indication" (RSSI) of each tracked device + required: false + type: boolean + default: False +{% endconfiguration %} + In some cases it can be that your device is not discovered. In that case let your phone scan for Bluetooth devices while you restart Home Assistant. Just hit `Scan` on your phone all the time until Home Assistant is fully restarted and the device should appear in `known_devices.yaml`. For additional configuration variables check the [Device tracker page](/components/device_tracker/). diff --git a/source/_components/device_tracker.bmw_connected_drive.markdown b/source/_components/device_tracker.bmw_connected_drive.markdown index d00d588b35..4f390c5fa3 100644 --- a/source/_components/device_tracker.bmw_connected_drive.markdown +++ b/source/_components/device_tracker.bmw_connected_drive.markdown @@ -1,7 +1,7 @@ --- layout: page -title: "BMW connected drive" -description: "Instructions on how to setup your BMW connected drive account with Home Assistant." +title: "BMW Connected Drive Device Tracker" +description: "Instructions on how to setup your BMW Connected Drive account with Home Assistant." date: 2018-01-10 23:00 sidebar: true comments: false diff --git a/source/_components/device_tracker.bt_home_hub_5.markdown b/source/_components/device_tracker.bt_home_hub_5.markdown index 9fd185eadd..106ba06083 100644 --- a/source/_components/device_tracker.bt_home_hub_5.markdown +++ b/source/_components/device_tracker.bt_home_hub_5.markdown @@ -1,7 +1,7 @@ --- layout: page title: "BT Home Hub 5" -description: "Instructions how to integrate BT Home Hub 5 router into Home Assistant." +description: "Instructions on how to integrate BT Home Hub 5 router into Home Assistant." date: 2016-06-13 13:00 sidebar: true comments: false @@ -25,6 +25,6 @@ device_tracker: Configuration variables: -- **host** (*Required*): The IP address of your router, e.g. 192.168.1.254. +- **host** (*Required*): The IP address of your router, e.g., 192.168.1.254. See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked. diff --git a/source/_components/device_tracker.cisco_ios.markdown b/source/_components/device_tracker.cisco_ios.markdown index 1402e84064..589241b8eb 100644 --- a/source/_components/device_tracker.cisco_ios.markdown +++ b/source/_components/device_tracker.cisco_ios.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Cisco IOS" -description: "Instructions how to integrate Cisco IOS routers into Home Assistant." +description: "Instructions on how to integrate Cisco IOS routers into Home Assistant." date: 2016-11-07 19:59 sidebar: true comments: false @@ -59,7 +59,7 @@ device_tracker: Configuration variables: -- **host** (*Required*): The IP address of your router, e.g. 192.168.1.1. +- **host** (*Required*): The IP address of your router, e.g., 192.168.1.1. - **username** (*Required*): The username of an user with administrative privileges. - **password** (*Required*): The password for your given admin account. diff --git a/source/_components/device_tracker.ddwrt.markdown b/source/_components/device_tracker.ddwrt.markdown index 4fa4fe0af4..826046d029 100644 --- a/source/_components/device_tracker.ddwrt.markdown +++ b/source/_components/device_tracker.ddwrt.markdown @@ -1,7 +1,7 @@ --- layout: page title: "DD-WRT" -description: "Instructions how to integrate DD-WRT based routers into Home Assistant." +description: "Instructions on how to integrate DD-WRT based routers into Home Assistant." date: 2015-05-11 09:00 sidebar: true comments: false @@ -27,7 +27,7 @@ device_tracker: Configuration variables: -- **host** (*Required*): The IP address of your router, e.g. `192.168.1.1`. +- **host** (*Required*): The IP address of your router, e.g., `192.168.1.1`. - **username** (*Required*: The username of an user with administrative privileges, usually `admin`. - **password** (*Required*): The password for your given admin account. diff --git a/source/_components/device_tracker.fritz.markdown b/source/_components/device_tracker.fritz.markdown index 40d7bfa985..3e4a745d99 100644 --- a/source/_components/device_tracker.fritz.markdown +++ b/source/_components/device_tracker.fritz.markdown @@ -1,7 +1,7 @@ --- layout: page title: "FRITZ!Box" -description: "Instructions how to integrate AVM FRITZ!Box based routers into Home Assistant." +description: "Instructions on how to integrate AVM FRITZ!Box based routers into Home Assistant." date: 2015-12-13 19:00 sidebar: true comments: false @@ -15,6 +15,8 @@ ha_release: "0.10" The `fritz` platform offers presence detection by looking at connected devices to a [AVM Fritz!Box](http://avm.de/produkte/fritzbox/) based router. +## {% linkable_title Configuration %} +

It might be necessary to install additional packages: $ sudo apt-get install libxslt-dev libxml2-dev python3-lxml If you are working with the All-in-One installation, you may also need to execute also within your virtual environment the command pip install lxml; be patient this will take a while.

diff --git a/source/_components/device_tracker.geofency.markdown b/source/_components/device_tracker.geofency.markdown index 320b59d488..be09d277a1 100644 --- a/source/_components/device_tracker.geofency.markdown +++ b/source/_components/device_tracker.geofency.markdown @@ -39,8 +39,8 @@ device_tracker: To configure Geofency, you must configure (via the Webhook feature) to send a POST request to your Home Assistant server at `http:///api/geofency`. Use the default POST format, and make sure to include the API password if you have configured a password in Home Assistant (add `?api_password=` to the end of the URL). Make sure to enable the 'Update Geo-Position' functionality for mobile beacons. -Geofency will automatically generate the device tracker name used for geofences, and you will find it in `known_devices.yaml` after the first request. For beacons, the device name will be `beacon_`, e.g., `device_tracker.beacon_car`. +Geofency will automatically generate the device tracker name used for geofences, and you will find it in `known_devices.yaml` after the first request. For beacons, the device name will be `beacon_`, e.g., `device_tracker.beacon_car`. -When you enter a geofence or stationary beacon, your location name in Home Assistant will be set to the name of the geofence or beacon location in Geofency. When you exit a geofence or stationary beacon, your location name in Home Assistant will be set to 'not home'. For mobile beacons, the location name will be 'not_home' whenever the beacon is entered or exited outside of a [zone](https://home-assistant.io/components/zone/), otherwise, it will be set to the name of the zone. +When you enter a geofence or stationary beacon, your location name in Home Assistant will be set to the name of the geofence or beacon location in Geofency. When you exit a geofence or stationary beacon, your location name in Home Assistant will be set to 'not home'. For mobile beacons, the location name will be 'not_home' whenever the beacon is entered or exited outside of a [zone](/components/zone/), otherwise, it will be set to the name of the zone. -To make Geofency work better with the [proximity](https://home-assistant.io/components/proximity/) component, you should enable the 'Send Current Location' feature in the Webhook configuration screen. This ensures that the _current_ GPS coordinates are included in exit events instead of the coordinates of the (center of) the zone that was exited. \ No newline at end of file +To make Geofency work better with the [proximity](/components/proximity/) component, you should enable the 'Send Current Location' feature in the Webhook configuration screen. This ensures that the _current_ GPS coordinates are included in exit events instead of the coordinates of the (center of) the zone that was exited. \ No newline at end of file diff --git a/source/_components/device_tracker.google_maps.markdown b/source/_components/device_tracker.google_maps.markdown new file mode 100644 index 0000000000..d05c9e35d2 --- /dev/null +++ b/source/_components/device_tracker.google_maps.markdown @@ -0,0 +1,46 @@ +--- +layout: page +title: "Google Maps Location Sharing" +description: "Instructions how to use Google Maps Location Sharing to track devices in Home Assistant." +date: 2017-02-12 10:00 +sidebar: true +comments: false +sharing: true +footer: true +logo: google_maps.png +ha_release: 0.67 +ha_category: Presence Detection +ha_iot_class: "Cloud Polling" +--- + +The `google_maps` platform allows you to detect presence using the unofficial API of [Google Maps Location Sharing](https://myaccount.google.com/locationsharing). + +You first need to create an additional Google account and share your location with that account. This platform will use that account to fetch the location of your device(s). You have to setup sharing through the Google Maps app on your mobile phone. You can find more information [here](https://support.google.com/accounts?p=location_sharing). + +This platform will create a file named `google_maps_location_sharing.conf` where it caches your login session. + +

+Since this platform is using an unofficial API with the help of [locationsharinglib](https://github.com/costastf/locationsharinglib), Google seems to block access to your data the first time you've logged in with this component. +This issue can be fixed by logging in with your new account and approving your login on the [Device Activity](https://myaccount.google.com/device-activity) page. +

+ +To integrate Google Maps Location Sharing in Home Assistant, add the following section to your `configuration.yaml` file: + +```yaml +# Example configuration.yaml entry +device_tracker: + - platform: google_maps + username: YOUR_USERNAME + password: YOUR_PASSWORD +``` + +{% configuration %} +username: + description: The email address for the Google account that has access to your shared location. + required: true + type: string +password: + description: The password for your given username. + required: true + type: string +{% endconfiguration %} diff --git a/source/_components/device_tracker.gpslogger.markdown b/source/_components/device_tracker.gpslogger.markdown index 3b1bbb3320..4c2889a94b 100644 --- a/source/_components/device_tracker.gpslogger.markdown +++ b/source/_components/device_tracker.gpslogger.markdown @@ -1,7 +1,7 @@ --- layout: page title: "GPSLogger" -description: "Instructions how to use GPSLogger to track devices in Home Assistant." +description: "Instructions on how to use GPSLogger to track devices in Home Assistant." date: 2016-11-25 15:00 sidebar: true comments: false diff --git a/source/_components/device_tracker.huawei_router.markdown b/source/_components/device_tracker.huawei_router.markdown index 6c9647ac3c..92ee5c62d4 100644 --- a/source/_components/device_tracker.huawei_router.markdown +++ b/source/_components/device_tracker.huawei_router.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Huawei Router" -description: "Instructions how to integrate Huawei Routers into Home Assistant." +description: "Instructions on how to integrate Huawei Routers into Home Assistant." date: 2017-07-16 01:40 sidebar: true comments: false @@ -12,9 +12,12 @@ ha_category: Presence Detection ha_release: 0.51 --- -This component offers presence detection by looking at connected devices to a [Huawei router](http://m.huawei.com/enmobile/enterprise/products/network/access/pon-one/hw-371813.htm). +The `huawei` device trakcer platform offers presence detection by looking at connected devices to a [Huawei router](http://m.huawei.com/enmobile/enterprise/products/network/access/pon-one/hw-371813.htm). + Currently, this was only tested with the Huawei HG8247H and HG8247Q Smart Router (used by Vodafone Portugal). +## {% linkable_title Configuration %} + To use a Huawei router in your installation, add the following to your `configuration.yaml` file: ```yaml @@ -22,15 +25,23 @@ To use a Huawei router in your installation, add the following to your `configur device_tracker: - platform: huawei_router host: 192.168.1.1 - username: user - password: pass + username: YOUR_USERNAME + password: YOUR_PASSWORD ``` -Configuration variables: - -- **host** (*Required*): The IP address of your router, e.g. 192.168.1.1. -- **username** (*Required*): The username to login into the router (the same used trough the router's web interface). -- **password** (*Required*): The password for the specified username. - +{% configuration %} +host: + description: The IP address of your router, e.g., 192.168.1.1. + required: true + type: string +username: + description: The username to login into the router (the same used trough the router's web interface). + required: true + type: string +password: + description: The password for the specified username. + required: true + type: string +{% endconfiguration %} See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked. diff --git a/source/_components/device_tracker.icloud.markdown b/source/_components/device_tracker.icloud.markdown index 74f22f02f6..a57ba44d4b 100644 --- a/source/_components/device_tracker.icloud.markdown +++ b/source/_components/device_tracker.icloud.markdown @@ -1,7 +1,7 @@ --- layout: page title: "iCloud" -description: "Instructions how to use iCloud to track devices in Home Assistant." +description: "Instructions on how to use iCloud to track devices in Home Assistant." date: 2015-12-15 1000 sidebar: true comments: false @@ -33,9 +33,11 @@ Configuration variables: - **username** (*Required*): The username for the iCloud account. - **password** (*Required*): The password for your given username. - **account_name** (*Optional*): The friendly name for the account_name. If this isn't given, it will use the account_name of the username (so the part before the `@` in the email address). +- **max_interval** (*Optional*): Maximum interval in minutes between subsequent location upates. This tracker uses dynamic intervals for requesting location updates. When iphone is stationary, interval will eventually be set to `max_interval` to save battery. When iphone starts moving again interval will be dynamically updated to 1 min. Note that updating interval to 1 min might be delayed by maximum `max_interval` minutes. Default is 30 min. Minimum value is 1 min. +- **gps_accuracy_threshold** (*Optional*): iCloud location updates come with some gps_accuracy varying from 10 to 5000 meters. This setting defines the accuracy threshold in meters for a location update. Less accurate updates will be discarded by this tracker. This allows more precise location monitoring and fewer false positive zone changes. Default is 1000 meters.

-This may cause battery drainage as it wakes up your device to get the current location. +Low `max_interval` may cause battery drainage as it wakes up your device to get the current location.

@@ -48,7 +50,7 @@ To disable the drainage of the battery, a dynamic interval is being used for eac 2 Factor Authentication is the improved version of 2 Steps Authentication, this is still not supported by the pyicloud library. Therefore it's not possible to use it with the device_tracker yet. 4 services are available for this component: -- **icloud_update**: This service can be used to ask for an update of a certain iDevice. The `account_name` and `device_name` are optional. +- **icloud_update**: This service can be used to ask for an update of a certain iDevice. The `account_name` and `device_name` are optional. Request will result in new Home Assistant [state_changed](/docs/configuration/events/#event-state_changed) event describing current iphone location. Can be used in automations when manual location update is needed, e.g. to check if anyone is home when door's been opened. - **icloud_lost_iphone**: This service will play the Lost iPhone sound on a certain iDevice. The `account_name` and `device_name` are optional. - **icloud_set_interval**: This service will change the dynamic interval of an iDevice. The `account_name` and `device_name` are optional. If `interval` is used in the service_data, the iDevice will be updated with that new interval. That interval will be fixed until the iDevice changes zone or if this service is called again. If `interval` isn't used in the service_data, the interval for that iDevice will revert back to its default dynamic interval based on its current zone, its distance towards home and its battery level. - **icloud_reset_account**: This service can be used to reset an iCloud account. This is helpful when not all devices are being found by the component or if you have added a new iDevice to your account. The `account_name` is optional. diff --git a/source/_components/device_tracker.keenetic_ndms2.markdown b/source/_components/device_tracker.keenetic_ndms2.markdown index 3dbd197b77..aec5ac8a52 100644 --- a/source/_components/device_tracker.keenetic_ndms2.markdown +++ b/source/_components/device_tracker.keenetic_ndms2.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Keenetic NDMS2 Routers" -description: "Instructions how to integrate Keenetic NDMS2 Routers into Home Assistant." +description: "Instructions on how to integrate Keenetic NDMS2 Routers into Home Assistant." date: 2017-09-15 15:40 sidebar: true comments: false @@ -28,7 +28,7 @@ device_tracker: Configuration variables: -- **host** (*Required*): The IP address of your router, e.g. 192.168.1.1. +- **host** (*Required*): The IP address of your router, e.g., 192.168.1.1. - **username** (*Required*): The username to login into the router (user should have read access to web interface of the router). - **password** (*Required*): The password for the specified username. - **interface** (*Optional*): Ihe internal name of the interface to get devices connected to. Default is 'Home'. For expert users only. diff --git a/source/_components/device_tracker.linksys_ap.markdown b/source/_components/device_tracker.linksys_ap.markdown index b9821eb522..6cdc3984b2 100644 --- a/source/_components/device_tracker.linksys_ap.markdown +++ b/source/_components/device_tracker.linksys_ap.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Linksys Access Points" -description: "Instructions how to integrate Linksys Access Points into Home Assistant." +description: "Instructions on how to integrate Linksys Access Points into Home Assistant." date: 2016-12-16 01:40 sidebar: true comments: false diff --git a/source/_components/device_tracker.linksys_smart.markdown b/source/_components/device_tracker.linksys_smart.markdown index 0e1827c680..4cf0ca7e5a 100644 --- a/source/_components/device_tracker.linksys_smart.markdown +++ b/source/_components/device_tracker.linksys_smart.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Linksys Smart Wifi Router" -description: "Instructions how to integrate Linksys Smart Wifi Router into Home Assistant." +description: "Instructions on how to integrate Linksys Smart Wifi Router into Home Assistant." date: 2017-06-22 01:40 sidebar: true comments: false diff --git a/source/_components/device_tracker.locative.markdown b/source/_components/device_tracker.locative.markdown index 2a185c924e..02d932a7a4 100644 --- a/source/_components/device_tracker.locative.markdown +++ b/source/_components/device_tracker.locative.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Locative" -description: "Instructions how to use Locative to track devices in Home Assistant." +description: "Instructions on how to use Locative to track devices in Home Assistant." date: 2015-10-13 19:00 sidebar: true comments: false diff --git a/source/_components/device_tracker.luci.markdown b/source/_components/device_tracker.luci.markdown index 32d0cde87b..621f70a905 100644 --- a/source/_components/device_tracker.luci.markdown +++ b/source/_components/device_tracker.luci.markdown @@ -1,7 +1,7 @@ --- layout: page title: "OpenWRT (luci)" -description: "Instructions how to integrate OpenWRT routers into Home Assistant." +description: "Instructions on how to integrate OpenWRT routers into Home Assistant." date: 2015-03-23 19:59 sidebar: true comments: false @@ -39,7 +39,7 @@ device_tracker: Configuration variables: -- **host** (*Required*): The IP address of your router, e.g. `192.168.1.1`. +- **host** (*Required*): The IP address of your router, e.g., `192.168.1.1`. - **username** (*Required*): The username of an user with administrative privileges, usually `admin`. - **password** (*Required*): The password for your given admin account. diff --git a/source/_components/device_tracker.markdown b/source/_components/device_tracker.markdown index 25e2961498..b595407d13 100644 --- a/source/_components/device_tracker.markdown +++ b/source/_components/device_tracker.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Device Tracker" -description: "Instructions how to setup device tracking within Home Assistant." +description: "Instructions on how to setup device tracking within Home Assistant." date: 2015-01-20 22:36 sidebar: true comments: false @@ -13,7 +13,7 @@ Home Assistant can get information from your wireless router or third party serv There are also trackers available which use different technologies like [MQTT](/components/mqtt/) or [Nmap](/components/device_tracker.nmap_tracker/) to scan the network for devices. -An [event](/getting-started/automation-trigger/#event-trigger) (`device_tracker_new_device`) will be fired when a device is discovered for the first time. +An [event](/getting-started/automation-trigger/#event-trigger) (`device_tracker_new_device`) will be fired when a device is discovered for the first time. ## {% linkable_title Configuring a `device_tracker` platform %} @@ -37,9 +37,13 @@ The following optional parameters can be used with any platform. However device | Parameter | Default | Description | |----------------------|---------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `interval_seconds` | 12 | Seconds between each scan for new devices | -| `consider_home` | 180 | Seconds to wait till marking someone as not home after not being seen. This parameter is most useful for households with Apple iOS devices that go into sleep mode while still at home to conserve battery life. iPhones will occasionally drop off the network and then re-appear. `consider_home` helps prevent false alarms in presence detection when using IP scanners such as Nmap. `consider_home` accepts various time representations, (E.g. the following all represents 3 minutes: `180`, `0:03`, `0:03:00`) | +| `consider_home` | 180 | Seconds to wait till marking someone as not home after not being seen. This parameter is most useful for households with Apple iOS devices that go into sleep mode while still at home to conserve battery life. iPhones will occasionally drop off the network and then re-appear. `consider_home` helps prevent false alarms in presence detection when using IP scanners such as Nmap. `consider_home` accepts various time representations, (e.g., the following all represents 3 minutes: `180`, `0:03`, `0:03:00`) | | `new_device_defaults`| | Default values for new discovered devices. Available options `track_new_devices` (default: `True`), `hide_if_away` (default: `False`) | +

+ Note that setting `track_new_devices: False` will still result in new devices being recorded in `known_devices.yaml`, but they won't be tracked (`track: no`). +

+ The extended example from above would look like the following sample: ```yaml @@ -65,7 +69,7 @@ Here's an example configuration for a single device: devicename: name: Friendly Name mac: EA:AA:55:E7:C6:94 - picture: https://home-assistant.io/images/favicon-192x192.png + picture: https://www.home-assistant.io/images/favicon-192x192.png track: yes hide_if_away: no ``` diff --git a/source/_components/device_tracker.meraki.markdown b/source/_components/device_tracker.meraki.markdown index a88aa1d713..cbe481d39e 100644 --- a/source/_components/device_tracker.meraki.markdown +++ b/source/_components/device_tracker.meraki.markdown @@ -11,8 +11,21 @@ logo: meraki.png ha_category: Presence Detection ha_release: "0.60" --- -Use your `Meraki AP` as device tracker. Note that Meraki will see all devices, not only connected to the network. -Follow instructions [here](https://meraki.cisco.com/technologies/location-analytics-api) how to enable Location Analytics. + +Use your Meraki AP as device tracker. Note that Meraki will see all devices, not only connected to the network. + +### {% linkable_title Prerequisites %} + +1. Go to Network-wide/General page, and find the Location and scanning section. +1. Make sure analytics and Scanning API are both enabled. +1. Make note of the Validator string, which will be used in the `device_tracker` configuration. +1. Click **Add a Post URL**: + 1. Set the Post URL to `https://YOUR_HOSTNAME/api/meraki?api_password=YOUR_HASS_PASSWORD` + 1. Set the Secret to a randomly generated string, and make note of it for the `device_tracker` configuration. + 1. Make sure the API Version is set to `2.0`. + 1. Hit **Save** in the bottom right of the page. + +## {% linkable_title Configuration %} After you configure access to the Meraki CMX API, add the following to your `configuration.yaml` file: @@ -24,14 +37,13 @@ device_tracker: validator: meraki_validator ``` - {% configuration %} secret: - description: Secret code added in Meraki + description: Secret code added in Meraki. required: true type: string validator: - description: Validation string from Meraki + description: Validation string from Meraki. required: true type: string {% endconfiguration %} diff --git a/source/_components/device_tracker.mikrotik.markdown b/source/_components/device_tracker.mikrotik.markdown index e3e49c4846..da1dceee4d 100644 --- a/source/_components/device_tracker.mikrotik.markdown +++ b/source/_components/device_tracker.mikrotik.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Mikrotik" -description: "Instructions how to integrate Mikrotik/Routerboard based routers into Home Assistant." +description: "Instructions on how to integrate Mikrotik/Routerboard based routers into Home Assistant." date: 2017-04-28 16:03 sidebar: true comments: false diff --git a/source/_components/device_tracker.mqtt.markdown b/source/_components/device_tracker.mqtt.markdown index d60b895c50..3640b8ad5a 100644 --- a/source/_components/device_tracker.mqtt.markdown +++ b/source/_components/device_tracker.mqtt.markdown @@ -1,7 +1,7 @@ --- layout: page title: "MQTT Device Tracker" -description: "Instructions how to use MQTT to track devices in Home Assistant." +description: "Instructions on how to use MQTT to track devices in Home Assistant." date: 2015-09-19 20:41 sidebar: true comments: false @@ -32,7 +32,7 @@ Configuration variables: - **qos** (*Optional*): The QoS level of the topic. -Example JSON you can publish to the topic (e.g. via mqtt.publish service): +Example JSON you can publish to the topic (e.g., via mqtt.publish service): ```json { diff --git a/source/_components/device_tracker.mqtt_json.markdown b/source/_components/device_tracker.mqtt_json.markdown index d7a515588c..a6cbc50b87 100644 --- a/source/_components/device_tracker.mqtt_json.markdown +++ b/source/_components/device_tracker.mqtt_json.markdown @@ -1,7 +1,7 @@ --- layout: page title: "JSON MQTT Device Tracker" -description: "Instructions how to use JSON MQTT to track devices in Home Assistant." +description: "Instructions on how to use JSON MQTT to track devices in Home Assistant." date: 2017-04-12 20:41 sidebar: true comments: false diff --git a/source/_components/device_tracker.mysensors.markdown b/source/_components/device_tracker.mysensors.markdown index 14db68931a..5366c68ea7 100644 --- a/source/_components/device_tracker.mysensors.markdown +++ b/source/_components/device_tracker.mysensors.markdown @@ -1,7 +1,7 @@ --- layout: page title: "MySensors Device Tracker" -description: "Instructions how to use MySensors to track devices in Home Assistant." +description: "Instructions on how to use MySensors to track devices in Home Assistant." date: 2017-02-06 15:00 +0100 sidebar: true comments: false diff --git a/source/_components/device_tracker.netgear.markdown b/source/_components/device_tracker.netgear.markdown index 70dbbce102..8bdcacc8cd 100644 --- a/source/_components/device_tracker.netgear.markdown +++ b/source/_components/device_tracker.netgear.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Netgear" -description: "Instructions how to integrate Netgear routers into Home Assistant." +description: "Instructions on how to integrate Netgear routers into Home Assistant." date: 2015-03-23 19:59 sidebar: true comments: false @@ -13,7 +13,6 @@ ha_iot_class: "Local Polling" ha_release: pre 0.7 --- - This platform allows you to detect presence by looking at connected devices to a [Netgear](http://www.netgear.com/) device. To use this device tracker in your installation, add the following to your `configuration.yaml` file: @@ -29,10 +28,18 @@ device_tracker: Configuration variables: -- **host** (*Optional*): The IP address of your router, e.g. `192.168.1.1`. If not provided `routerlogin.net` will be used. -- **username** (*Optional*): The username of an user with administrative privileges. If not provided `admin` will be used. -- **port** (*Optional*): The port your router communicates with (defaults to `5000`, but `80` is also known to be used on some models). +- **url** (*Optional*): The base URL, e.g., `http://routerlogin.com:5000` for example. If not provided `host` and `port` are used. If none provided autodetection of the URL will be used. +- **host** (*Optional*): The IP address of your router, e.g., `192.168.1.1`. +- **port** (*Optional*): The port your router communicates with. +- **username** (*Optional*): The username of a user with administrative privileges. If not provided `admin` will be used. - **password** (*Required*): The password for your given admin account. +- **devices** (*Optional*): If provided only specified devices will be reported. Can be MAC address or the device name as reported in the Netgear UI. +- **exclude** (*Optional*): Devices to exclude from the scan. +- **accesspoints** (*Optional*): Also track devices on the specified APs. Only supports MAC address. + +When `accesspoints` is specified an extra device will be reported for each device connected to the APs specified here, as `MY-LAPTOP on RBS40`. `Router` will be reported as AP name for the main AP. Only tested with Orbi. + +The use of `devices` or `exclude` is recommended when using `accesspoints` to avoid having a lot of entries. List of models that are known to use port 80: - Nighthawk X4S - AC2600 (R7800) diff --git a/source/_components/device_tracker.nmap_tracker.markdown b/source/_components/device_tracker.nmap_tracker.markdown index 0ce79dfc3a..74ace37e23 100644 --- a/source/_components/device_tracker.nmap_tracker.markdown +++ b/source/_components/device_tracker.nmap_tracker.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Nmap" -description: "Instructions how to integrate Nmap into Home Assistant." +description: "Instructions on how to integrate Nmap into Home Assistant." date: 2015-03-23 19:59 sidebar: true comments: false diff --git a/source/_components/device_tracker.owntracks.markdown b/source/_components/device_tracker.owntracks.markdown index 631d8dc669..a852ff2e50 100644 --- a/source/_components/device_tracker.owntracks.markdown +++ b/source/_components/device_tracker.owntracks.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Owntracks" -description: "Instructions how to use Owntracks to track devices in Home Assistant." +description: "Instructions on how to use Owntracks to track devices in Home Assistant." date: 2015-09-22 07:00 sidebar: true comments: false @@ -13,13 +13,8 @@ featured: false ha_release: 0.7.4 --- - This platform allows you to detect presence using [Owntracks](http://owntracks.org/). OwnTracks allows users to track their location on iOS phones and publish it to an MQTT broker. This platform will connect to the broker and monitor for new locations. -

-The Android app for OwnTracks is no longer developed or supported, Zanzito is a drop in replacement for OwnTracks MQTT. -

- This component requires [the MQTT component](/components/mqtt/) to be set up and works very well together with [the zone component](/components/zone/). To integrate Owntracks in Home Assistant, add the following section to your `configuration.yaml` file: @@ -34,7 +29,7 @@ Configuration variables: - **max_gps_accuracy** (*Optional*): Sometimes Owntracks can report GPS location with a very low accuracy (few kilometers). That can trigger false zoning in your Home Assistant installation. With the parameter, you can filter these GPS reports. The number has to be in meter. For example, if you put 200 only GPS report with an accuracy under 200 will be take in account. - **waypoints** (*Optional*): Owntracks users can define [waypoints](http://owntracks.org/booklet/features/waypoints/) (a.k.a regions) which are similar in spirit to Home Assistant zones. If this configuration variable is `True`, the Owntracks users who are in `waypoint_whitelist` can export waypoints from the device and Home Assistant will import them as zone definitions. Defaults to `True`. -- **waypoint_whitelist** (*Optional*): A list of user names (as defined for [Owntracks](/components/device_tracker.owntracks/)) who can export their waypoints from Owntracks to Home Assistant. This would be the `username` portion of the Base Topic Name, (e.g. owntracks/**username**/iPhone). Defaults to all users who are connected to Home Assistant via Owntracks. +- **waypoint_whitelist** (*Optional*): A list of user names (as defined for [Owntracks](/components/device_tracker.owntracks/)) who can export their waypoints from Owntracks to Home Assistant. This would be the `username` portion of the Base Topic Name, (e.g., owntracks/**username**/iPhone). Defaults to all users who are connected to Home Assistant via Owntracks. - **secret** (*Optional*): [Payload encryption key](http://owntracks.org/booklet/features/encrypt/). This is usable when communicating with a third-party untrusted server or a public server (where anybody can subscribe to any topic). By default the payload is assumed to be unencrypted (although the communication between Home Assistant and the server might still be encrypted). This feature requires the `libsodium` library to be present. - **mqtt_topic** (*Optional*): The topic to subscribe for Owntracks updates on your MQTT instance (defaults to `owntracks/#`). - **events_only** (*Optional*): Home Assistant will ignore all location updates and rely solely on geofence enter/leave events. @@ -59,6 +54,7 @@ device_tracker: ``` ### {% linkable_title Using Owntracks with other device trackers %} + Owntracks can also be used with other device trackers, such as [Nmap](/components/device_tracker.nmap_tracker/) or [Netgear](/components/device_tracker.netgear/). To do this, fill in the `mac` field to the Owntracks entry in `known_devices.yaml` with the MAC address of the device you want to track. This way the state of the device will be determined by the source that reported last. The naming convention for known device list is `_` and could be set in app configuration. More details about this config can found in [device tracker](/components/device_tracker/). An example showing the inclusion of the `mac` field for multiple component tracking. The `mac` field will need to be added to the `owntracks` device and will enable tracking by all components that track via the `mac` address. @@ -67,13 +63,14 @@ An example showing the inclusion of the `mac` field for multiple component track USERNAME_DEVICE_ID: name: Friendly Name mac: EA:AA:55:E7:C6:94 - picture: https://home-assistant.io/images/favicon-192x192.png + picture: https://www.home-assistant.io/images/favicon-192x192.png gravatar: test@example.com track: yes hide_if_away: no ``` ### {% linkable_title Using Owntracks regions %} + Owntracks can track regions, and send region entry and exit information to Home Assistant (HA). You set up a region in the Owntracks app which you should name the same as your HA Zone, and then make sure to turn on the `share` option for the region in the owntracks app. Please see the [owntracks documentation](http://owntracks.org/booklet/guide/waypoints/). Home Assistant will use the enter and leave messages to set your zone location. Your location will be set to the center of zone when you enter. Location updates from OwnTracks will be ignored while you are inside a zone. @@ -81,6 +78,7 @@ Home Assistant will use the enter and leave messages to set your zone location. When you exit a zone, Home Assistant will start using location updates to track you again. To make sure that Home Assistant correctly exits a zone (which it calculates based on your GPS coordinates), you may want to set your Zone radius in HA to be slightly smaller that the Owntracks region radius. ### {% linkable_title Using Owntracks regions - forcing Owntracks to update using %}iBeacons + When run in the usual *significant changes mode* (which is kind to your phone battery), Owntracks sometimes doesn't update your location as quickly as you'd like when you arrive at a zone. This can be annoying if you want to trigger an automation when you get home. You can improve the situation using iBeacons. iBeacons are simple Bluetooth devices that send out an "I'm here" message. They are supported by IOS and some Android devices. Owntracks explain more [here](http://owntracks.org/booklet/guide/beacons/). @@ -92,6 +90,7 @@ When you exit an iBeacon region HA will switch back to using GPS to determine yo Sometimes Owntracks will lose connection with an iBeacon for a few seconds. If you name your beacon starting with `-` Owntracks will wait longer before deciding it has exited the beacon zone. HA will ignore the `-` when it matches the Owntracks region with Zones. So if you call your Owntracks region `-home` then HA will recognize it as `home`, but you will have a more stable iBeacon connection. ### {% linkable_title Using Owntracks iBeacons to track devices %} + iBeacons don't need to be stationary. You could put one on your key ring, or in your car. When your phone sees a mobile iBeacon that it knows about, it will tell HA the location of that iBeacon. If your phone moves while you are connected to the iBeacon, HA will update the location of the iBeacon. But when your phone loses the connection, HA will stop updating the iBeacon location. @@ -101,9 +100,11 @@ To use mobile iBeacons with HA, you just set up a region that doesn't match your This allows you to write zone automations for devices that can't track themselves (for example *alert me if I leave the house and my keys are still at home*). Another example would be *open the gates if my car arrives home*. ### {% linkable_title Using mobile and fixed iBeacons together %} + You can use iBeacons of both types together, so if you have a Zone `drive` with an iBeacon region called `-drive` and you arrive home with a mobile iBeacon called `-car`, then `device_tracker.beacon_car` will be set to a state of `drive`. ### {% linkable_title Importing Owntracks waypoints as zones %} + By default, any Owntracks user connected to Home Assistant can export their waypoint definitions (from the *Export - Export to Endpoint* menu item) which will then be translated to zone definitions in Home Assistant. The zones will be named `- - `. This functionality can be controlled in 2 ways: 1. The configuration variable `waypoints` can be set to `False` which will disable importing waypoints for all users. diff --git a/source/_components/device_tracker.owntracks_http.markdown b/source/_components/device_tracker.owntracks_http.markdown index 7e91746e55..64df68dd04 100644 --- a/source/_components/device_tracker.owntracks_http.markdown +++ b/source/_components/device_tracker.owntracks_http.markdown @@ -1,7 +1,7 @@ --- layout: page title: "OwnTracks (via HTTP)" -description: "Instructions how to use Owntracks via HTTP to track devices in Home Assistant." +description: "Instructions on how to use Owntracks via HTTP to track devices in Home Assistant." date: 2017-09-28 07:00 sidebar: true comments: false @@ -32,5 +32,21 @@ Open OwnTracks and go to Connection preferences: - Mode: Select **Private HTTP** - Host: [Home Assistant URL]:[port]/api/owntracks/[your name]/[device name] - Identification: Turn **Authentication** on, username `homeassistant` and password is your API password that you use to login to Home Assistant. - + Host example: If I host my Home Assistant at `https://example.duckdns.org`, my name is Paulus and my phone is a Pixel I would set the host to be `https://example.duckdns.org/api/owntracks/paulus/pixel`. This will result in an entity with an ID of `device_tracker.paulus_pixel`. You can pick any name for the user and the device. + +Since the battery data is available as an attribute of the device tracker entity, it can be tracked with a [`template` sensor](/components/sensor.template/). + +{% raw %} +```yaml +# Example configuration.yaml entry +sensor: + - platform: template + sensors: + pixel_battery: + friendly_name: Pixel of Paulus + unit_of_measurement: "%" + value_template: '{{ states.device_tracker.paulus_pixel.attributes.battery|int }}' + device_class: battery +``` +{% endraw %} diff --git a/source/_components/device_tracker.ping.markdown b/source/_components/device_tracker.ping.markdown index 7979881198..1f34368012 100644 --- a/source/_components/device_tracker.ping.markdown +++ b/source/_components/device_tracker.ping.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Ping (ICMP)" -description: "Instructions how to integrate Ping (ICMP)-based presence detection into Home Assistant." +description: "Instructions on how to integrate Ping (ICMP)-based presence detection into Home Assistant." date: 2017-01-06 08:00 sidebar: true comments: false diff --git a/source/_components/device_tracker.sky_hub.markdown b/source/_components/device_tracker.sky_hub.markdown index e5a1271894..792aece8a8 100644 --- a/source/_components/device_tracker.sky_hub.markdown +++ b/source/_components/device_tracker.sky_hub.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Sky Hub" -description: "Instructions how to integrate Sky Hub routers into Home Assistant." +description: "Instructions on how to integrate Sky Hub routers into Home Assistant." date: 2017-01-28 09:00 sidebar: true comments: false diff --git a/source/_components/device_tracker.snmp.markdown b/source/_components/device_tracker.snmp.markdown index 60c14a1f87..8193abfee8 100644 --- a/source/_components/device_tracker.snmp.markdown +++ b/source/_components/device_tracker.snmp.markdown @@ -1,7 +1,7 @@ --- layout: page title: "SNMP" -description: "Instructions how to integrate SNMP into Home Assistant." +description: "Instructions on how to integrate SNMP into Home Assistant." date: 2015-10-08 12:00 sidebar: true comments: false diff --git a/source/_components/device_tracker.swisscom.markdown b/source/_components/device_tracker.swisscom.markdown index bee21be205..49c4f72ba9 100644 --- a/source/_components/device_tracker.swisscom.markdown +++ b/source/_components/device_tracker.swisscom.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Swisscom Internet-Box" -description: "Instructions how to integrate Swisscom Internet-Box into Home Assistant." +description: "Instructions on how to integrate Swisscom Internet-Box into Home Assistant." date: 2016-10-29 23:30 sidebar: true comments: false diff --git a/source/_components/device_tracker.tado.markdown b/source/_components/device_tracker.tado.markdown index bc1d91b37b..70f130c7e0 100644 --- a/source/_components/device_tracker.tado.markdown +++ b/source/_components/device_tracker.tado.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Tado" -description: "Instructions how to integrate Tado into Home Assistant." +description: "Instructions on how to integrate Tado into Home Assistant." date: 2017-01-17 12:00 sidebar: true comments: false diff --git a/source/_components/device_tracker.thomson.markdown b/source/_components/device_tracker.thomson.markdown index f9d39eb6d7..810d586d27 100644 --- a/source/_components/device_tracker.thomson.markdown +++ b/source/_components/device_tracker.thomson.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Thomson" -description: "Instructions how to integrate Thomson routers into Home Assistant." +description: "Instructions on how to integrate Thomson routers into Home Assistant." date: 2015-08-30 19:00 sidebar: true comments: false diff --git a/source/_components/device_tracker.tile.markdown b/source/_components/device_tracker.tile.markdown index 63ba3d693c..8abb07a676 100644 --- a/source/_components/device_tracker.tile.markdown +++ b/source/_components/device_tracker.tile.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Tile" -description: "Instructions how to use Tile to track devices in Home Assistant." +description: "Instructions on how to use Tile to track devices in Home Assistant." date: 2017-11-08 20:40:00 sidebar: true comments: false diff --git a/source/_components/device_tracker.tomato.markdown b/source/_components/device_tracker.tomato.markdown index 3c5eca66ca..279cd63b68 100644 --- a/source/_components/device_tracker.tomato.markdown +++ b/source/_components/device_tracker.tomato.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Tomato" -description: "Instructions how to integrate Tomato routers into Home Assistant." +description: "Instructions on how to integrate Tomato routers into Home Assistant." date: 2015-03-23 19:59 sidebar: true comments: false @@ -31,11 +31,11 @@ device_tracker: {% configuration %} host: - description: "The IP address or hostname of your router, e.g. `192.168.1.1` or `rt-ac68u`." + description: "The IP address or hostname of your router, e.g., `192.168.1.1` or `rt-ac68u`." required: false type: string port: - description: "The port number of your router, e.g. `443`." + description: "The port number of your router, e.g., `443`." required: false type: int default: 80/443 (automatically detected) @@ -45,7 +45,7 @@ ssl: type: bool default: false verify_ssl: - description: "If SSL verification for https resources needs to be turned off (for self-signed certs, etc.) this can take on boolean values `False` or `True` or you can pass a location on the device where a certificate can be used for verification e.g. `/mnt/NAS/router_cert.pem`." + description: "If SSL verification for https resources needs to be turned off (for self-signed certs, etc.) this can take on boolean values `False` or `True` or you can pass a location on the device where a certificate can be used for verification e.g., `/mnt/NAS/router_cert.pem`." required: false type: [string, bool] default: true diff --git a/source/_components/device_tracker.tplink.markdown b/source/_components/device_tracker.tplink.markdown index 89897bb1e0..29b70a143a 100644 --- a/source/_components/device_tracker.tplink.markdown +++ b/source/_components/device_tracker.tplink.markdown @@ -1,7 +1,7 @@ --- layout: page title: "TP-Link" -description: "Instructions how to integrate TP-Link routers into Home Assistant." +description: "Instructions on how to integrate TP-Link routers into Home Assistant." date: 2015-06-22 10:30 sidebar: true comments: false @@ -31,7 +31,7 @@ device_tracker: Configuration variables: -- **host** (*Required*): The IP address of your router, e.g. 192.168.1.1. +- **host** (*Required*): The IP address of your router, e.g., 192.168.1.1. - **username** (*Required*: The username of an user with administrative privileges, usually *admin*. - **password** (*Required*): The password for your given admin account. @@ -41,7 +41,7 @@ For Archer C9 models running firmware version 150811 or later please use the enc 2. Type in the password you use to login into the password field. 3. Click somewhere else on the page so that the password field is not selected anymore. 4. Open the JavaScript console of your browser (usually by pressing F12 and then clicking on "Console"). -5. Type ```document.getElementById("login-password").value;```. +5. Type `document.getElementById("login-password").value;` or `document.getElementById("pcPassword").value;`, depending on your firmware version. 6. Copy the returned value to your Home Assistant configuration as password. See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked. diff --git a/source/_components/device_tracker.trackr.markdown b/source/_components/device_tracker.trackr.markdown index 6337b8f787..962300ed1e 100644 --- a/source/_components/device_tracker.trackr.markdown +++ b/source/_components/device_tracker.trackr.markdown @@ -1,7 +1,7 @@ --- layout: page title: "TrackR" -description: "Instructions how to use TrackR to track devices in Home Assistant." +description: "Instructions on how to use TrackR to track devices in Home Assistant." date: 2016-12-22 1000 sidebar: true comments: false @@ -24,11 +24,18 @@ To integrate TrackR in Home Assistant, add the following section to your `config # Example configuration.yaml entry device_tracker: platform: trackr - username: USERNAME - password: PASSWORD + username: YOUR_USERNAME + password: YOUR_PASSWORD ``` -Configuration variables: +{% configuration %} +username: + description: The email address for the TrackR account. + required: true + type: string +password: + description: The password for your given username. + required: true + type: string +{% endconfiguration %} -- **username** (*Required*): The email address for the TrackR account. -- **password** (*Required*): The password for your given username. diff --git a/source/_components/device_tracker.ubus.markdown b/source/_components/device_tracker.ubus.markdown index 646ae0b2c1..3df045db24 100644 --- a/source/_components/device_tracker.ubus.markdown +++ b/source/_components/device_tracker.ubus.markdown @@ -1,7 +1,7 @@ --- layout: page title: "OpenWRT (ubus)" -description: "Instructions how to integrate OpenWRT routers into Home Assistant." +description: "Instructions on how to integrate OpenWRT routers into Home Assistant." date: 2015-03-23 19:59 sidebar: true comments: false diff --git a/source/_components/device_tracker.unifi.markdown b/source/_components/device_tracker.unifi.markdown index bac8fe43be..e941066770 100644 --- a/source/_components/device_tracker.unifi.markdown +++ b/source/_components/device_tracker.unifi.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Ubiquiti Unifi WAP" -description: "Instructions how to use a Unifi WAP controller as a device tracker module." +description: "Instructions on how to use a Unifi WAP controller as a device tracker module." date: 2016-02-19 20:59 sidebar: true comments: false @@ -80,7 +80,7 @@ The Unifi controller allows you to create multiple users on it besides the main The Unifi controller can either be a dedicated hardware device (Unifi's cloud key), or as software any Linux system. If you run the the Unifi controller on the same operating system as Home Assistant there may be conflicts in ports if you have the MQTT component as well. -It is recommended that you run the Unifi controller in a dedicate virtual machine to avoid that situation. +It is recommended that you run the Unifi controller in a dedicated virtual machine to avoid that situation. ### {% linkable_title Troubleshooting and Time Synchronization %} diff --git a/source/_components/device_tracker.unifi_direct.markdown b/source/_components/device_tracker.unifi_direct.markdown index 8c0bda46b8..4816832b8e 100644 --- a/source/_components/device_tracker.unifi_direct.markdown +++ b/source/_components/device_tracker.unifi_direct.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Ubiquiti Unifi direct AP" -description: "Instructions how to use a Unifi WAP as a device tracker." +description: "Instructions on how to use a Unifi WAP as a device tracker." date: 2017-11-17 14:59 sidebar: true comments: false @@ -13,7 +13,7 @@ ha_release: 0.59 --- -This platform allows you to detect presence by looking at devices connected to a [UniFi AP](https://www.ubnt.com/products/#unifi). This device tracker differs form [Ubiquiti Unifi WAP](https://home-assistant.io/components/device_tracker.unifi/) because it doesn't require the Unifi controller software. +This platform allows you to detect presence by looking at devices connected to a [UniFi AP](https://www.ubnt.com/products/#unifi). This device tracker differs form [Ubiquiti Unifi WAP](/components/device_tracker.unifi/) because it doesn't require the Unifi controller software. To use this device tracker in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/device_tracker.upc_connect.markdown b/source/_components/device_tracker.upc_connect.markdown index ca0a7e57b2..1f77bc8d86 100644 --- a/source/_components/device_tracker.upc_connect.markdown +++ b/source/_components/device_tracker.upc_connect.markdown @@ -1,7 +1,7 @@ --- layout: page title: "UPC ConnectBox" -description: "Instructions how to integrate UPC ConnectBox into Home Assistant." +description: "Instructions on how to integrate UPC ConnectBox into Home Assistant." date: 2016-12-30 00:00 sidebar: true comments: false diff --git a/source/_components/device_tracker.xiaomi.markdown b/source/_components/device_tracker.xiaomi.markdown index 9a8f6a43fd..d38571007c 100644 --- a/source/_components/device_tracker.xiaomi.markdown +++ b/source/_components/device_tracker.xiaomi.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Xiaomi Router" -description: "Instructions how to integrate Xiaomi routers into Home Assistant." +description: "Instructions on how to integrate Xiaomi routers into Home Assistant." date: 2017-01-12 12:04 sidebar: true comments: false diff --git a/source/_components/device_tracker.xiaomi_miio.markdown b/source/_components/device_tracker.xiaomi_miio.markdown new file mode 100644 index 0000000000..ae60404393 --- /dev/null +++ b/source/_components/device_tracker.xiaomi_miio.markdown @@ -0,0 +1,38 @@ +--- +layout: page +title: "Xiaomi Mi WiFi Repeater 2" +description: "Instructions how to integrate your Xiaomi Mi WiFi Repeater 2 within Home Assistant." +date: 2018-04-01 21:06 +sidebar: true +comments: false +sharing: true +footer: true +logo: xiaomi.png +ha_category: Presence Detection +ha_version: 0.67 +ha_iot_class: "Local Polling" +--- + +The `xiaomi_miio` device tracker platform is observing your Xiaomi Mi WiFi Repeater 2 and reporting all associated WiFi clients. + +Please follow the instructions on [Retrieving the Access Token](/components/vacuum.xiaomi_miio/#retrieving-the-access-token) to get the API token. + +To add a Xiaomi Mi Air Quality Monitor to your installation, add the following to your `configuration.yaml` file: + +```yaml +device_tracker: + - platform: xiaomi_miio + host: 192.168.130.73 + token: YOUR_TOKEN +``` + +{% configuration %} +host: + description: The IP address of your miio device. + required: true + type: string +token: + description: The API token of your miio device. + required: true + type: string +{% endconfiguration %} diff --git a/source/_components/dialogflow.markdown b/source/_components/dialogflow.markdown index a034f72e28..bf2cc4b4e6 100644 --- a/source/_components/dialogflow.markdown +++ b/source/_components/dialogflow.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Dialogflow" -description: "Instructions how integrate Dialogflow with Home Assistant." +description: "Instructions on how integrate Dialogflow with Home Assistant." date: 2017-01-27 11:28 sidebar: true comments: false @@ -47,10 +47,10 @@ To use this integration, you should define a conversation (intent) in Dialogflow - Select name, language (if you are planning to use Google Actions check their [supported languages](https://support.google.com/assistant/answer/7108196?hl=en)) and time zone - Click "Save" - Go to "Fulfillment" (in the left menu) -- Enable Webhook and set your Home Assistant URL with the Dialogflow endpoint, e.g. `https://myhome.duckdns.org/api/dialogflow?api_password=HA_PASSWORD` +- Enable Webhook and set your Home Assistant URL with the Dialogflow endpoint, e.g., `https://myhome.duckdns.org/api/dialogflow?api_password=HA_PASSWORD` - Click "Save" - Create a new intent -- Below "User says" write one phrase that you, the user, will tell Dialogflow, e.g. `What is the temperature at home?` +- Below "User says" write one phrase that you, the user, will tell Dialogflow, e.g., `What is the temperature at home?` - In "Action" set some key (this will be the bind with Home Assistant configuration), eg.: GetTemperature - In "Response" set "Cannot connect to Home Assistant or it is taking to long" (fall back response) - At the end of the page, click on "Fulfillment" and check "Use webhook" diff --git a/source/_components/digital_ocean.markdown b/source/_components/digital_ocean.markdown index c2e26b9aa3..4554819ee2 100644 --- a/source/_components/digital_ocean.markdown +++ b/source/_components/digital_ocean.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Digital Ocean" -description: "Instructions how to integrate the Digital Ocean within Home Assistant." +description: "Instructions on how to integrate the Digital Ocean within Home Assistant." date: 2016-09-24 20:00 sidebar: true comments: false diff --git a/source/_components/discoverable.markdown b/source/_components/discoverable.markdown index 19c16ce0ac..12c170a1ee 100644 --- a/source/_components/discoverable.markdown +++ b/source/_components/discoverable.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Discoverable" -description: "Instructions how to setup the discoverable component with Home Assistant." +description: "Instructions on how to setup the discoverable component with Home Assistant." date: 2016-03-01 07:00 sidebar: true comments: false @@ -23,7 +23,7 @@ for state in hass.states(): To enable `discovery` in your installation, add the following to your `configuration.yaml` file: ```yaml -# Example configuration.yml entry +# Example configuration.yaml entry discoverable: expose_password: yes ``` diff --git a/source/_components/discovery.markdown b/source/_components/discovery.markdown index f08c530620..f369ce67c1 100644 --- a/source/_components/discovery.markdown +++ b/source/_components/discovery.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Discovery" -description: "Instructions how to setup Home Assistant to discover new devices." +description: "Instructions on how to setup Home Assistant to discover new devices." date: 2015-01-24 14:39 sidebar: true comments: false @@ -14,31 +14,32 @@ ha_category: Other Home Assistant can discover and automatically configure [zeroconf](https://en.wikipedia.org/wiki/Zero-configuration_networking)/[mDNS](https://en.wikipedia.org/wiki/Multicast_DNS) and [uPnP](https://en.wikipedia.org/wiki/Universal_Plug_and_Play) devices on your network. Currently the `discovery` component can detect: - * [Apple TV](https://home-assistant.io/components/apple_tv/) - * [Axis Communications security devices](https://home-assistant.io/components/axis/) - * [Belkin WeMo switches](https://home-assistant.io/components/wemo/) - * [Bluesound speakers](https://home-assistant.io/components/media_player.bluesound/) - * [Bose Soundtouch speakers](https://home-assistant.io/components/media_player.soundtouch/) - * [Denon network receivers](https://home-assistant.io/components/media_player.denonavr/) - * [DirecTV receivers](https://home-assistant.io/components/media_player.directv/) - * [Frontier Silicon internet radios](https://home-assistant.io/components/media_player.frontier_silicon/) - * [Google Cast](https://home-assistant.io/components/media_player.cast/) - * [IKEA Trådfri (Tradfri)](https://home-assistant.io/components/tradfri/) - * [Linn / Openhome](https://home-assistant.io/components/media_player.openhome/) - * [Logitech Harmony Hub](https://home-assistant.io/components/remote.harmony/) - * [Logitech media server (Squeezebox)](https://home-assistant.io/components/media_player.squeezebox/) - * [Netgear routers](https://home-assistant.io/components/device_tracker.netgear/) - * [Panasonic Viera](https://home-assistant.io/components/media_player.panasonic_viera/) - * [Philips Hue](https://home-assistant.io/components/light.hue/) - * [Plex media server](https://home-assistant.io/components/media_player.plex/) - * [Roku media player](https://home-assistant.io/components/media_player.roku/) - * [SABnzbd downloader](https://home-assistant.io/components/sensor.sabnzbd/) - * [Samsung TVs](https://home-assistant.io/components/media_player.samsungtv/) - * [Sonos speakers](https://home-assistant.io/components/media_player.sonos/) - * [Telldus Live](https://home-assistant.io/components/tellduslive/) - * [Wink](https://home-assistant.io/components/wink/) - * [Yamaha media player](https://home-assistant.io/components/media_player.yamaha/) - * [Yeelight Sunflower bulb](https://home-assistant.io/components/light.yeelightsunflower/) + * [Apple TV](/components/apple_tv/) + * [Axis Communications security devices](/components/axis/) + * [Belkin WeMo switches](/components/wemo/) + * [Bluesound speakers](/components/media_player.bluesound/) + * [Bose Soundtouch speakers](/components/media_player.soundtouch/) + * [Denon network receivers](/components/media_player.denonavr/) + * [DirecTV receivers](/components/media_player.directv/) + * [Frontier Silicon internet radios](/components/media_player.frontier_silicon/) + * [Google Cast](/components/media_player.cast/) + * [HomeKit](/components/homekit_controller/) + * [IKEA Trådfri (Tradfri)](/components/tradfri/) + * [Linn / Openhome](/components/media_player.openhome/) + * [Logitech Harmony Hub](/components/remote.harmony/) + * [Logitech media server (Squeezebox)](/components/media_player.squeezebox/) + * [Netgear routers](/components/device_tracker.netgear/) + * [Panasonic Viera](/components/media_player.panasonic_viera/) + * [Philips Hue](/components/light.hue/) + * [Plex media server](/components/media_player.plex/) + * [Roku media player](/components/media_player.roku/) + * [SABnzbd downloader](/components/sensor.sabnzbd/) + * [Samsung TVs](/components/media_player.samsungtv/) + * [Sonos speakers](/components/media_player.sonos/) + * [Telldus Live](/components/tellduslive/) + * [Wink](/components/wink/) + * [Yamaha media player](/components/media_player.yamaha/) + * [Yeelight Sunflower bulb](/components/light.yeelightsunflower/) It will be able to add Google Chromecasts and Belkin WeMo switches automatically, for Philips Hue it will require some configuration from the user. @@ -50,6 +51,8 @@ discovery: ignore: - sonos - samsung_tv + enable: + - homekit ``` Configuration variables: @@ -85,6 +88,12 @@ Valid values for ignore are: * `yamaha`: Yamaha media player * `yeelight`: Yeelight Sunflower bulb +- **enable** (*Optional*): A list of platforms not enabled by default that `discovery` should discover. + +Valid values for enable are: + + * `homekit`: HomeKit accessories +

Home Assistant must be on the same network as the devices for uPnP discovery to work. If running Home Assistant in a [Docker container](/docs/installation/docker/) use switch `--net=host` to put it on the host's network. @@ -100,7 +109,7 @@ If you are on Windows and you're using Python 3.5, download the [Netifaces](http

If you see `Not initializing discovery because could not install dependency netdisco==0.6.1` in the logs, you will need to install the `python3-dev` or `python3-devel` package on your system manually (eg. `sudo apt-get install python3-dev` or `sudo dnf -y install python3-devel`). On the next restart of Home Assistant, the discovery should work. If you still get an error, check if you have a compiler (`gcc`) available on your system. - + For DSM/Synology, install via debian-chroot [see this forum post](https://community.home-assistant.io/t/error-starting-home-assistant-on-synology-for-first-time/917/15).

diff --git a/source/_components/dominos.markdown b/source/_components/dominos.markdown index 062c0fbfea..d6849d738f 100644 --- a/source/_components/dominos.markdown +++ b/source/_components/dominos.markdown @@ -10,12 +10,15 @@ footer: true logo: dominos.png ha_category: Other ha_version: 0.59 +ha_iot_class: "Cloud Polling" --- -The `Dominos` component allows you to order Dominos Pizza from within your Home Assistant scripts and automations. +The `dominos` component allows you to order Dominos Pizza from within your Home Assistant scripts and automations. At present, this component only supports ordering within Canada and the US. +## {% linkable_title Configuration %} + To enable the component, you need to set up your customer information and define some orders. Orders are a group of product codes. You can get these product codes by inspecting an order request from the Dominos web app, or you can [add this custom panel by following this readme](https://github.com/wardcraigj/hass-dominos-panel) to see the available product codes in a separate panel in your install. diff --git a/source/_components/doorbird.markdown b/source/_components/doorbird.markdown index 4ce686ec64..9db3c71d86 100644 --- a/source/_components/doorbird.markdown +++ b/source/_components/doorbird.markdown @@ -20,9 +20,10 @@ To connect your device, add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry doorbird: - host: IP_OR_HOSTNAME - username: abcdef0001 - password: xxxxxxxxxx + host: DOORBIRD_IP_OR_HOSTNAME + username: YOUR_USERNAME + password: YOUR_PASSWORD + hass_url_override: HASS_IP ``` Configuration variables: @@ -31,7 +32,77 @@ Configuration variables: - **username** (*Required*): The username of a non-administrator user account on the device. - **password** (*Required*): The password for the user specified. - **doorbell_events** (*Optional*): Setting this to `true` this will register a callback URL with the device so that events can be published to the event bus when the doorbell rings. +- **hass_url_override** (*Optional*): If your DoorBird cannot connect to the machine running Home Assistant because you are using dynamic DNS or some other HTTP configuration (such as HTTPS), specify the LAN IP of the machine here to force a LAN connection.

Enabling `doorbell_events` will delete all other registered push notification services with the device every time Home Assistant starts. This will not affect notifications delivered by the DoorBird mobile app.

+ +### Doorbell Sound Examples + +You can create an automation that triggers on event `doorbird_doorbell` to play a doorbell sound when the Doorbird button is pressed. This should work with any media player. + +#### Example using SONOS + +[`SONOS`](http://www.sonos.com) players have features allowing for "snapshotting" the current state of some or all players so those state(s) can be "restored" at a later time. This feature is perfect for implementing a doorbell sound (from Doorbird or any other Doorbell setup for that matter). The [`media_player.sonos`](/components/media_player.sonos/) platform includes the [`SONOS_SNAPSHOT`](/components/media_player.sonos/#service-sonos_snapshot) and [`SONOS_RESTORE`](/components/media_player.sonos/#service-sonos_restore) features. The result of not using these features is any currently playing songs or media will not continue playing after the doorbell sound has played and you will be left with the doorbell sound queued as the last played song. This setup allows for seamless ringing of the doorbell and all SONOS devices continuing nicely on as if nothing had happened. + +The example script below takes a snapshot of three SONOS players that are not currently grouped together, joins the three players in a group (so the sound plays at the same time on all players), plays the doorbell MP3 sound, unjoins the players from the group and finally restores the players to their original state. When the players are grouped they are controlled by refering to the `master`. + +Automation file: + +```yaml +- alias: Doorbird ring + trigger: + platform: event + event_type: doorbird_doorbell + action: + service: script.turn_on + entity_id: script.doorbell +``` + +Script file: + +```yaml +doorbell: + alias: Ring Doorbell + sequence: + - service: media_player.sonos_snapshot + data: + entity_id: + - media_player.kitchen + - media_player.master_bedroom + - media_player.study + - service: media_player.sonos_join + data: + master: media_player.study + entity_id: + - media_player.kitchen + - media_player.master_bedroom + - media_player.study + - service: media_player.play_media + data: + entity_id: media_player.study # the group master + media_content_id: http://10.1.1.10/sounds/doorbell.mp3 # this is on a NAS but could be HASS local + media_content_type: music + - service: media_player.volume_set + data: + entity_id: # can still control the volume of grouped players indivdually + - media_player.study + - media_player.kitchen + - media_player.master_bedrom + volume_level: 0.50 + - delay: + seconds: 4 # wait while the sound plays + - service: media_player.sonos_unjoin + data: + entity_id: + - media_player.kitchen + - media_player.master_bedroom + - media_player.study + - service: media_player.sonos_restore + data: + entity_id: + - media_player.kitchen + - media_player.master_bedroom + - media_player.study +``` diff --git a/source/_components/downloader.markdown b/source/_components/downloader.markdown index 53063587d6..beec226876 100644 --- a/source/_components/downloader.markdown +++ b/source/_components/downloader.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Downloader" -description: "Instructions how to setup the downloader component with Home Assistant." +description: "Instructions on how to setup the downloader component with Home Assistant." date: 2015-01-24 14:39 sidebar: true comments: false @@ -42,3 +42,29 @@ This will download the file from the given URL. | `subdir` | yes | Download into subdirectory of **download_dir** | | `filename` | yes | Determine the filename. | | `overwrite` | yes | Whether to overwrite the file or not, defaults to `false`. | + +### {% linkable_title Download Status Events %} + +When a download finished successfully, Home Assistant will emit a 'downloader_download_completed' event to the event bus which you can use to write automations against. +In case download failed another event 'downloader_download_failed' is emitted to indicate that the download did not complete successfully. + +Along with the event the following payload parameters are available: + +| Parameter | Description | +|-----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `url` | The `url` that was requested.| +| `filename` | The `name` of the file that was being downloaded.| + +#### Example Automation: + +```yaml +- alias: Download Failed Notification + trigger: + platform: event + event_type: downloader_download_failed + action: + service: persistent_notification.create + data_template: + message: "{{trigger.event.data.filename}} download failed" + title: "Download Failed" + ``` diff --git a/source/_components/dyson.markdown b/source/_components/dyson.markdown index a3d015001c..7c0e1ca2f3 100644 --- a/source/_components/dyson.markdown +++ b/source/_components/dyson.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Dyson" -description: "Instructions how to integrate Dyson into Home Assistant." +description: "Instructions on how to integrate Dyson into Home Assistant." date: 2017-05-27 10:00 sidebar: true comments: false @@ -15,29 +15,31 @@ ha_release: 0.47 The `dyson` component is the main component to integrate all [Dyson](https://dyson.com) related platforms: [Fans](/components/fan/dyson/) and [Robot vacuum](/components/vacuum/dyson/). +## {% linkable_title Configuration %} + To enable this component, add the following lines to your `configuration.yaml`: ```yaml +# Example configuration.yaml entry dyson: - username: - password: - language: + username: YOUR_DYSON_USERNAME + password: YOUR_DYSON_PASSWORD + language: YOUR_DYSON_ACCOUNT_LANGUGAGE devices: - - device_id: # eg: Pure Cool Link device - device_ip: - - device_id: # eg: Eye 360 robot vacuum - device_ip: - ... + - device_id: DEVICE_ID_1 # eg. Serial number: XXX-XX-XXXXXXXX + device_ip: DEVICE_ID_1 + - device_id: DEVICE_ID_2 + device_ip: DEVICE_ID_2 ``` Configuration variables: -- **username** (*Required*): Dyson account username (email address) -- **password** (*Required*): Dyson account password +- **username** (*Required*): Dyson account username (email address). +- **password** (*Required*): Dyson account password. - **language** (*Required*): Dyson account language country code. Known working codes: `FR`, `NL`, `GB`, `AU`. But others codes should work. -- **devices** (*Optional*): List of devices - - **device_id** (*Required*): Device ID. Available in the mobiles applications (*Settings* page) - - **device_ip** (*Required*): Device IP address +- **devices** (*Optional*): List of devices. + - **device_id** (*Required*): Device ID. The Serial Number of the device. Found in the mobiles applications device settings page. + - **device_ip** (*Required*): Device IP address. `devices` list is optional but you'll have to provide them if discovery is not working (warnings in the logs and the devices are not available in Home Assistant web interface). *If your are using a robot vacuum (Dyson 360 Eye), discovery is not yet supported so you have to provide `devices` list.* diff --git a/source/_components/egardia.markdown b/source/_components/egardia.markdown index 1f0396bde7..a19c76738b 100644 --- a/source/_components/egardia.markdown +++ b/source/_components/egardia.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Egardia" -description: "Instructions how to setup Egardia / Woonveilig within Home Assistant." +description: "Instructions on how to setup Egardia / Woonveilig within Home Assistant." date: 2018-03-13 09:00 sidebar: true comments: false diff --git a/source/_components/eight_sleep.markdown b/source/_components/eight_sleep.markdown index 0d730e2f7a..3a455d4ab5 100644 --- a/source/_components/eight_sleep.markdown +++ b/source/_components/eight_sleep.markdown @@ -15,6 +15,8 @@ ha_iot_class: "Cloud Polling" The `eight_sleep` component allows Home Assistant to fetch data from your [Eight Sleep](https://eightsleep.com/) smart cover or mattress. +## {% linkable_title Configuration %} + It's setup utilizing 'Sensor' components to convey the current state of your bed and results of your sleep sessions and a 'Binary Sensor' component to indicate your presence in the bed. A service is also provided to set the heating level and duration of the bed. You must have at least two sleep sessions recorded in the Eight Sleep app prior to setting up the Home Assistant component. @@ -24,15 +26,25 @@ To get started add the following information to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry eight_sleep: - username: "user@email.com" - password: "password" + username: YOUR_E_MAIL_ADDRESS + password: YOUR_PASSWORD ``` -Configuration variables: - -- **username** (*Required*): The email address associated with your Eight Sleep account. -- **password** (*Required*): The password associated with your Eight Sleep account. -- **partner** (*Optional*): Default is False. Defines if you'd like to fetch data for both sides of the bed. +{% configuration %} +username: + description: The email address associated with your Eight Sleep account. + required: true + type: string +password: + description: The password associated with your Eight Sleep account. + required: true + type: string +password: + description: Defines if you'd like to fetch data for both sides of the bed. + required: false + type: string + default: False +{% endconfiguration %} ### {% linkable_title Supported features %} diff --git a/source/_components/emulated_hue.markdown b/source/_components/emulated_hue.markdown index 44c7c76c38..763baa4673 100644 --- a/source/_components/emulated_hue.markdown +++ b/source/_components/emulated_hue.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Emulated Hue Bridge" -description: "Instructions how to emulated Hue Bridge within Home Assistant." +description: "Instructions on how to emulated Hue Bridge within Home Assistant." date: 2016-08-26 08:00 sidebar: true comments: false @@ -14,7 +14,7 @@ ha_iot_class: "Local Push" ---

-Be aware that `emulated_hue` doesn't work for new **Google Home** users. If you're a new user of Google Home, use the [Google Assistant component](https://home-assistant.io/components/google_assistant/). +Be aware that `emulated_hue` doesn't work for new **Google Home** users. If you're a new user of Google Home, use the [Google Assistant component](/components/google_assistant/).

The `emulated_hue` component provides a virtual Philips Hue bridge, written entirely in software, which allows services that work with the Hue API to interact with Home Assistant @@ -126,7 +126,7 @@ An additional step is required to run Home Assistant as a non-root user and use ```bash sudo setcap 'cap_net_bind_service=+ep' /srv/homeassistant/homeassistant_venv/bin/python3 ``` -Please note that your path may be different depending on your installation method. For example, if you followed the [Virtualenv instructions](https://home-assistant.io/docs/installation/virtualenv/), your path will be `/srv/homeassistant/bin/python3`. +Please note that your path may be different depending on your installation method. For example, if you followed the [Virtualenv instructions](/docs/installation/virtualenv/), your path will be `/srv/homeassistant/bin/python3`. ### {% linkable_title License %} diff --git a/source/_components/eufy.markdown b/source/_components/eufy.markdown new file mode 100644 index 0000000000..60ec2a470d --- /dev/null +++ b/source/_components/eufy.markdown @@ -0,0 +1,54 @@ +--- +layout: page +title: "Eufy" +description: "Instructions on how to integrate Eufy devices into Home Assistant." +date: 2018-04-09 19:00 +sidebar: true +comments: false +sharing: true +footer: true +logo: eufy.png +ha_category: Hub +ha_release: 0.68 +--- + +The `eufy` component is the main component to integrate various [eufy](https://www.eufylife.com/) devices with Home Assistant. + +Supported devices will be discovered after the `eufy` component is configured: + +```yaml +# Example configuration.yaml entry +eufy: + username: testuser@domain + password: p4ssw0rd +``` + +where username and password are the ones configured in the EufyHome app. Alternately, Eufy devices that are not discoverable can be statically configured. + +```yaml +eufy: + devices: + - address: 192.168.1.10 + access_token: 1234567890abcdef + type: T1012 + name: Smart Light + - address: 192.168.1.11 + access_token: abcdef1234567890 + type: T1201 + name: Smart Switch +``` + +access_token can be obtained by running: + +``` +curl -H "Content-Type: application/json" -d '{"client_id":"eufyhome-app", "client_Secret":"GQCpr9dSp3uQpsOMgJ4xQ", "email":"USERNAME", "password":"PASSWORD"}' https://home-api.eufylife.com/v1/user/email/login | jq +``` + +replacing USERNAME and PASSWORD with the Eufy username and password. This will give an access_token. Then run: + +``` +curl -H token:TOKEN -H category:Home https://home-api.eufylife.com/v1/device/list/devices-and-groups | jq +``` + +replacing TOKEN with the access_token from the previous command. This will provide the local_code for each device. + diff --git a/source/_components/fan.comfoconnect.markdown b/source/_components/fan.comfoconnect.markdown index d24d4eb184..f1ac6f944f 100644 --- a/source/_components/fan.comfoconnect.markdown +++ b/source/_components/fan.comfoconnect.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Zehnder ComfoAir Q Ventilation fans" -description: "Instructions how to integrate Zehnder ComfoAir Q350/450/600 fans into Home Assistant." +description: "Instructions on how to integrate Zehnder ComfoAir Q350/450/600 fans into Home Assistant." date: 2017-06-28 18:00 sidebar: true comments: false diff --git a/source/_components/fan.dyson.markdown b/source/_components/fan.dyson.markdown index e827c7ab2c..d1ae60c638 100644 --- a/source/_components/fan.dyson.markdown +++ b/source/_components/fan.dyson.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Dyson Purifier Fan" -description: "Instructions how to setup the Dyson Purifier fans within Home Assistant." +description: "Instructions on how to setup the Dyson Purifier fans within Home Assistant." date: 2017-05-27 10:00 sidebar: true comments: false diff --git a/source/_components/fan.insteon_hub.markdown b/source/_components/fan.insteon_hub.markdown index b5ce9adbc7..0436d4bdde 100644 --- a/source/_components/fan.insteon_hub.markdown +++ b/source/_components/fan.insteon_hub.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Insteon Hub Fan" -description: "Instructions how to setup the Insteon Hub Fans within Home Assistant." +description: "Instructions on how to setup the Insteon Hub Fans within Home Assistant." date: 2017-08-26 08:00 sidebar: true comments: false diff --git a/source/_components/fan.insteon_local.markdown b/source/_components/fan.insteon_local.markdown index 359f099477..d9738043c9 100644 --- a/source/_components/fan.insteon_local.markdown +++ b/source/_components/fan.insteon_local.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Insteon (Local) Fan" -description: "Instructions how to setup the Insteon Hub Fans locally within Home Assistant." +description: "Instructions on how to setup the Insteon Hub Fans locally within Home Assistant." date: 2017-04-06 11:00 sidebar: true comments: false diff --git a/source/_components/fan.insteon_plm.markdown b/source/_components/fan.insteon_plm.markdown index 23c0cbac84..3f2323e16e 100644 --- a/source/_components/fan.insteon_plm.markdown +++ b/source/_components/fan.insteon_plm.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Insteon PLM Fan" -description: "Instructions how to setup the Insteon PLM fan locally within Home Assistant." +description: "Instructions on how to setup the Insteon PLM fan locally within Home Assistant." date: 2017-02-19 17:00 sidebar: true comments: false diff --git a/source/_components/fan.isy994.markdown b/source/_components/fan.isy994.markdown index 6b9e55f289..4c47e76fc4 100644 --- a/source/_components/fan.isy994.markdown +++ b/source/_components/fan.isy994.markdown @@ -1,7 +1,7 @@ --- layout: page title: "ISY994 Fan" -description: "Instructions how to integrate ISY994 fans into Home Assistant." +description: "Instructions on how to integrate ISY994 fans into Home Assistant." date: 2016-09-03 23:00 sidebar: true comments: false diff --git a/source/_components/fan.markdown b/source/_components/fan.markdown index c196d9f770..aac9c8c763 100644 --- a/source/_components/fan.markdown +++ b/source/_components/fan.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Fan" -description: "Instructions how to setup Fan devices within Home Assistant." +description: "Instructions on how to setup Fan devices within Home Assistant." date: 2016-08-26 19:00 sidebar: true comments: false diff --git a/source/_components/fan.mqtt.markdown b/source/_components/fan.mqtt.markdown index 1a0329404f..45fa55d41b 100644 --- a/source/_components/fan.mqtt.markdown +++ b/source/_components/fan.mqtt.markdown @@ -1,7 +1,7 @@ --- layout: page title: "MQTT Fan" -description: "Instructions how to integrate MQTT fans into Home Assistant." +description: "Instructions on how to integrate MQTT fans into Home Assistant." date: 2016-08-27 09:00 sidebar: true comments: false @@ -15,6 +15,8 @@ ha_iot_class: depends The `mqtt` fan platform lets you control your MQTT enabled fans. +## {% linkable_title Configuration %} + In an ideal scenario, the MQTT device will have a `state_topic` to publish state changes. If these messages are published with a `RETAIN` flag, the MQTT fan will receive an instant state update after subscription and will start with the correct state. Otherwise, the initial state of the fan will be `false` / `off`. When a `state_topic` is not available, the fan will work in optimistic mode. In this mode, the fan will immediately change state after every command. Otherwise, the fan will wait for state confirmation from the device (message from `state_topic`). @@ -24,7 +26,7 @@ Optimistic mode can be forced even if a `state_topic` is available. Try to enabl To enable MQTT fans in your installation, add the following to your `configuration.yaml` file: ```yaml -# Example configuration.yml entry +# Example configuration.yaml entry fan: - platform: mqtt command_topic: "bedroom_fan/on/set" @@ -155,7 +157,7 @@ In this section you find some real life examples of how to use this fan. The example below shows a full configuration for a MQTT fan. ```yaml -# Example configuration.yml entry +# Example configuration.yaml entry fan: - platform: mqtt name: "Bedroom Fan" diff --git a/source/_components/fan.template.markdown b/source/_components/fan.template.markdown new file mode 100644 index 0000000000..5ebd666594 --- /dev/null +++ b/source/_components/fan.template.markdown @@ -0,0 +1,96 @@ +--- +layout: page +title: "Template Fan" +description: "Instructions how to setup the Template fans within Home Assistant." +date: 2018-05-03 09:00 +sidebar: true +comments: false +sharing: true +footer: true +ha_category: Fan +ha_release: 0.69 +ha_iot_class: "Local Push" +logo: home-assistant.png +--- + +The `template` platform creates fans that combine components and provides the +ability to run scripts or invoke services for each of the turn_on, turn_off, set_speed, and +set_oscillating commands of a fan. + +To enable Template Fans in your installation, add the following to your +`configuration.yaml` file: + +{% raw %} +```yaml +# Example configuration.yaml entry +fan: + - platform: template + fans: + bedroom_fan: + friendly_name: "Bedroom fan" + value_template: "{{ states('input_boolean.state') }}" + speed_template: "{{ states('input_select.speed') }}" + oscillating_template: "{{ states('input_select.osc') }}" + turn_on: + service: script.fan_on + turn_off: + service: script.fan_off + set_speed: + service: script.fan_speed + data_template: + speed: "{{ speed }}" + set_oscillating: + service: script.fan_oscillating + data_template: + oscillating: "{{ oscillating }}" + speeds: + - '1' + - '2' + - '3' +``` +{% endraw %} + +{% configuration %} + fans: + description: List of your fans. + required: true + type: map + keys: + friendly_name: + description: Name to use in the frontend. + required: false + type: string + value_template: + description: "Defines a template to get the state of the fan. Valid value: 'on'/'off'" + required: true + type: template + speed_template: + description: Defines a template to get the speed of the fan. + required: false + type: template + oscillating_template: + description: "Defines a template to get the osc state of the fan. Valid value: True/False" + required: false + type: template + turn_on: + description: Defines an action to run when the fan is turned on. + required: true + type: action + turn_off: + description: Defines an action to run when the fan is turned off. + required: true + type: action + set_speed: + description: Defines an action to run when the fan is given a speed command. + required: false + type: action + set_oscillating: + description: Defines an action to run when the fan is given a osc state command. + required: false + type: action + speeds: + description: List of speeds the fan is capable of running at. + required: false + type: string list + default: ['low', 'medium', 'high'] +{% endconfiguration %} diff --git a/source/_components/fan.wink.markdown b/source/_components/fan.wink.markdown index 23369dfad2..129db4b469 100644 --- a/source/_components/fan.wink.markdown +++ b/source/_components/fan.wink.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Wink Fan" -description: "Instructions how to setup the Wink fans within Home Assistant." +description: "Instructions on how to setup the Wink fans within Home Assistant." date: 2017-01-14 12:00 sidebar: true comments: false diff --git a/source/_components/fan.xiaomi_miio.markdown b/source/_components/fan.xiaomi_miio.markdown index 99adf8ff4e..8fc9da3211 100644 --- a/source/_components/fan.xiaomi_miio.markdown +++ b/source/_components/fan.xiaomi_miio.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Xiaomi Air Purifier" -description: "Instructions how to integrate your Xiaomi Air Purifier within Home Assistant." +description: "Instructions on how to integrate your Xiaomi Air Purifier and Xiaomi Air Humidifier within Home Assistant." date: 2017-10-13 12:35 sidebar: true comments: false @@ -13,35 +13,161 @@ ha_version: 0.57 ha_iot_class: "Local Polling" --- -The `xiaomi_miio` fan platform allows you to control the Xiaomi Air Purifier 2, Air Purifier 2S and Air Purifier Pro. +The `xiaomi_miio` fan platform allows you to control the Xiaomi Air Purifier and Xiaomi Air Humidifier. -Currently, the supported features are: +## Features -* On, Off +### Air Purifier 2 et al. + +* Power (on, off) * Operation modes (auto, silent, favorite, idle) * Buzzer (on, off) * Child lock (on, off) * LED (on, off), LED brightness (bright, dim, off) * Favorite Level (0...16) * Attributes - - power - - aqi - - average_aqi - - humidity + - model - temperature + - humidity + - aqi - mode + - filter_hours_used + - filter_life_remaining - favorite_level + - child_lock - led + - motor_speed + - average_aqi + - purify_volume + - learn_mode + - sleep_time + - sleep_mode_learn_count + - extra_features + - turbo_mode_supported + - auto_detect + - use_time + - button_pressed + - buzzer - led_brightness + - sleep_mode + +### Air Purifier Pro (zhimi.airpurifier.v6) + +* Power (on, off) +* Operation modes (auto, silent, favorite) +* Child lock (on, off) +* LED (on, off) +* Favorite Level (0...16) +* Attributes + - model + - temperature + - humidity + - aqi + - mode + - filter_hours_used + - filter_life_remaining + - favorite_level + - child_lock + - led + - motor_speed + - average_aqi + - purify_volume + - learn_mode + - sleep_time + - sleep_mode_learn_count + - extra_features + - turbo_mode_supported + - auto_detect + - use_time + - button_pressed + - filter_rfid_product_id + - filter_rfid_tag + - filter_type + - illuminance + - motor2_speed + - volume + +### Air Purifier V3 (zhimi.airpurifier.v3) + +* Power (on, off) +* Operation modes (auto, silent, favorite, idle, medium, high, strong) +* Child lock (on, off) +* LED (on, off) +* Attributes + - model + - aqi + - mode + - led - buzzer - child_lock - - purify_volume - - filter_life_remaining + - illuminance - filter_hours_used + - filter_life_remaining - motor_speed + - average_aqi + - volume + - motor2_speed + - filter_rfid_product_id + - filter_rfid_tag + - filter_type + - purify_volume + - learn_mode + - sleep_time + - sleep_mode_learn_count + - extra_features + - auto_detect + - use_time + - button_pressed +### Air Humidifier (zhimi.humidifier.v1) -Please follow the instructions on [Retrieving the Access Token](/components/vacuum.xiaomi_miio/#retrieving-the-access-token) to get the API token. +* On, Off +* Operation modes (silent, medium, high) +* Buzzer (on, off) +* Child lock (on, off) +* LED brightness (bright, dim, off) +* Target humidity (30, 40, 50, 60, 70, 80) +* Attributes + - model + - temperature + - humidity + - mode + - buzzer + - child_lock + - trans_level + - target_humidity + - led_brightness + - button_pressed + - use_time + - hardware_version + +### Air Humidifier CA (zhimi.humidifier.ca1) + +* On, Off +* Operation modes (silent, medium, high, auto) +* Buzzer (on, off) +* Child lock (on, off) +* LED brightness (bright, dim, off) +* Target humidity (30, 40, 50, 60, 70, 80) +* Dry mode (on, off) +* Attributes + - model + - temperature + - humidity + - mode + - buzzer + - child_lock + - trans_level + - target_humidity + - led_brightness + - button_pressed + - use_time + - hardware_version + - speed + - depth + - dry + +Please follow the instructions on [Retrieving the Access Token](/components/vacuum.xiaomi_miio/#retrieving-the-access-token) to get the API token to use in the `configuration.yaml` file. To add a Xiaomi Air Purifier to your installation, add the following to your `configuration.yaml` file: @@ -67,41 +193,54 @@ name: required: false type: string default: Xiaomi Air Purifier +model: + description: The model of your device. + required: false + type: string {% endconfiguration %} ## {% linkable_title Platform Services %} -### {% linkable_title Service `fan.xiaomi_miio_set_buzzer_on` %} +### {% linkable_title Service `fan.set_speed` %} + +Set the fan speed/operation mode. + +| Service data attribute | Optional | Description | +|---------------------------|----------|---------------------------------------------------------------------| +| `entity_id` | yes | Only act on a specific air purifier. Else targets all. | +| `speed` | no | Fan speed. Valid values are 'Auto', 'Silent', 'Favorite' and 'Idle' | + +### {% linkable_title Service `fan.xiaomi_miio_set_buzzer_on` %} (Air Purifier Pro excluded) Turn the buzzer on. -| Service data attribute | Optional | Description | -|---------------------------|----------|-------------------------------------------------------| -| `entity_id` | yes | Only act on a specific air purifier. Else targets all. | +| Service data attribute | Optional | Description | +|---------------------------|----------|---------------------------------------------------------| +| `entity_id` | yes | Only act on a specific Xiaomi miIO fan entity. Else targets all. | -### {% linkable_title Service `fan.xiaomi_miio_set_buzzer_off` %} +### {% linkable_title Service `fan.xiaomi_miio_set_buzzer_off` %} (Air Purifier Pro excluded) Turn the buzzer off. | Service data attribute | Optional | Description | |---------------------------|----------|---------------------------------------------------------| -| `entity_id` | yes | Only act on a specific air purifier. Else targets all. | +| `entity_id` | yes | Only act on a specific Xiaomi miIO fan entity. Else targets all. | -### {% linkable_title Service `fan.xiaomi_miio_set_led_on` %} +### {% linkable_title Service `fan.xiaomi_miio_set_led_on` %} (Air Purifier only) Turn the led on. | Service data attribute | Optional | Description | |---------------------------|----------|---------------------------------------------------------| -| `entity_id` | yes | Only act on a specific air purifier. Else targets all. | +| `entity_id` | yes | Only act on a specific Xiaomi miIO fan entity. Else targets all. | -### {% linkable_title Service `fan.xiaomi_miio_set_led_off` %} +### {% linkable_title Service `fan.xiaomi_miio_set_led_off` %} (Air Purifier only) Turn the led off. | Service data attribute | Optional | Description | |---------------------------|----------|---------------------------------------------------------| -| `entity_id` | yes | Only act on a specific air purifier. Else targets all. | +| `entity_id` | yes | Only act on a specific Xiaomi miIO fan entity. Else targets all. | ### {% linkable_title Service `fan.xiaomi_miio_set_child_lock_on` %} @@ -109,7 +248,7 @@ Turn the child lock on. | Service data attribute | Optional | Description | |---------------------------|----------|---------------------------------------------------------| -| `entity_id` | yes | Only act on a specific air purifier. Else targets all. | +| `entity_id` | yes | Only act on a specific Xiaomi miIO fan entity. Else targets all. | ### {% linkable_title Service `fan.xiaomi_miio_set_child_lock_off` %} @@ -117,23 +256,105 @@ Turn the child lock off. | Service data attribute | Optional | Description | |---------------------------|----------|---------------------------------------------------------| -| `entity_id` | yes | Only act on a specific air purifier. Else targets all. | +| `entity_id` | yes | Only act on a specific Xiaomi miIO fan entity. Else targets all. | -### {% linkable_title Service `fan.xiaomi_miio_set_led_brightness` %} +### {% linkable_title Service `fan.xiaomi_miio_set_led_brightness` %} (Air Purifier Pro excluded) Set the led brightness. Supported values are 0 (Bright), 1 (Dim), 2 (Off). | Service data attribute | Optional | Description | |---------------------------|----------|---------------------------------------------------------| -| `entity_id` | yes | Only act on a specific air purifier. Else targets all. | +| `entity_id` | yes | Only act on a specific Xiaomi miIO fan entity. Else targets all. | | `brightness` | no | Brightness, between 0 and 2. | -### {% linkable_title Service `fan.xiaomi_miio_set_favorite_level` %} +### {% linkable_title Service `fan.xiaomi_miio_set_favorite_level` %} (Air Purifier only) Set the favorite level of the operation mode "favorite". | Service data attribute | Optional | Description | |---------------------------|----------|---------------------------------------------------------| -| `entity_id` | yes | Only act on a specific air purifier. Else targets all. | +| `entity_id` | yes | Only act on a specific Xiaomi miIO fan entity. Else targets all. | | `level` | no | Level, between 0 and 16. | +### {% linkable_title Service `fan.xiaomi_miio_set_auto_detect_on` %} (Air Purifier Pro only) + +Turn the auto detect on. + +| Service data attribute | Optional | Description | +|---------------------------|----------|---------------------------------------------------------| +| `entity_id` | yes | Only act on a specific Xiaomi miIO fan entity. Else targets all. | + +### {% linkable_title Service `fan.xiaomi_miio_set_auto_detect_off` %} (Air Purifier Pro only) + +Turn the auto detect off. + +| Service data attribute | Optional | Description | +|---------------------------|----------|---------------------------------------------------------| +| `entity_id` | yes | Only act on a specific Xiaomi miIO fan entity. Else targets all. | + +### {% linkable_title Service `fan.xiaomi_miio_set_learn_mode_on` %} (Air Purifier 2 only) + +Turn the learn mode on. + +| Service data attribute | Optional | Description | +|---------------------------|----------|---------------------------------------------------------| +| `entity_id` | yes | Only act on a specific Xiaomi miIO fan entity. Else targets all. | + +### {% linkable_title Service `fan.xiaomi_miio_set_learn_mode_off` %} (Air Purifier 2 only) + +Turn the learn mode off. + +| Service data attribute | Optional | Description | +|---------------------------|----------|---------------------------------------------------------| +| `entity_id` | yes | Only act on a specific Xiaomi miIO fan entity. Else targets all. | + +### {% linkable_title Service `fan.xiaomi_miio_set_volume` %} (Air Purifier Pro only) + +Set the sound volume. + +| Service data attribute | Optional | Description | +|---------------------------|----------|---------------------------------------------------------| +| `entity_id` | yes | Only act on a specific Xiaomi miIO fan entity. Else targets all. | +| `volume` | no | Volume, between 0 and 100. | + +### {% linkable_title Service `fan.xiaomi_miio_reset_filter` %} (Air Purifier 2 only) + +Reset the filter lifetime and usage. + +| Service data attribute | Optional | Description | +|---------------------------|----------|---------------------------------------------------------| +| `entity_id` | yes | Only act on a specific Xiaomi miIO fan entity. Else targets all. | + +### {% linkable_title Service `fan.xiaomi_miio_set_extra_features` %} (Air Purifier only) + +Set the extra features. + +| Service data attribute | Optional | Description | +|---------------------------|----------|---------------------------------------------------------| +| `entity_id` | yes | Only act on a specific Xiaomi miIO fan entity. Else targets all. | +| `features` | no | Integer, known values are 0 and 1. | + +### {% linkable_title Service `fan.xiaomi_miio_set_target_humidity` %} (Air Humidifier only) + +Set the target humidity. + +| Service data attribute | Optional | Description | +|---------------------------|----------|-----------------------------------------------------------------| +| `entity_id` | yes | Only act on a specific Xiaomi miIO fan entity. Else targets all. | +| `humidity` | no | Target humidity. Allowed values are 30, 40, 50, 60, 70 and 80 | + +### {% linkable_title Service `fan.xiaomi_miio_set_dry_on` %} (Air Humidifier CA only) + +Turn the dry mode on. + +| Service data attribute | Optional | Description | +|---------------------------|----------|---------------------------------------------------------| +| `entity_id` | yes | Only act on a specific Xiaomi miIO fan entity. Else targets all. | + +### {% linkable_title Service `fan.xiaomi_miio_set_dry_off` %} (Air Humidifier CA only) + +Turn the dry mode off. + +| Service data attribute | Optional | Description | +|---------------------------|----------|---------------------------------------------------------| +| `entity_id` | yes | Only act on a specific Xiaomi miIO fan entity. Else targets all. | diff --git a/source/_components/fan.zha.markdown b/source/_components/fan.zha.markdown new file mode 100644 index 0000000000..536d9c78bd --- /dev/null +++ b/source/_components/fan.zha.markdown @@ -0,0 +1,16 @@ +--- +layout: page +title: "ZigBee Home Automation Fan" +description: "Instructions how to setup ZigBee Home Automation fans within Home Assistant." +date: 2018-02-10 00:00 +sidebar: true +comments: false +sharing: true +footer: true +logo: zigbee.png +ha_category: Fan +ha_iot_class: "Local Polling" +ha_release: 0.66 +--- + +To get your ZigBee fans working with Home Assistant, follow the instructions for the general [ZigBee Home Automation component](/components/zha/). diff --git a/source/_components/fan.zwave.markdown b/source/_components/fan.zwave.markdown index 953620ed3b..4e83a0b8a5 100644 --- a/source/_components/fan.zwave.markdown +++ b/source/_components/fan.zwave.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Z-Wave Fan" -description: "Instructions how to setup the Z-Wave Fans within Home Assistant." +description: "Instructions on how to setup the Z-Wave Fans within Home Assistant." date: 2017-05-25 17:00 sidebar: true comments: false diff --git a/source/_components/feedreader.markdown b/source/_components/feedreader.markdown index 15b7212965..5a06cd4171 100644 --- a/source/_components/feedreader.markdown +++ b/source/_components/feedreader.markdown @@ -1,7 +1,7 @@ --- layout: page title: Feedreader -description: "Instructions how to integrate RSS feeds into Home Assistant." +description: "Instructions on how to integrate RSS feeds into Home Assistant." date: 2016-04-18 22:00 sidebar: true comments: false @@ -20,7 +20,7 @@ To use RSS feeds in your installation, add the following to your `configuration. # Example configuration.yaml entry feedreader: urls: - - https://home-assistant.io/atom.xml + - https://www.home-assistant.io/atom.xml - https://github.com/blog.atom - https://hasspodcast.io/feed/podcast ``` @@ -67,4 +67,4 @@ hass.bus.listen(EVENT_FEEDREADER, event_listener) To get started developing custom components, please refer to the [developers](/developers) documentation -For a drop in packaged complete example of Feedreader, you can use the [PodCast notifier](https://github.com/CCOSTAN/Home-AssistantConfig/blob/master/packages/hasspodcast.yaml). +For a drop in packaged complete example of Feedreader, you can use the [PodCast notifier](https://github.com/CCOSTAN/Home-AssistantConfig/blob/master/config/packages/hasspodcast.yaml). diff --git a/source/_components/folder_watcher.markdown b/source/_components/folder_watcher.markdown new file mode 100644 index 0000000000..df9041ed35 --- /dev/null +++ b/source/_components/folder_watcher.markdown @@ -0,0 +1,81 @@ +--- +layout: page +title: "Folder Watcher" +description: "Component for monitoring changes within the filesystem." +date: 2018-03-11 14:00 +sidebar: true +comments: false +sharing: true +footer: true +logo: home-assistant.png +ha_category: System Monitor +ha_iot_class: "Local Polling" +ha_release: 0.67 +--- + +This component adds [Watchdog](https://pythonhosted.org/watchdog/) file system monitoring, publishing events on the Home Assistant bus on the creation/deletion/modification of files within configured folders. The monitored `event_type` are: + +* `created` +* `deleted` +* `modified` +* `moved` + +Configured folders must be added to [whitelist_external_dirs](/docs/configuration/basic/). Note that by default folder monitoring is recursive, meaning that the contents of sub-folders are also monitored. + +To enable the Folder Watcher component in your installation, add the following to your `configuration.yaml` file: + +{% raw %} +```yaml +folder_watcher: + - folder: /config +``` +{% endraw %} + +{% configuration %} +folder: + description: The folder path + required: true + type: string +patterns: + description: Pattern matching to apply + required: false + default: "*" + type: string +{% endconfiguration %} + +## Patterns + +Pattern matching using [fnmatch](https://docs.python.org/3.6/library/fnmatch.html) can be used to limit filesystem monitoring to only files which match the configured patterns. The following example shows the configuration required to only monitor filetypes `.yaml` and `.txt`. + +{% raw %} +```yaml +folder_watcher: + - folder: /config + patterns: + - '*.yaml' + - '*.txt' +``` +{% endraw %} + +## Automations + +Automations can be triggered on filesystem event data using a `data_template`. The following automation will send a notification with the name and folder of new files added to that folder: + +{% raw %} +```yaml +- action: + - data_template: + message: 'Created {{ trigger.event.data.file }} in {{ trigger.event.data.folder }}' + title: New image captured! + data: + file: " {{ trigger.event.data.path }} " + service: notify.pushbullet + alias: New file alert + condition: [] + id: '1520092824697' + trigger: + - event_data: {"event_type":"created"} + event_type: folder_watcher + platform: event +``` +{% endraw %} diff --git a/source/_components/foursquare.markdown b/source/_components/foursquare.markdown index 10b5d6ebe6..5ec302887e 100644 --- a/source/_components/foursquare.markdown +++ b/source/_components/foursquare.markdown @@ -1,7 +1,7 @@ --- layout: page title: Foursquare -description: "Instructions how to the Foursquare API into Home Assistant." +description: "Instructions on how to the Foursquare API into Home Assistant." date: 2016-08-08 17:20 sidebar: true comments: false @@ -31,7 +31,7 @@ Configuration variables: #### Getting the access token #### After you have registered your APP on your [My Apps Page](https://foursquare.com/developers/apps) you get a `CLIENT_ID` and you have specified a -`REDIRECT_URL` which can be any URL you like, but since it will get your access token via a HTTP GET request, it should be a URL which will ignore the `access_token` HTTP GET variable. A good idea is to choose the URL of your Home Assistant. +`REDIRECT_URL` which can be any URL you like, but since it will get your access token via an HTTP GET request, it should be a URL which will ignore the `access_token` HTTP GET variable. A good idea is to choose the URL of your Home Assistant. Visit the following URL in your browser: ``` @@ -40,7 +40,7 @@ https://foursquare.com/oauth2/authenticate?client_id=CLIENT_ID&response_type=tok and change the `CLIENT_ID` and `YOUR_REGISTERED_REDIRECT_URL` to your actual values. You will receive an OAuth request landing page, asking you if you want to connect your Foursquare account to your newly created app. Say "Yes". -After that, you will get redirected to your `REDIRECT_URL` with the `access_token` as a HTTP GET variable. Copy everything after the = and paste it in your configuration.yaml as the `access_token`. +After that, you will get redirected to your `REDIRECT_URL` with the `access_token` as an HTTP GET variable. Copy everything after the = and paste it in your configuration.yaml as the `access_token`. ### {% linkable_title Real-Time API %} diff --git a/source/_components/freedns.markdown b/source/_components/freedns.markdown new file mode 100644 index 0000000000..960d1411d9 --- /dev/null +++ b/source/_components/freedns.markdown @@ -0,0 +1,49 @@ +--- +layout: page +title: "freedns.afraid.org" +description: "Keep your DNS record up to date with FreeDNS." +date: 2018-03-27 21:30 +sidebar: true +comments: false +sharing: true +footer: true +ha_category: Utility +ha_release: 0.67 +--- + +With the `freedns` component you can keep your [FreeDNS](https://freedns.afraid.org) record up to date. + +## {% linkable_title Configuration %} + +You need to determine your update URL or your access token. + +1. Head over to the [FreeDNS](https://freedns.afraid.org) website and login to your account. +2. Select the menu "Dynamic DNS" +3. You should now see your update candiates in a table at the bottom of the page. +4. Copy the link target of the "Direct URL". +5. The access token is the part at the end of the link: `https://freedns.afraid.org/dynamic/update.php?YOUR_UPDATE_TOKEN` +6. Either put the token as `access_token` _or_ the whole URL into the `url` attribute. + +To use the component in your installation, add the following to your `configuration.yaml` file: + +```yaml +# Example configuration.yaml entry +freedns: + access_token: YOUR_TOKEN +``` + +{% configuration %} + access_token: + description: Your access token. This is exclusive to `url`. + required: false + type: string + url: + description: The full update URL. This is exclusive to `access_token`. + required: false + type: string + update_interval: + description: How often to call the update service. + required: false + type: time period + default: 10 minutes +{% endconfiguration %} diff --git a/source/_components/fritzbox.markdown b/source/_components/fritzbox.markdown new file mode 100644 index 0000000000..a5ca0a5f68 --- /dev/null +++ b/source/_components/fritzbox.markdown @@ -0,0 +1,55 @@ +--- +layout: page +title: "Fritzbox" +description: "Instructions on how to integrate the AVM Fritzbox Smart Home components." +date: 2018-02-18 17:10 +sidebar: true +comments: false +sharing: true +footer: true +logo: avm.png +ha_category: Hub +ha_release: 0.68 +ha_iot_class: "Local Polling" +--- + +The [AVM](https://en.avm.de) Fritzbox component for Home Assistant allows you to integrate the switch and climate devices. + +#### {% linkable_title Tested Devices %} + +- [FRITZ!Box 6490 Cable](https://en.avm.de/products/fritzbox/fritzbox-6490-cable/) +- [FRITZ!Box 7590](https://en.avm.de/products/fritzbox/fritzbox-7590/) +- [FRITZ!DECT 200](https://en.avm.de/products/fritzdect/fritzdect-200/) +- [Eurotronic Comet DECT](https://www.eurotronic.org/en/products/comet-dect.html) + + +## {% linkable_title Setup %} + +```yaml +# Example configuration.yaml entry +fritzbox: + devices: + - host: fritz.box + username: YOUR_USERNAME + password: YOUR_PASSWORD +``` + +{% configuration %} +devices: + description: A list of Fritzbox devices. + required: true + type: map + keys: + host: + description: The hostname or IP address of the Fritzbox. + required: true + type: optional + username: + description: The username for Smart Home access. + required: true + type: string + password: + description: The password of the user. + required: true + type: string +{% endconfiguration %} diff --git a/source/_components/frontend.markdown b/source/_components/frontend.markdown index 4ba9e004cd..871db22f68 100644 --- a/source/_components/frontend.markdown +++ b/source/_components/frontend.markdown @@ -135,7 +135,7 @@ Those will be loaded via `` on a ### {% linkable_title Manual Language Selection %} -The browser language is automatically detected. To use a different language, go to **General** in the Configuration panel and select a one from "Choose a Language". It will be applied immediately. +The browser language is automatically detected. To use a different language, go to **General** in the Configuration panel and select one from "Choose a Language". It will be applied immediately.

diff --git a/source/_components/gc100.markdown b/source/_components/gc100.markdown index 063dddcab0..43d74d72b7 100644 --- a/source/_components/gc100.markdown +++ b/source/_components/gc100.markdown @@ -14,7 +14,7 @@ ha_release: 0.57 The Global Caché [GC-100](https://www.globalcache.com/products/gc-100/) can be integrated into Home Assistant. GC-100 is a TCP-controllable hardware device which has an array of relays, RS232 serial ports, and flexible ports which can be programmed to be either digital inputs or IR blaster outputs. There are a variety of submodels of the GC-100 which have different amounts of each I/O type. -Currently, only relays and ports configured to be digital inputs are supported in Home Assistant. For IR support, please use the iTach remote platform (https://home-assistant.io/components/remote.itach/), but note that it will likely not function concurrently on the same GC100 due to limitations in the TCP socket server implementation used by Global Caché. +Currently, only relays and ports configured to be digital inputs are supported in Home Assistant. For IR support, please use the iTach remote platform (/components/remote.itach/), but note that it will likely not function concurrently on the same GC100 due to limitations in the TCP socket server implementation used by Global Caché. To enable this device, add the following lines to your `configuration.yaml`: diff --git a/source/_components/goalfeed.markdown b/source/_components/goalfeed.markdown index 0320a66d84..5632a8847d 100644 --- a/source/_components/goalfeed.markdown +++ b/source/_components/goalfeed.markdown @@ -19,8 +19,8 @@ To use this component, enter your email address and password from your goalfeed. ```yaml # Example configuration.yaml entry goalfeed: - username: your_email@gmail.com - password: goalfeed_password + username: YOUR_E_MAIL_ADDRESS + password: YOUR_PASSWORD ``` {% configuration %} diff --git a/source/_components/google_assistant.markdown b/source/_components/google_assistant.markdown index 2430428efe..edd0b8ebb1 100644 --- a/source/_components/google_assistant.markdown +++ b/source/_components/google_assistant.markdown @@ -13,6 +13,10 @@ featured: true ha_release: 0.56 --- +

+ Use [Home Assistant Cloud](/cloud/) to integrate with Google Assistant without any effort. +

+ The `google_assistant` component allows you to control things via Google Assistant (on your mobile or tablet) or a Google Home device. The Google Assistant component requires a bit more setup than most due to the way Google requires Assistant Apps to be set up. @@ -21,6 +25,8 @@ The Google Assistant component requires a bit more setup than most due to the wa To use Google Assistant, your Home Assistant configuration has to be externally accessible with a hostname and SSL certificate. If you haven't already configured that, you should do so before continuing.

+## {% linkable_title Configuration %} + To enable this, add the following lines to your `configuration.yaml` file: ```yaml @@ -63,15 +69,15 @@ access_token: required: true type: string agent_user_id: - description: A string to identify the user, e.g. email address. If not provided, the component will generate one. + description: A string to identify the user, e.g., email address. If not provided, the component will generate one. required: false type: string api_key: - description: An API Key generated for the project from [Google Console](https://console.cloud.google.com/apis/api/homegraph.googleapis.com/overview) which allows you to update devices without unlinking and relinking an account (see step 9 below). If not provided then the `google_assistant.request_sync` service is not exposed. It is recommended to set up this configuration key as it also allows the usage of the following command, "Ok Google, sync my devices". Once you have setup this componenet you will need to call this service (or command) each time you add a new device that you wish to control via the Google Assistant integration. + description: An API Key generated for the project from [Google Console](https://console.cloud.google.com/apis/api/homegraph.googleapis.com/overview) which allows you to update devices without unlinking and relinking an account (see step 9 below). If not provided then the `google_assistant.request_sync` service is not exposed. It is recommended to set up this configuration key as it also allows the usage of the following command, "Ok Google, sync my devices". Once you have setup this component you will need to call this service (or command) each time you add a new device that you wish to control via the Google Assistant integration. required: false type: string expose_by_default: - description: Expose devices in all supported domains by default. + description: Expose devices in all supported domains by default. If set to false, you need to either expose domains or add the expose configuration option to each entity in entity_config and set it to true. required: false default: True type: boolean @@ -102,7 +108,7 @@ entity_config: required: false type: list room: - description: Allows for associating this device to a Room in Google Assistant. This is currently non-functional, but will be enabled in the near future. + description: Allows for associating this device to a Room in Google Assistant. required: false type: string {% endconfiguration %} @@ -131,58 +137,32 @@ If you're not using Linux, you can use sites such as [this one](https://www.brow ### {% linkable_title Setup %} -1. Download the [gactions CLI](https://developers.google.com/actions/tools/gactions-cli) to be used later. You can download and run this anywhere and on any machine. Just remember where you put it for later and don't forget to run `chmod +x gactions` to make it executable on Mac or Linux. -2. Create a new file named `project.json` (in the same directory you downloaded `gactions` to) and replace the `[YOUR HOME ASSISTANT URL:PORT]` below with the URL you use to access Home Assistant. - Note: This must be an HTTPS URL to work. Don't forget to include the port number if you're not using port 443. - -```json -{ - "actions": [{ - "name": "actions.devices", - "deviceControl": { - }, - "fulfillment": { - "conversationName": "automation" - } - }], - "conversations": { - "automation": - { - "name": "automation", - "url": "https://[YOUR HOME ASSISTANT URL:PORT]/api/google_assistant" - } - } -} -``` - -3. Create a new project in the [developer console](https://console.actions.google.com/). +1. Create a new project in the [developer console](https://console.actions.google.com/). a. Add/Import project - b. Go to Build under the Actions SDK box - c. Copy the command that looks like: - - `gactions update --action_package PACKAGE_NAME --project doctest-2d0b8` -4. Replace `PACKAGE_NAME` with `project.json` and run that command in a console from the same directory you saved `project.json` in (you'll need to put `./` before `gactions` so that it reads `./gactions` if you're running it on Linux or Windows). It should output a URL like `https://console.actions.google.com/project/doctest-2d0b8/overview` - go there. -5. You'll need to fill out most of the information on that page, but none of it really matters since you won't be addressing the App directly, only through the Smart Home functionality built into Google Assistant. -6. The final item on that page `Account linking` is required for your app to interact with Home Assistant. - 1. Grant type: `Implicit` - 2. Client ID: The `client_id` from your Home Assistant configuration above - 3. Authorization URL (replace with your actual URL): `https://[YOUR HOME ASSISTANT URL]/api/google_assistant/auth`. If you have set `api_password:` add this password to the URL `https://[YOUR HOME ASSISTANT URL]/api/google_assistant/auth?api_password=[YOUR API PASSWORD]`) - 4. Configure your client. Add scopes for `email` and `name`. - 5. Testing instructions: Enter anything. It doesn't matter since you won't submit this app. -7. Back on the main app draft page. Click `Test Draft`. That will take you to the simulator (which won't work so just close that window). -8. If you haven't already added the component configuration to `configuration.yaml` and restarted Home Assistant, you'll be unable to continue until you have. -8. Open the Google Assistant app and go into `Settings > Home Control` -9. Click the `+` sign, and near the bottom, you should have `[test] your app name`. Selecting that should lead to you the screen where you can set rooms for your devices or nicknames for your devices. -10. If you want to allow other household users to control the devices: - 1. Go to the developer console using the address from point 4. - 2. Under the gear icon, click `Permissions` - 3. Click `Add`, type the new user's e-mail address and choose `Project -> Editor` role - 4. Have the new user go to [developer console](https://console.actions.google.com/) and repeat steps starting from point 7. -11. If you want to use the `google_assistant.request_sync` service, to update devices without unlinking and relinking, in Home Assistant, then enable Homegraph API for your project: - 1. Go to the [cloud console](https://console.cloud.google.com/apis/api/homegraph.googleapis.com/overview) - 2. Select your project and click Enable Homegraph API - 3. Go to Credentials and select API Key from Create Credentials - 4. Note down the generated API Key and use this in the configuration + b. Click on `BUILD` on the `Smart home` card + c. Type in your home assistant url: `https://[YOUR HOME ASSISTANT URL:PORT]/api/google_assistant`, replace the `[YOUR HOME ASSISTANT URL:PORT]` with the domain / ip address and the port under which your Home Assistant is reachable. + d. Click `Done`. Then click on `Overview`, which will lead you to the app details screen. +2. You'll need to fill out most of the information on that page, but none of it really matters since you won't be addressing the App directly, only through the Smart Home functionality built into Google Assistant. +3. The final item on that page `Account linking` is required for your app to interact with Home Assistant. + a. Grant type: `Implicit` + b. Client ID: The `client_id` from your Home Assistant configuration above + c. Authorization URL (replace with your actual URL): `https://[YOUR HOME ASSISTANT URL]/api/google_assistant/auth`. If you have set `api_password:` add this password to the URL `https://[YOUR HOME ASSISTANT URL]/api/google_assistant/auth?api_password=[YOUR API PASSWORD]`) + d. Configure your client. Add scopes for `email` and `name`. + e. Testing instructions: Enter anything. It doesn't matter since you won't submit this app. +4. Back on the main app draft page. Click `Test Draft`. That will take you to the simulator (which won't work so just close that window). +5. If you haven't already added the component configuration to `configuration.yaml` and restarted Home Assistant, you'll be unable to continue until you have. +6. Open the Google Assistant app and go into `Settings > Home Control` +7. Click the `+` sign, and near the bottom, you should have `[test] your app name`. Selecting that should lead you the screen where you can set rooms for your devices or nicknames for your devices. +8. If you want to allow other household users to control the devices: + a. Go to the settings for the project you created in point 1 in the developer console. + b. Under the gear icon, click `Permissions` + c. Click `Add`, type the new user's e-mail address and choose `Project -> Editor` role + d. Have the new user go to [developer console](https://console.actions.google.com/) and repeat steps starting from point 4 +9. If you want to use the `google_assistant.request_sync` service, to update devices without unlinking and relinking, in Home Assistant, then enable Homegraph API for your project: + a. Go to the [cloud console](https://console.cloud.google.com/apis/api/homegraph.googleapis.com/overview) + b. Select your project and click Enable Homegraph API + c. Go to Credentials, which you can find on the left navigation bar under the key icon, and select API Key from Create Credentials + d. Note down the generated API Key and use this in the configuration ### {% linkable_title Troubleshooting the request_sync service %} diff --git a/source/_components/group.markdown b/source/_components/group.markdown index 8f781722d2..924c55e24a 100644 --- a/source/_components/group.markdown +++ b/source/_components/group.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Group" -description: "Instructions how to setup groups within Home Assistant." +description: "Instructions on how to setup groups within Home Assistant." date: 2015-03-23 19:59 sidebar: true comments: false diff --git a/source/_components/hdmi_cec.markdown b/source/_components/hdmi_cec.markdown index 694c1e3357..ceafd717c6 100644 --- a/source/_components/hdmi_cec.markdown +++ b/source/_components/hdmi_cec.markdown @@ -1,7 +1,7 @@ --- layout: page title: "HDMI CEC" -description: "Instructions how to interact with HDMI CEC via Home Assistant." +description: "Instructions on how to interact with HDMI CEC via Home Assistant." date: 2016-06-24 19:59 sidebar: true comments: false diff --git a/source/_components/history.markdown b/source/_components/history.markdown index 76affbecc6..206678c510 100644 --- a/source/_components/history.markdown +++ b/source/_components/history.markdown @@ -1,7 +1,7 @@ --- layout: page title: "History" -description: "Instructions how to enable history support for Home Assistant." +description: "Instructions on how to enable history support for Home Assistant." date: 2015-03-23 19:59 sidebar: true comments: false @@ -120,7 +120,7 @@ When the `history` component queries the states table it only selects states whe #### {% linkable_title On dates %} -SQLite databases do not support native dates. That's why all the dates are saved in seconds since the UNIX epoch. Convert them manually using this site or in Python: +SQLite databases do not support native dates. That's why all the dates are saved in seconds since the UNIX epoch. Convert them manually using [this site](https://www.epochconverter.com/) or in Python: ```python from datetime import datetime diff --git a/source/_components/hive.markdown b/source/_components/hive.markdown index fbe0d5b17f..16f2a77ac4 100644 --- a/source/_components/hive.markdown +++ b/source/_components/hive.markdown @@ -14,11 +14,13 @@ ha_iot_class: "Cloud Polling" --- -This Hive component is the main component to set up and integrate all supported Hive devices. Once configured with the minimum required details it will detect and add all your Hive devices into Home Assistant, including support for multizone heating. +The `hive` component is the main component to set up and integrate all supported Hive devices. Once configured with the minimum required details it will detect and add all your Hive devices into Home Assistant, including support for multizone heating. This component uses the unofficial API used in the official Hive website [https://my.hivehome.com](https://my.hivehome.com), and you will need to use the same Username and Password you use on the Hive website to configure this Hive component in Home Assistant. -To add your Hive devices into your Home Assistant installation, using the default scan_interval, add the following to your 'configuration.yaml' file: + + +To add your Hive devices into your Home Assistant installation, add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry diff --git a/source/_components/homekit.markdown b/source/_components/homekit.markdown index ebb4b6ccd4..7ab434c890 100644 --- a/source/_components/homekit.markdown +++ b/source/_components/homekit.markdown @@ -1,7 +1,7 @@ --- layout: page title: "HomeKit" -description: "Instructions how to setup the HomeKit component in Home Assistant." +description: "Instructions on how to setup the HomeKit component in Home Assistant." date: 2018-02-20 17:30 sidebar: true comments: false @@ -12,7 +12,16 @@ ha_release: 0.64 logo: apple-homekit.png --- -The `HomeKit` component allows you to forward entities from Home Assistant to Apple `HomeKit`, so they could be controlled from Apple `Home` app and `Siri`. +The `HomeKit` component allows you to forward entities from Home Assistant to Apple `HomeKit`, so they can be controlled from Apple's `Home` app and `Siri`. Please make sure that you have read the [considerations](#considerations) listed below to save you some trouble later. + +

+ It might be necessary to install an additional package: + `$ sudo apt-get install libavahi-compat-libdnssd-dev` +

+ +

+ If you are upgrading Home Assistant from `0.65.x` and have used the HomeKit component, some accessories may not respond or may behave unusually. To fix these problems, you will need to remove the Home Assistant Bridge from your Home, stop Home Assistant and delete the `.homekit.state` file in your configuration folder and follow the Homekit [setup](#setup) steps again. +

{% configuration %} homekit: @@ -20,18 +29,62 @@ The `HomeKit` component allows you to forward entities from Home Assistant to Ap required: true type: map keys: - pincode: - description: Pin code required during setup of HomeKit Home Assistant accessory. The format needs to be 'XXX-XX-XXX' where X is a number between 0 and 9. + auto_start: + description: Flag if the HomeKit Server should start automatically after the Home Assistant Core Setup is done. ([Disable Auto Start](#disable-auto-start)) required: false - type: string - default: '"123-45-678"' + type: boolean + default: true port: description: Port for the HomeKit extension. required: false type: int - default: 51826 + default: 51827 + ip_address: + description: The local network IP address. Only necessary if the default from Home Assistant does not work. + required: false + type: string + filter: + description: Filter entities to available in the `Home` app. ([Configure Filter](#configure-filter)) + required: false + type: map + keys: + include_domains: + description: Domains to be included. + required: false + type: list + include_entities: + description: Entities to be included. + required: false + type: list + exclude_domains: + description: Domains to be excluded. + required: false + type: list + exclude_entities: + description: Entities to be excluded. + required: false + type: list + entity_config: + description: Configuration for specific entities. All subordinate keys are the corresponding entity ids to the domains, e.g. `alarm_control_panel.alarm`. + required: false + type: map + keys: + alarm_control_panel: + description: Additional options for `alarm_control_panel` entities. + required: false + type: map + keys: + code: + description: Code to arm or disarm the alarm in the frontend. + required: false + type: string + default: '' {% endconfiguration %} +

+ If you use Z-Wave, or `discovery:` you'll need to disable auto-start, see the [section below](#disable-auto-start) for details on how to do this. You'll then need to start the HomeKit component once Z-Wave is ready, or an appropriate delay to allow your entities to be discovered. +

+ ## {% linkable_title Setup %} To enable the `HomeKit` component in Home Assistant, add the following to your configuration file: @@ -39,18 +92,110 @@ To enable the `HomeKit` component in Home Assistant, add the following to your c ```yaml # Example for HomeKit setup homekit: - pincode: '123-45-678' ``` -

It is not recommended to choose '123-45-678' as your pin code!

- -After Home Assistant has started, all supported entities (see the [list](#supported-components) below which components are already integrated) will be exposed to `HomeKit`. To add them: -1. Open the `Home` App. -2. Choose `Add Accessory` and then `Don't Have a Code or Can't Scan?`. -3. The `Home Assistant` Bridge should be listed there. Select it and follow the instructions to complete setup. +After Home Assistant has started, the entities specified by the filter are exposed to `HomeKit` if they are [supported](#supported-components). To add them: +1. Open the Home Assistant frontend. A new card will display the `pin code`. +1. Open the `Home` app. +2. Choose `Add Accessory`, than select `Don't Have a Code or Can't Scan?` and enter the `pin code`. +4. Confirm the you are adding an `Uncertified Accessory` by clicking on `Add Anyway`. +5. Follow the setup be clicking on `Next` and lastly `Done` in the top right hand corner. +6. The `Home Assistant` Bridge and the Accessories should now be listed in the `Home` app. After the setup is completed you should be able to control your Home Assistant components through `Home` and `Siri`. + +## {% linkable_title Considerations %} + + +### {% linkable_title Accessory ID %} + +Currently this component uses the `entity_id` to generate a unique `accessory id (aid)` for `HomeKit`. The `aid` is used to identify a device and save all configurations made for it. This however means that if you decide to change an `entity_id` all configurations for this accessory made in the `Home` app will be lost. + +### {% linkable_title Persistence Storage %} + +Unfortunately `HomeKit` doesn't support any kind of persistent storage - only the configuration for accessories that are added to the `Home Assistant Bridge` are kept. To avoid problems it is recommended to use an automation to always start `HomeKit` with at least the same entities setup. If for some reason some entities are not setup, their config will be deleted. (State unknown or similar will not cause any issues.) + +A common situation might be if you decide to disable parts of the configuration for testing. Please make sure to disable `auto start` and `turn off` the `Start HomeKit` automation (if you have one). + + +## {% linkable_title Disable Auto Start %} + +Depending on your individual setup, it might be necessary to disable `Auto Start` for all accessories to be available for `HomeKit`. Only those entities that are fully setup when the `HomeKit` component is started, can be added. To start `HomeKit` when `auto_start: False`, you can call the service `homekit.start`. + +If you have Z-Wave entities you want exposed to HomeKit then you'll need to disable auto start and then start it after the Z-Wave mesh is ready. This is because the Z-Wave entities won't be fully set up until then. This can be automated using an automation: + +{% raw %} +```yaml +# Example for Z-Wave +homekit: + auto_start: False + +automation: + - alias: 'Start HomeKit' + trigger: + - platform: event + event_type: zwave.network_ready + action: + - service: homekit.start +``` +{% endraw %} + +For a general delay where your component doesn't generate an event, you can also do: + +{% raw %} +```yaml +# Example using a delay after start of Home Assistant +homekit: + auto_start: False + +automation: + - alias: 'Start HomeKit' + trigger: + - platform: homeassistant + event: start + action: + - delay: 00:05 # Waits 5 minutes + - service: homekit.start +``` +{% endraw %} + + +## {% linkable_title Configure Filter %} + +By default no entity will be excluded. To limit which entities are being exposed to `HomeKit`, you can use the `filter` parameter. Keep in mind only [supported components](#supported-components) can be added. + +{% raw %} +```yaml +# Example filter to include specified domains and exclude specified entities +homekit: + filter: + include_domains: + - alarm_control_panel + - light + exclude_entities: + - light.kitchen_light +``` +{% endraw %} + +Filters are applied as follows: + +1. No includes or excludes - pass all entities +2. Includes, no excludes - only include specified entities +3. Excludes, no includes - only exclude specified entities +4. Both includes and excludes: + * Include domain specified + - if domain is included, and entity not excluded, pass + - if domain is not included, and entity not included, fail + * Exclude domain specified + - if domain is excluded, and entity not included, fail + - if domain is not excluded, and entity not excluded, pass + - if both include and exclude domains specified, the exclude domains are ignored + * Neither include or exclude domain specified + - if entity is included, pass (as #2 above) + - if entity include and exclude, the entity exclude is ignored + + ## {% linkable_title Supported Components %} The following components are currently supported: @@ -58,9 +203,39 @@ The following components are currently supported: | Component | Type Name | Description | | --------- | --------- | ----------- | | alarm_control_panel | SecuritySystem | All security systems. | +| binary_sensor | Sensor | Support for `co2`, `door`, `garage_door`, `gas`, `moisture`, `motion`, `occupancy`, `opening`, `smoke` and `window` device classes. Defaults to the `occupancy` device class for everything else. | | climate | Thermostat | All climate devices. | -| cover | Window | All covers that support `set_cover_position`. | -| sensor | TemperatureSensor | All sensors that have `Celsius` and `Fahrenheit` as their `unit_of_measurement`. | -| switch/remote | Switch | All switches or remotes (represented as switches). | +| cover | GarageDoorOpener | All covers that support `open` and `close` and have `garage` as their `device_class`. | +| cover | WindowCovering | All covers that support `set_cover_position`. | +| cover | WindowCovering | All covers that support `open_cover` and `close_cover` through value mapping. (`open` -> `>=50`; `close` -> `<50`) | +| cover | WindowCovering | All covers that support `open_cover`, `stop_cover` and `close_cover` through value mapping. (`open` -> `>70`; `close` -> `<30`; `stop` -> every value in between) | +| device_tracker | Sensor | Support for `occupancy` device class. | +| light | Light | Support for `on / off`, `brightness` and `rgb_color`. | +| lock | DoorLock | Support for `lock / unlock`. | +| sensor | TemperatureSensor | All sensors that have `Celsius` or `Fahrenheit` as their `unit_of_measurement` or `temperature` as their `device_class`. | +| sensor | HumiditySensor | All sensors that have `%` as their `unit_of_measurement` and `humidity` as their `device_class`. | +| sensor | AirQualitySensor | All sensors that have `pm25` as part of their `entity_id` or `pm25` as their `device_class` | +| sensor | CarbonDioxideSensor | All sensors that have `co2` as part of their `entity_id` or `co2` as their `device_class` | +| sensor | LightSensor | All sensors that have `lm` or `lx` as their `unit_of_measurement` or `illuminance` as their `device_class` | +| switch / remote / input_boolean / script | Switch | All represented as switches. | -

Currently only devices that are setup when Home Assistant is starting can be exposed to `HomeKit`. This means that especially `Z-Wave` components are currently not supported, since they will be setup afterwards. We are working on a solution for this problem.

+ +## {% linkable_title Error reporting %} + +If you encounter any issues or bug and want to report them on `GitHub`, please follow these steps to make it easier for others to help and get your issue solved. + +1. Enable debugging mode: +```yaml +logger: + default: warning + logs: + homeassistant.components.homekit: debug + pyhap: debug +``` +2. Reproduce the bug / problem you have encountered. +3. Stop Home Assistant and copy the log from the log file. That is necessary since some errors only get logged, when Home Assistant is being shutdown. +4. Follow this link: [home-assistant/issues/new](https://github.com/home-assistant/home-assistant/issues/new?labels=component: homekit) and open a new issue. +5. Fill out all fields and especially include the following information: + - The configuration entries for `homekit` and the `component` that is causing the issue. + - The log / traceback you have generated before. + - Screenshots of the failing entity in the `states` panel. diff --git a/source/_components/homekit_controller.markdown b/source/_components/homekit_controller.markdown new file mode 100644 index 0000000000..910c07e036 --- /dev/null +++ b/source/_components/homekit_controller.markdown @@ -0,0 +1,36 @@ +--- +layout: page +title: "HomeKit controller support" +description: "Instructions how to integrate your HomeKit devices within Home Assistant." +date: 2018-03-19 21:04 +sidebar: true +comments: false +sharing: true +footer: true +logo: apple-homekit.png +ha_category: Hub +ha_release: 0.68 +ha_iot_class: "Local Polling" +--- + +[HomeKit](https://developer.apple.com/homekit/) controller integration for Home Assistant allows you to connect HomeKit accessories to Home Assistant. This component should not be confused with the [HomeKit](/components/homekit/) component, which allows you to control Home Assistant devices via HomeKit. + +

+ You may need additional packages to support the HomeKit Python module: + `$ sudo apt-get install libgmp-dev libmpfr-dev libmpc-dev` +

+ +There is currently support for the following device types within Home Assistant: + +- [Light](/components/light.homekit_controller/) +- [Switch](/components/switch.homekit_controller/) + +The component will be automatically configured if the [`discovery:`](/components/discovery/) component is enabled and an enable entry added for HomeKit: + +```yaml +discovery: + enable: + - homekit +``` + +For each detected HomeKit accessory, a configuration prompt will appear in the web front end. Use this to provide the HomeKit PIN. Note that HomeKit accessories can only be paired to one device at once. If your device is currently paired with Siri, you will need to reset it in order to pair it with Home Assistant. Once Home Assistant is configured to work with the device, you can export it back to Siri with the [`HomeKit`](/components/homekit/) component. diff --git a/source/_components/homematic.markdown b/source/_components/homematic.markdown index 622457fe7f..5deaa8311a 100644 --- a/source/_components/homematic.markdown +++ b/source/_components/homematic.markdown @@ -13,12 +13,12 @@ ha_iot_class: "Local Push" featured: false --- -The [Homematic](http://www.homematic.com/) component provides bi-directional communication with your CCU/Homegear. It uses a XML-RPC connection to set values on devices and subscribes to receive events the devices and the CCU emit. +The [Homematic](http://www.homematic.com/) component provides bi-directional communication with your CCU/Homegear. It uses a XML-RPC connection to set values on devices and subscribes to receive events the devices and the CCU emit. If you are using Homegear with paired [Intertechno](http://intertechno.at/) devices, uni-directional communication is possible as well. Device support is available for most of the wired and wireless devices, as well as a few IP devices. If you have a setup with mixed protocols, you have to configure additional hosts with the appropriate ports. The default is using port 2001, which are wireless devices. Wired devices usually are available through port 2000 and IP devices through port 2010. The virtual thermostatgroups the CCU provides use port 9292 **and** require you to set the `path` setting to `/groups`. -If you want to see if a specific device you have is supported, head over to the [pyhomematic](https://github.com/danielperna84/pyhomematic/tree/master/pyhomematic/devicetypes) repository and browse through the source code. A dictionary with the device identifiers (e.g. HM-Sec-SC-2) can be found within the relevant modules near the bottom. If your device is not supported, feel free to contribute. +If you want to see if a specific device you have is supported, head over to the [pyhomematic](https://github.com/danielperna84/pyhomematic/tree/master/pyhomematic/devicetypes) repository and browse through the source code. A dictionary with the device identifiers (e.g., HM-Sec-SC-2) can be found within the relevant modules near the bottom. If your device is not supported, feel free to contribute. We automatically detect all devices we currently support and try to generate useful names. If you enable name-resolving, we try to fetch names from Metadata (Homegear), via JSON-RPC or the XML-API you may have installed on your CCU. Since this may fail this is disabled by default. You can manually rename the created entities by using Home Assistant's [Customizing](/docs/configuration/customizing-devices/) feature. With it you are also able to hide entities you don't want to see in the UI. @@ -89,7 +89,7 @@ homematic: host: 127.0.0.1 username: Admin password: secret - + ``` ### {% linkable_title The `resolvenames` option %} @@ -110,7 +110,7 @@ This does *not* affect the entities in Home Assistant. They all use their own co ### {% linkable_title Reading attributes of entities %} -Most devices have, besides their state, additional attributes like their battery state or valve position. These can be accessed using templates in automations, or even as their own entities using the [template sensor](https://home-assistant.io/components/sensor.template/) component. Here's an example of a template sensor that exposes the valve state of a thermostat. +Most devices have, besides their state, additional attributes like their battery state or valve position. These can be accessed using templates in automations, or even as their own entities using the [template sensor](/components/sensor.template/) component. Here's an example of a template sensor that exposes the valve state of a thermostat. ```yaml sensor: @@ -125,7 +125,7 @@ sensor: ### {% linkable_title Variables %} It is possible to read and set values of system variables you have setup on the CCU/Homegear. The supported types for setting values are float- and bool-variables. -The states of the variables are available through the attributes of your hub entity (e.g. `homematic.ccu2`). Use templates (as mentioned above) to make your variables available to automations or as entities. +The states of the variables are available through the attributes of your hub entity (e.g., `homematic.ccu2`). Use templates (as mentioned above) to make your variables available to automations or as entities. The values of variables are polled from the CCU/Homegear in an interval of 30 seconds. Setting the value of a variable happens instantly and is directly pushed. ### {% linkable_title Events %} @@ -137,7 +137,7 @@ When HomeMatic devices change their state or some other internal value, the CCU/ #### {% linkable_title Devices with buttons %} -Devices with buttons (e.g. HM-Sen-MDIR-WM55, remote controls) may not be fully visible in the UI. This is intended, as buttons don't serve any value here and all they do is trigger events. +Devices with buttons (e.g., HM-Sen-MDIR-WM55, remote controls) may not be fully visible in the UI. This is intended, as buttons don't serve any value here and all they do is trigger events. As an example: The HM-Sen-MDIR-WM55 motion detector will be displayed as 2 entities. A motion sensor and a brightness sensor. On top of that we have 2 sets (one set per button) of 4 events: PRESS_SHORT, PRESS_LONG, PRESS_CONT, PRESS_LONG_RELEASE. Be aware, that there are devices which don't provide all of these events. But in general: if you can press it, it usually at least has PRESS_SHORT. @@ -158,7 +158,7 @@ automation: ``` The channel parameter is equal to the channel of the button you are configuring the automation for. You can view the available channels in the UI you use to pair your devices. -The name depends on if you chose to resolve names or not. If not, it will be the device ID (e.g. LEQ1234657). If you chose to resolve names (and that is successful), it will be the name you have set in your CCU or in the metadata (e.g. "Kitchen Switch"). +The name depends on if you chose to resolve names or not. If not, it will be the device ID (e.g., LEQ1234657). If you chose to resolve names (and that is successful), it will be the name you have set in your CCU or in the metadata (e.g., "Kitchen Switch"). You can test whether your button works within Home Assistant if you look at the terminal output. When pressing a button, lines similar to those should appear: diff --git a/source/_components/homematicip_cloud.markdown b/source/_components/homematicip_cloud.markdown new file mode 100644 index 0000000000..c2f5320aa7 --- /dev/null +++ b/source/_components/homematicip_cloud.markdown @@ -0,0 +1,42 @@ +--- +layout: page +title: "HomematicIP Cloud" +description: "Instructions for integrating HomematicIP into Home Assistant." +date: 2018-04-02 13:40 +sidebar: true +comments: false +sharing: true +footer: true +ha_category: Hub +ha_iot_class: "Cloud Polling" +ha_release: 0.66 +featured: false +--- + +The [HomematicIP](http://www.homematic-ip.com) component platform is used as an interface to the cloud server. +For for communication [homematicip-rest-api](https://github.com/coreGreenberet/homematicip-rest-api) is used. + +To set up the component: + +- generate the authentication token: +```yaml +generate_auth_token.py +``` + +- add the information to your `configuration.yaml` file: + +```yaml +homematicip_cloud: + - name: NAME + accesspoint: IDENTIFIER + authtoken: AUTHTOKEN +``` + +Configuration variables (global): + +- **name** (*Optional*): Name to identify your access point, this will be + used to prefix your device names. +- **accesspoint** (*Required*): This is the access point id (SGTIN) +- **authtoken** (*Required*): Authentification token generated with +`generate_auth_token.py`. + diff --git a/source/_components/http.markdown b/source/_components/http.markdown index 98ec03f5a0..8fddcfd5d9 100644 --- a/source/_components/http.markdown +++ b/source/_components/http.markdown @@ -35,13 +35,13 @@ Configuration variables: - **base_url** (*Optional*): The URL that Home Assistant is available on the internet. For example: `hass-example.duckdns.org:8123`. Defaults to the local IP address. The iOS app finds local installations, if you have an outside URL use this so that you can auto-fill when discovered in the app. - **ssl_certificate** (*Optional*): Path to your TLS/SSL certificate to serve Home Assistant over a secure connection. - **ssl_key** (*Optional*): Path to your TLS/SSL key to serve Home Assistant over a secure connection. -- **cors_allowed_origins** (*Optional*): A list of origin domain names to allow [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing) requests from. Enabling this will set the `Access-Control-Allow-Origin` header to the Origin header if it is found in the list, and the `Access-Control-Allow-Headers` header to `Origin, Accept, X-Requested-With, Content-type, X-HA-access`. You must provide the exact Origin, i.e. `https://home-assistant.io` will allow requests from `https://home-assistant.io` but __not__ `http://home-assistant.io`. +- **cors_allowed_origins** (*Optional*): A list of origin domain names to allow [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing) requests from. Enabling this will set the `Access-Control-Allow-Origin` header to the Origin header if it is found in the list, and the `Access-Control-Allow-Headers` header to `Origin, Accept, X-Requested-With, Content-type, X-HA-access`. You must provide the exact Origin, i.e. `https://www.home-assistant.io` will allow requests from `https://www.home-assistant.io` but __not__ `http://www.home-assistant.io`. - **use_x_forwarded_for** (*Optional*): Enable parsing of the `X-Forwarded-For` header, passing on the client's correct IP address in proxied setups. You should only enable this in a trustworthy network environment, as clients passing that header could easily spoof their source IP address. Defaults to False. - **trusted_networks** (*Optional*): List of trusted networks, consisting of IP addresses or networks, that are allowed to bypass password protection when accessing Home Assistant. It should be noted that if you use a reverse proxy, all requests to Home Assistant, regardless of source, will arrive from the reverse proxy IP address. Therefore in a reverse proxy scenario, this option should be used with extreme care. - **ip_ban_enabled** (*Optional*): Flag indicating whether additional IP filtering is enabled. Defaults to False. - **login_attempts_threshold** (*Optional*): Number of failed login attempt from single IP after which it will be automatically banned if `ip_ban_enabled` is True. Defaults to -1, meaning that no new automatic bans will be added. -The sample below shows a configuration entry with possible values: +The sample below shows a configuration entry with possible values: ```yaml # Example configuration.yaml entry @@ -52,7 +52,7 @@ http: ssl_key: /etc/letsencrypt/live/hass.example.com/privkey.pem cors_allowed_origins: - https://google.com - - https://home-assistant.io + - https://www.home-assistant.io use_x_forwarded_for: True trusted_networks: - 127.0.0.1 @@ -69,23 +69,29 @@ Or use a self signed certificate following the instructions here [Self-signed ce On top of the `http` component is a [REST API](/developers/rest_api/), [Python API](/developers/python_api/) and [WebSocket API](/developers/websocket_api/) available. There is also support for [Server-sent events](/developers/server_sent_events/). -The `http` platforms are not real platforms within the meaning of the terminology used around Home Assistant. Home Assistant's [REST API](/developers/rest_api/) sends and receives messages over HTTP. +The `http` platforms are not real platforms within the meaning of the terminology used around Home Assistant. Home Assistant's [REST API](/developers/rest_api/) sends and receives messages over HTTP. To use those kind of [sensors](/components/sensor.http/) or [binary sensors](components/binary_sensor.http/) in your installation no configuration in Home Assistant is needed. All configuration is done on the devices themselves. This means that you must be able to edit the target URL or endpoint and the payload. The entity will be created after the first message has arrived. All [requests](/developers/rest_api/#post-apistatesltentity_id) need to be sent to the endpoint of the device and must be **POST**. -If you want to use Home Assistant to host or serve static files then create a directory called `www` under the `.homeassistant` configuration path. The static files in `.homeassistant/www/` can be accessed by the following URL `http://your.domain:8123/local/`. - -If you want to apply additional IP filtering, and automatically ban brute force attempts, set `ip_ban_enabled` to `True` and the maximum number of attempts. After the first ban, an `ip_bans.yaml` file will be created in the root configuration folder. It will have the banned IP address and time in UTC when it was added: +If you want to apply additional IP filtering, and automatically ban brute force attempts, set `ip_ban_enabled` to `True` and the maximum number of attempts. After the first ban, an `ip_bans.yaml` file will be created in the root configuration folder. It will have the banned IP address and time in UTC when it was added: ```yaml 127.0.0.1: banned_at: '2016-11-16T19:20:03' ``` -After a ban is added a Persistent Notification is populated to the Home Assistant frontend. +After a ban is added a Persistent Notification is populated to the Home Assistant frontend.

-Please note, that sources from `trusted_networks` won't be banned automatically. +Please note, that sources from `trusted_networks` won't be banned automatically. +

+ +## {% linkable_title Hosting files %} + +If you want to use Home Assistant to host or serve static files then create a directory called `www` under the configuration path (`/config` on Hass.io, `.homeassistant` elsewhere). The static files in `www/` can be accessed by the following URL `http://your.domain:8123/local/`, for example `audio.mp3` would be accessed as `http://your.domain:8123/local/audio.mp3`. + +

+ If you've had to create the `www/` folder for the first time, you'll need to restart Home Assistant.

diff --git a/source/_components/hue.markdown b/source/_components/hue.markdown index fb73a05824..f172c6b0ff 100644 --- a/source/_components/hue.markdown +++ b/source/_components/hue.markdown @@ -33,12 +33,20 @@ hue: Configuration variables: -- **host** (*Optional*): IP address of the device, eg. 192.168.1.10. Required if not using the `discovery` component to discover Hue bridges. +- **host**: IP address of the device, eg. 192.168.1.10. Required if not using the `discovery` component to discover Hue bridges. - **allow_unreachable** (*Optional*): (true/false) This will allow unreachable bulbs to report their state correctly. - **filename** (*Optional*): Make this unique if specifying multiple Hue hubs. -- **allow_in_emulated_hue** (*Optional*): (true/false) Enable this to block all Hue entities from being added to the `emulated_hue` component. - **allow_hue_groups** (*Optional*): (true/false) Enable this to stop Home Assistant from importing the groups defined on the Hue bridge. +```yaml +# Example configuration.yaml entry specifying optional parameters +hue: + bridges: + - host: DEVICE_IP_ADDRESS + allow_unreachable: true + allow_hue_groups: true +``` + ### {% linkable_title Migrating from older configuration %} In previous versions of the Hue component the configuration looked different: diff --git a/source/_components/ifttt.manything.markdown b/source/_components/ifttt.manything.markdown index 7288afb90b..84d0228bc1 100644 --- a/source/_components/ifttt.manything.markdown +++ b/source/_components/ifttt.manything.markdown @@ -1,7 +1,7 @@ --- layout: page title: "ManyThing" -description: "Instructions how to setup ManyThing support with IFTTT." +description: "Instructions on how to setup ManyThing support with IFTTT." date: 2015-09-07 18:00 sidebar: true comments: false diff --git a/source/_components/ifttt.markdown b/source/_components/ifttt.markdown index 764138d272..9f48303946 100644 --- a/source/_components/ifttt.markdown +++ b/source/_components/ifttt.markdown @@ -1,7 +1,7 @@ --- layout: page title: "IFTTT" -description: "Instructions how to setup IFTTT within Home Assistant." +description: "Instructions on how to setup IFTTT within Home Assistant." date: 2015-09-07 18:00 sidebar: true comments: false @@ -21,7 +21,7 @@ ifttt: key: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx ``` -`key` is your API key which can be obtained by viewing the **Settings** of the [Webhooks applet](https://ifttt.com/services/maker_webhooks/settings). It's the last part of the URL (e.g. https://maker.ifttt.com/use/MYAPIKEY) you will find under **My Applets** > **Webhooks** > **Settings**. +`key` is your API key which can be obtained by viewing the **Settings** of the [Webhooks applet](https://ifttt.com/services/maker_webhooks/settings). It's the last part of the URL (e.g., https://maker.ifttt.com/use/MYAPIKEY) you will find under **My Applets** > **Webhooks** > **Settings**.

diff --git a/source/_components/image_processing.dlib_face_detect.markdown b/source/_components/image_processing.dlib_face_detect.markdown index 6673146847..f427590256 100644 --- a/source/_components/image_processing.dlib_face_detect.markdown +++ b/source/_components/image_processing.dlib_face_detect.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Dlib Face Detect" -description: "Instructions how to integrate Dlib Face Detect into Home Assistant." +description: "Instructions on how to integrate Dlib Face Detect into Home Assistant." date: 2017-05-05 00:00 sidebar: true comments: false diff --git a/source/_components/image_processing.dlib_face_identify.markdown b/source/_components/image_processing.dlib_face_identify.markdown index 4f3d267f53..34690d6b8f 100644 --- a/source/_components/image_processing.dlib_face_identify.markdown +++ b/source/_components/image_processing.dlib_face_identify.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Dlib Face Identify" -description: "Instructions how to integrate Dlib Face Identify into Home Assistant." +description: "Instructions on how to integrate Dlib Face Identify into Home Assistant." date: 2017-01-25 00:00 sidebar: true comments: false @@ -13,7 +13,7 @@ featured: false ha_release: 0.44 --- -The `dlib_face_identify` image processing platform allows you to use the [Dlib](http://www.dlib.net/) through Home Assistant. This platform allow you to identify persons on camera and fire a event with identify persons. +The `dlib_face_identify` image processing platform allows you to use the [Dlib](http://www.dlib.net/) through Home Assistant. This platform allow you to identify persons on camera and fire an event with identify persons. For using the result inside an automation rule, take a look at the [component](/components/image_processing/) page. diff --git a/source/_components/image_processing.markdown b/source/_components/image_processing.markdown index 6f010ebad2..1f1507bf28 100644 --- a/source/_components/image_processing.markdown +++ b/source/_components/image_processing.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Image Processing" -description: "Instructions how to setup image processing with Home Assistant." +description: "Instructions on how to setup image processing with Home Assistant." date: 2017-01-09 00:00 sidebar: true comments: false diff --git a/source/_components/image_processing.microsoft_face_detect.markdown b/source/_components/image_processing.microsoft_face_detect.markdown index 39aecb1534..06cca72d26 100644 --- a/source/_components/image_processing.microsoft_face_detect.markdown +++ b/source/_components/image_processing.microsoft_face_detect.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Microsoft Face Detect" -description: "Instructions how to integrate Microsoft Face Detect into Home Assistant." +description: "Instructions on how to integrate Microsoft Face Detect into Home Assistant." date: 2017-01-25 00:00 sidebar: true comments: false diff --git a/source/_components/image_processing.microsoft_face_identify.markdown b/source/_components/image_processing.microsoft_face_identify.markdown index 76fb2ad1be..eb6d0a110f 100644 --- a/source/_components/image_processing.microsoft_face_identify.markdown +++ b/source/_components/image_processing.microsoft_face_identify.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Microsoft Face Identify" -description: "Instructions how to integrate Microsoft Face Identify into Home Assistant." +description: "Instructions on how to integrate Microsoft Face Identify into Home Assistant." date: 2017-01-25 00:00 sidebar: true comments: false diff --git a/source/_components/image_processing.openalpr_cloud.markdown b/source/_components/image_processing.openalpr_cloud.markdown index 3a13097c87..96e180a705 100644 --- a/source/_components/image_processing.openalpr_cloud.markdown +++ b/source/_components/image_processing.openalpr_cloud.markdown @@ -1,7 +1,7 @@ --- layout: page title: "OpenALPR Cloud" -description: "Instructions how to integrate licences plates with OpenALPR cloud into Home Assistant." +description: "Instructions on how to integrate licences plates with OpenALPR cloud into Home Assistant." date: 2017-01-09 00:00 sidebar: true comments: false @@ -13,7 +13,7 @@ featured: false ha_release: 0.36 --- -[OpenALPR](http://www.openalpr.com/) integration for Home Assistant allows you to process licences plates from a camera. You can use them to open a garage door or trigger any other [automation](https://home-assistant.io/components/automation/). +[OpenALPR](http://www.openalpr.com/) integration for Home Assistant allows you to process licences plates from a camera. You can use them to open a garage door or trigger any other [automation](/components/automation/). For using the result inside an automation rule, take a look at the [component](/components/image_processing/) page. diff --git a/source/_components/image_processing.openalpr_local.markdown b/source/_components/image_processing.openalpr_local.markdown index 593a921261..d5da4bab3e 100644 --- a/source/_components/image_processing.openalpr_local.markdown +++ b/source/_components/image_processing.openalpr_local.markdown @@ -1,7 +1,7 @@ --- layout: page title: "OpenALPR Local" -description: "Instructions how to integrate licences plates with OpenALPR local into Home Assistant." +description: "Instructions on how to integrate licences plates with OpenALPR local into Home Assistant." date: 2017-01-09 00:00 sidebar: true comments: false @@ -14,7 +14,7 @@ ha_release: 0.36 redirect_from: /components/openalpr/ --- -[OpenALPR](http://www.openalpr.com/) integration for Home Assistant allows you to process licences plates from a camera. You can use them to open a garage door or trigger any other [automation](https://home-assistant.io/components/automation/). +[OpenALPR](http://www.openalpr.com/) integration for Home Assistant allows you to process licences plates from a camera. You can use them to open a garage door or trigger any other [automation](/components/automation/). For using inside automation look on [component](/components/image_processing) page. diff --git a/source/_components/image_processing.opencv.markdown b/source/_components/image_processing.opencv.markdown index db6bfd2d5c..9e485ec6c3 100644 --- a/source/_components/image_processing.opencv.markdown +++ b/source/_components/image_processing.opencv.markdown @@ -1,7 +1,7 @@ --- layout: page title: "OpenCV" -description: "Instructions how to integrate OpenCV image processing into Home Assistant." +description: "Instructions on how to integrate OpenCV image processing into Home Assistant." date: 2017-01-25 00:00 sidebar: true comments: false diff --git a/source/_components/image_processing.seven_segments.markdown b/source/_components/image_processing.seven_segments.markdown index 13249bc52b..a5944d821b 100644 --- a/source/_components/image_processing.seven_segments.markdown +++ b/source/_components/image_processing.seven_segments.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Seven segments display" -description: "Instructions how to use OCR for seven segments displays into Home Assistant." +description: "Instructions on how to use OCR for seven segments displays into Home Assistant." date: 2017-05-18 08:00 sidebar: true comments: false diff --git a/source/_components/influxdb.markdown b/source/_components/influxdb.markdown index 3f606caf03..9df07711f8 100644 --- a/source/_components/influxdb.markdown +++ b/source/_components/influxdb.markdown @@ -27,7 +27,7 @@ You will still need to create a database named `home_assistant` via InfluxDB's c Configuration variables: -- **host** (*Optional*): IP address of your database host, e.g. 192.168.1.10. Defaults to `localhost`. +- **host** (*Optional*): IP address of your database host, e.g., 192.168.1.10. Defaults to `localhost`. - **port** (*Optional*): Port to use. Defaults to 8086. - **username** (*Optional*): The username of the database user. The user needs read/write privileges on the database. - **password** (*Optional*): The password for the database user account. @@ -37,7 +37,7 @@ Configuration variables: - **max_retries** (*Optional*): Allow the component to retry if there was a network error when transmitting data - **default_measurement** (*Optional*): Measurement name to use when an entity doesn't have a unit. Defaults to entity id. - **override_measurement** (*Optional*): Measurement name to use instead of unit or default measurement. This will store all data points in a single measurement. -- **component_config**, **component_config_domain**, **component_config_glob** (*Optional*): These attributes contains component-specific override values. See [Customizing devices and services](https://home-assistant.io/getting-started/customizing-devices/) for format. +- **component_config**, **component_config_domain**, **component_config_glob** (*Optional*): These attributes contains component-specific override values. See [Customizing devices and services](/getting-started/customizing-devices/) for format. - **override_measurement** (*Optional*): Measurement name to use for this component, takes precedence over the global 'override_measurement' and component-specific 'unit_of_measurement' attribute. - **exclude** (*Optional*): Configure which components should be excluded from recording to InfluxDB. - **entities** (*Optional*): The list of entity ids to be excluded from recording to InfluxDB. diff --git a/source/_components/input_boolean.markdown b/source/_components/input_boolean.markdown index ff2aa46ca8..b2b23aeeff 100644 --- a/source/_components/input_boolean.markdown +++ b/source/_components/input_boolean.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Input Boolean" -description: "Instructions how to integrate the Input Boolean component into Home Assistant." +description: "Instructions on how to integrate the Input Boolean component into Home Assistant." date: 2016-01-17 16:58 sidebar: true comments: false diff --git a/source/_components/input_datetime.markdown b/source/_components/input_datetime.markdown index 19898029df..462b309e7e 100644 --- a/source/_components/input_datetime.markdown +++ b/source/_components/input_datetime.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Input Datetime" -description: "Instructions how to integrate the Input Datetime component into Home Assistant." +description: "Instructions on how to integrate the Input Datetime component into Home Assistant." date: 2017-09-14 16:01 sidebar: true comments: false diff --git a/source/_components/input_number.markdown b/source/_components/input_number.markdown index 7afaaa255e..44d819c39c 100644 --- a/source/_components/input_number.markdown +++ b/source/_components/input_number.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Input Number" -description: "Instructions how to integrate the Input Number component into Home Assistant." +description: "Instructions on how to integrate the Input Number component into Home Assistant." date: 2017-09-19 03:30 sidebar: true comments: false diff --git a/source/_components/input_select.markdown b/source/_components/input_select.markdown index bf25b89d5f..8e59002ccf 100644 --- a/source/_components/input_select.markdown +++ b/source/_components/input_select.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Input Select" -description: "Instructions how to integrate the Input Select component into Home Assistant." +description: "Instructions on how to integrate the Input Select component into Home Assistant." date: 2016-02-02 17:00 sidebar: true comments: false diff --git a/source/_components/input_text.markdown b/source/_components/input_text.markdown index d0afd0ff09..284ab5ea36 100644 --- a/source/_components/input_text.markdown +++ b/source/_components/input_text.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Input Text" -description: "Instructions how to integrate the Input Text component into Home Assistant." +description: "Instructions on how to integrate the Input Text component into Home Assistant." date: 2016-03-15 06:00 sidebar: true comments: false diff --git a/source/_components/insteon_hub.markdown b/source/_components/insteon_hub.markdown index 03bf4b8a6e..5c9813bc5c 100644 --- a/source/_components/insteon_hub.markdown +++ b/source/_components/insteon_hub.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Insteon Hub" -description: "Instructions how to setup the Insteon Hub within Home Assistant." +description: "Instructions on how to setup the Insteon Hub within Home Assistant." date: 2016-01-27 08:00 sidebar: true comments: false @@ -32,6 +32,6 @@ insteon_hub: Configuration variables: -- **username** (*Required*): The username used to access the Insteon interface (e.g. the [connect.insteon.com](http://connect.insteon.com/) site). +- **username** (*Required*): The username used to access the Insteon interface (e.g., the [connect.insteon.com](http://connect.insteon.com/) site). - **password** (*Required*): The password used to access the Insteon interface. - **api_key** (*Required*): The Insteon REST API key emailed to you once you are approved in the Insteon Developer program. diff --git a/source/_components/insteon_local.markdown b/source/_components/insteon_local.markdown index fba1087171..40ed93c1d5 100644 --- a/source/_components/insteon_local.markdown +++ b/source/_components/insteon_local.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Insteon (local)" -description: "Instructions how to setup the Insteon Hub locally within Home Assistant." +description: "Instructions on how to setup the Insteon Hub locally within Home Assistant." date: 2016-12-18 08:00 sidebar: true comments: false diff --git a/source/_components/insteon_plm.markdown b/source/_components/insteon_plm.markdown index e3fb65bcc9..9e15bb0f7d 100644 --- a/source/_components/insteon_plm.markdown +++ b/source/_components/insteon_plm.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Insteon PLM" -description: "Instructions how to setup an Insteon USB PLM locally within Home Assistant." +description: "Instructions on how to setup an Insteon USB PLM locally within Home Assistant." date: 2017-02-19 16:00 sidebar: true comments: false @@ -39,7 +39,7 @@ insteon_plm: product_key: PRODUCT_KEY ``` Configuration variables: -- **port** (*Required*): The port for your device, e.g. `/dev/ttyUSB0` +- **port** (*Required*): The port for your device, e.g., `/dev/ttyUSB0` - **device_override** (*Optional*): Override the default device definition - *ADDRESS* is found on the device itself in the form 1A.2B.3C or 1a2b3c - *CATEGORY* is found in the back of the device's User Guide in the form of @@ -63,26 +63,52 @@ a responder or a controller. In order for any two Insteon devices to talk with one another, they must be linked. For an overview of device linking please read the Insteon page on -[understanding linking]. Currently Insteon PLM does not support software -linking of devices. If you need software that can link your devices (if you -are using a USB Stick PLM for example), you can download [HouseLinc] which runs -on any Windows PC, or you can use [Insteon Terminal] which is open source and -runs on most platforms. HouseLinc is no longer supported by SmartHome but it -still works. Insteon Terminal is a very useful tool but please read the -disclaimers carefully, they are important. +[understanding linking]. The Insteon PLM module supports All-Linking through +[Development Tools] service calls. The following services are available: + +In order for any two Insteon devices to talk with one another, they must be +linked. For an overview of device linking, please read the Insteon page on +[understanding linking]. The Insteon PLM module supports All-Linking through +[Development Tools] service calls. The following services are available: +- **insteon_plm.add_all_link**: Tells the Insteon Modem (IM) start All-Linking +mode. Once the IM is in All-Linking mode, press the link button on the device +to complete All-Linking. +- **insteon_plm.delete_all_link**: Tells the Insteon Modem (IM) to remove an +All-Link record from the All-Link Database of the IM and a device. Once the IM +is set to delete the link, press the link button on the corresponding device +to complete the process. +- **insteon_plm.load_all_link_database**: Load the All-Link Database for a +device. WARNING - Loading a device All-Link database is very time consuming +and inconsistent. This may take a LONG time and may need to be repeated to +obtain all records. +- **insteon_plm.print_all_link_database**: Print the All-Link Database for a +device. Requires that the All-Link Database is loaded into memory. +- **insteon_plm.print_im_all_link_database**: Print the All-Link Database for +the INSTEON Modem (IM). + +If you are looking for more advanced options, you can use the +[insteonplm_interactive] command line tool that is distributed with the +[insteonplm] Python module. Please see the documentation on the [insteonplm] +GitHub site. Alternatively, you can download [HouseLinc] which runs on any +Windows PC, or you can use [Insteon Terminal] which is open source and runs +on most platforms. SmartHome no longer supports HouseLinc, but it still +works. Insteon Terminal is a very useful tool but please read the disclaimers +carefully, they are important. [understanding linking]: http://www.insteon.com/support-knowledgebase/2015/1/28/understanding-linking +[Development Tools]: https://www.home-assistant.io/docs/tools/dev-tools/ [HouseLinc]: https://www.smarthome.com/houselinc.html [Insteon Terminal]: https://github.com/pfrommerd/insteon-terminal +[insteonplm_interactive]: https://github.com/nugget/python-insteonplm#command-line-interface ### {% linkable_title Customization %} -The only configuration item that is absolutely necessary is the port so that -Home Assistant can connect to the PLM. This will expose all the supported INSTEON -devices which exist in the modem's ALL-Link database. However, devices will -only be shown by their INSTEON hex address (e.g. "1A.2B.3C") which can be a bit -unwieldy. As you link and unlink devices using the 'Set' buttons, they'll be -added and removed from Home Assistant automatically. +The only configuration item that is absolutely necessary is the port so that +Home Assistant can connect to the PLM. This will expose all the supported +INSTEON devices which exist in the modem’s ALL-Link database. However, devices +will only be shown by their INSTEON hex address (e.g., “1A.2B.3C”) which can +be a bit unwieldy. As you link and unlink devices using the ‘Set’ buttons, +they’ll be added and removed from Home Assistant automatically. You can use the normal Home Assistant [device customization] section of your configuration to assign friendly names and special icons to your devices. This @@ -123,7 +149,9 @@ insteon_plm: cat: 0x10 subcat: 0x11 ``` + ### {% linkable_title What NOT to do %} + Insteon PLM is a top level component and device discovery will identify the Home Assistant platform the device belongs in. As such, do not declare Insteon devices in other platforms. For example, this configuration @@ -134,4 +162,3 @@ light: - platform: insteon_plm address: 1a2b3c ``` - diff --git a/source/_components/ios.markdown b/source/_components/ios.markdown new file mode 100644 index 0000000000..44ac2fa88e --- /dev/null +++ b/source/_components/ios.markdown @@ -0,0 +1,17 @@ +--- +layout: page +title: "iOS" +description: "Instructions on how to use the iOS companion app with Home Assistant." +date: 2018-04-06 08:00 +sidebar: true +comments: false +sharing: true +footer: true +logo: apple.png +ha_category: Hub +featured: false +ha_release: 0.31 +ha_iot_class: depends +--- + +The `ios` component is the Home Assistant part for using the iOS companion app. For further details please check the [iOS section](/docs/ecosystem/ios/) in the documentation for further details. diff --git a/source/_components/isy994.markdown b/source/_components/isy994.markdown index 558765a764..211917fe56 100644 --- a/source/_components/isy994.markdown +++ b/source/_components/isy994.markdown @@ -1,7 +1,7 @@ --- layout: page title: "ISY994 Controller" -description: "Instructions how to setup the ISY994 controller within Home Assistant." +description: "Instructions on how to setup the ISY994 controller within Home Assistant." date: 2015-01-20 22:36 sidebar: true comments: false @@ -45,7 +45,7 @@ Once the ISY controller is configured, it will automatically import any binary s An Insteon door/window sensor will show up as a single Binary Sensor rather than two discrete devices like it does in the ISY994 admin panel. Note that when in "Two Nodes" mode, the sensor will have an UNKNOWN state until the sensor changes for the first time since the last Home Assistant reboot. If you do not use Insteon scenes that are controlled directly from the door sensor, you may prefer to set the sensor to "One Node" mode using the ISY Admin Panel. -Each Insteon leak sensor will also show up as a single Binary Sensor as opposed to the two nodes seen in the ISY994. The name of the device will be based on what the parent node is named in the ISY994, which is typically the one with "-Dry" at the end of the name. This may be confusing, because "On" means wet in Home Assistant. You can rename this node either in the ISY994 Admin Panel (which will change the entity_id in Home Assistant) or assign a `friendly_name` in the [Customization section](https://home-assistant.io/docs/configuration/customizing-devices/) of your configuration. +Each Insteon leak sensor will also show up as a single Binary Sensor as opposed to the two nodes seen in the ISY994. The name of the device will be based on what the parent node is named in the ISY994, which is typically the one with "-Dry" at the end of the name. This may be confusing, because "On" means wet in Home Assistant. You can rename this node either in the ISY994 Admin Panel (which will change the entity_id in Home Assistant) or assign a `friendly_name` in the [Customization section](/docs/configuration/customizing-devices/) of your configuration. If your leak or door/window sensor supports heartbeats, a new binary_sensor device will be added to Home Assistant to represent the battery state. The sensor will stay "Off" so long as the daily heartbeats occur. If a heartbeat is missed, the sensor will flip to "On". The name of this device will be based on the heartbeat node in the ISY. @@ -125,7 +125,7 @@ My Programs ``` A device is created by creating a directory, with the name for the device, under any of the following root directories: - * *HA.binary_sensor* will create a binary sensor (see [Customizing Devices](https://home-assistant.io/getting-started/customizing-devices/) to set the sensor class) + * *HA.binary_sensor* will create a binary sensor (see [Customizing Devices](/getting-started/customizing-devices/) to set the sensor class) * *HA.cover* will create a cover * *HA.fan* will create a fan * *HA.lock* will create a lock diff --git a/source/_components/juicenet.markdown b/source/_components/juicenet.markdown index 5015022c55..74cc2fdb89 100644 --- a/source/_components/juicenet.markdown +++ b/source/_components/juicenet.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Juicenet" -description: "Instructions how to setup WiFi-equipped Juicenet charging stations with Home Assistant." +description: "Instructions on how to setup WiFi-equipped Juicenet charging stations with Home Assistant." date: 2017-05-20 22:00 sidebar: true comments: false @@ -15,10 +15,12 @@ ha_release: 0.47 The `juicenet` sensor platform pulls data from a [JuiceNet](https://emotorwerks.com/products/juicenet/) charging station equipped with a wifi connection. It will access and make available all of the devices attached to your account. +## {% linkable_title Configuration %} + To enable the platform in your installation, add the following to your `configuration.yaml` file: ```yaml -# Example configuration.yml entry +# Example configuration.yaml entry juicenet: access_token: ACCESS_TOKEN ``` diff --git a/source/_components/keyboard.markdown b/source/_components/keyboard.markdown index 07b3e2db26..00dad71931 100644 --- a/source/_components/keyboard.markdown +++ b/source/_components/keyboard.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Keyboard" -description: "Instructions how to simulate key presses with Home Assistant." +description: "Instructions on how to simulate key presses with Home Assistant." date: 2015-01-24 14:39 sidebar: true comments: false diff --git a/source/_components/keyboard_remote.markdown b/source/_components/keyboard_remote.markdown index f1d80bfa97..aeefd01e63 100644 --- a/source/_components/keyboard_remote.markdown +++ b/source/_components/keyboard_remote.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Keyboard Remote" -description: "Instructions how to use a keyboard to remote control Home Assistant." +description: "Instructions on how to use a keyboard to remote control Home Assistant." date: 2016-09-28 14:39 sidebar: true comments: false diff --git a/source/_components/kira.markdown b/source/_components/kira.markdown index d2c2594834..b32ae95eac 100644 --- a/source/_components/kira.markdown +++ b/source/_components/kira.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Kira" -description: "Instructions how to integrate Keene Electronics IR over IP modules (Kira) into Home Assistant." +description: "Instructions on how to integrate Keene Electronics IR over IP modules (Kira) into Home Assistant." date: 2017-05-07 00:00 sidebar: true comments: false @@ -76,7 +76,7 @@ Configuration variables: - **type** (*Optional*): The type of this code. If this field is omitted, the type will be autodetected if possible. - **repeat** (*Optional*): The number of times to repeat this code (on transmit). Default is 1. -Some manufacturers (e.g. Samsung) require an IR code to be sent a number of times in a row in rapid succession (usually 3). This doesn't apply to the vast majority of devices, but it can be helpful if needed. +Some manufacturers (e.g., Samsung) require an IR code to be sent a number of times in a row in rapid succession (usually 3). This doesn't apply to the vast majority of devices, but it can be helpful if needed. ### {% linkable_title Code Types %} diff --git a/source/_components/knx.markdown b/source/_components/knx.markdown index ee731d020d..7acfae7676 100644 --- a/source/_components/knx.markdown +++ b/source/_components/knx.markdown @@ -115,8 +115,8 @@ knx: address: '0/0/23' ``` -* **type**: Type of the exposed value. Either time or datetime or any supported type of [KNX Sensor](/components/sensor.knx/) (e.g. "temperature" or "humidity"). -* **entity_id**: Entity id of the HASS component to be exposed. Not necessarry for types time and datetime. +* **type**: Type of the exposed value. Either time or datetime or any supported type of [KNX Sensor](/components/sensor.knx/) (e.g., "temperature" or "humidity"). +* **entity_id**: Entity id of the HASS component to be exposed. Not necessary for types time and datetime. * **address**: KNX group address. diff --git a/source/_components/light.abode.markdown b/source/_components/light.abode.markdown index bb6d597dee..f362107791 100644 --- a/source/_components/light.abode.markdown +++ b/source/_components/light.abode.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Abode Light" -description: "Instructions how to integrate Abode lights into Home Assistant." +description: "Instructions on how to integrate Abode lights into Home Assistant." date: 2017-08-26 13:28 sidebar: true comments: false diff --git a/source/_components/light.ads.markdown b/source/_components/light.ads.markdown index b5188cf33e..aaedc1c12f 100644 --- a/source/_components/light.ads.markdown +++ b/source/_components/light.ads.markdown @@ -1,7 +1,7 @@ --- layout: page title: "ADS Light" -description: Instructions how to set up ADS lights within Home Assistant +description: Instructions on how to set up ADS lights within Home Assistant date: 2017-10-25 10:00 sidebar: true comments: false diff --git a/source/_components/light.avion.markdown b/source/_components/light.avion.markdown index 74260e9395..68c40b1aac 100644 --- a/source/_components/light.avion.markdown +++ b/source/_components/light.avion.markdown @@ -21,8 +21,6 @@ To enable these lights, add the following lines to your `configuration.yaml` fil # Example configuration.yaml entry light: - platform: avion - username: testuser@fakedomain.com - password: foobar ``` Configuration variables: diff --git a/source/_components/light.blinksticklight.markdown b/source/_components/light.blinksticklight.markdown index 9deab2be84..c11da280ac 100644 --- a/source/_components/light.blinksticklight.markdown +++ b/source/_components/light.blinksticklight.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Blinkstick" -description: "Instructions how to setup Blinkstick lights within Home Assistant." +description: "Instructions on how to setup Blinkstick lights within Home Assistant." date: 2015-10-08 10:00 sidebar: true comments: false diff --git a/source/_components/light.blinkt.markdown b/source/_components/light.blinkt.markdown index 617e81cac2..ad2d6200f8 100644 --- a/source/_components/light.blinkt.markdown +++ b/source/_components/light.blinkt.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Blinkt!" -description: "Instructions how to setup Blinkt! RGB LED lights within Home Assistant." +description: "Instructions on how to setup Blinkt! RGB LED lights within Home Assistant." date: 2017-04-30 9:00 sidebar: true comments: false diff --git a/source/_components/light.decora_wifi.markdown b/source/_components/light.decora_wifi.markdown index cf2c555626..7fc68d0dcf 100644 --- a/source/_components/light.decora_wifi.markdown +++ b/source/_components/light.decora_wifi.markdown @@ -26,13 +26,18 @@ To enable these lights, add the following lines to your `configuration.yaml` fil # Example configuration.yaml entry light: - platform: decora_wifi - username: my_leviton_user_email@email.com - password: my_leviton_password + username: YOUR_USERNAME + password: YOUR_PASSWORD ``` -Configuration variables: - -- **username** (*Required*): Your "My Leviton" app email address/user name. -- **password** (*Required*): Your "My Leviton" app password. - +{% configuration %} +username: + description: Your "My Leviton" app email address/user name. + required: true + type: string +password: + description: Your "My Leviton" app password. + required: true + type: string +{% endconfiguration %} diff --git a/source/_components/light.eufy.markdown b/source/_components/light.eufy.markdown new file mode 100644 index 0000000000..d8596c0048 --- /dev/null +++ b/source/_components/light.eufy.markdown @@ -0,0 +1,19 @@ +--- +layout: page +title: "Eufy Lights" +description: "Instructions on how to integrate Eufy LED lights into Home Assistant." +date: 2018-04-09 19:00 +sidebar: true +comments: false +sharing: true +footer: true +logo: eufy.png +ha_category: Light +ha_iot_class: "Local Polling" +ha_release: 0.68 +--- + +The `eufy` platform allows you to control your [Eufy](http://www.eufylife.com) lights from within Home Assistant. + +They will be automatically discovered if the [Eufy](/components/eufy/) component is enabled. + diff --git a/source/_components/light.flux_led.markdown b/source/_components/light.flux_led.markdown index e74e6942d9..871ba222e2 100644 --- a/source/_components/light.flux_led.markdown +++ b/source/_components/light.flux_led.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Flux Led/MagicLight" -description: "Instructions how to setup Flux led/MagicLight within Home Assistant." +description: "Instructions on how to setup Flux led/MagicLight within Home Assistant." date: 2015-07-17 20:09 sidebar: true comments: false diff --git a/source/_components/light.greenwave.markdown b/source/_components/light.greenwave.markdown index a0cba942d4..16f8e16099 100644 --- a/source/_components/light.greenwave.markdown +++ b/source/_components/light.greenwave.markdown @@ -27,7 +27,7 @@ light: host: XXX.XXX.XXX.XXX version: 3 ``` -The version option is the major revision of your firmware, which should be 2 or 3. If you are running Version 2, there are no extra steps. If you are running Version 3, you must press the Sync button on the gateway prior to the first launch of Home Assistant, so a token can be grabbed. Once home assistant has started, you can either press the Sync button again or wait for it to time out manually. +The version option is the major revision of your firmware, which should be 2 or 3. If you are running Version 2, there are no extra steps. If you are running Version 3, you must press the Sync button on the gateway prior to the first launch of Home Assistant, so a token can be grabbed. Once Home Assistant has started, you can either press the Sync button again or wait for it to time out manually. {% configuration %} host: diff --git a/source/_components/light.group.markdown b/source/_components/light.group.markdown index 2b4d303576..4ec8262463 100644 --- a/source/_components/light.group.markdown +++ b/source/_components/light.group.markdown @@ -46,3 +46,18 @@ Example of the light group "Kitchen Lights".

The supported features of all lights will be added together. For example, if you have one RGB light in a group of otherwise brightness-only lights, the light group will be shown with a color picker. + +## {% linkable_title Script Example %} + +Here's an example of a script using the above light group. + +```yaml +script: + turn_on_kitchen_lights: + alias: Kitchen lights on + sequence: + service: light.turn_on + data: + entity_id: light.kitchen_lights + brightness: 100 +``` diff --git a/source/_components/light.hive.markdown b/source/_components/light.hive.markdown index 78daeb5641..44221f6371 100644 --- a/source/_components/light.hive.markdown +++ b/source/_components/light.hive.markdown @@ -14,12 +14,13 @@ ha_iot_class: "Cloud Polling" --- -The 'hive' light component integrates your Hive lights into Home Assistant, enabling control of various settings, depending on the model light. +The `hive` light platform integrates your Hive lights into Home Assistant, enabling control of various settings, depending on the model light. -The Hive light component supports the following Hive products: -- **Hive Active Light Dimmable** -- **Hive Active Light Cool to Warm White** -- **Hive Active Light Color Changing** +The platform supports the following Hive products: + +- Hive Active Light Dimmable +- Hive Active Light Cool to Warm White +- Hive Active Light Color Changing

diff --git a/source/_components/light.homekit_controller.markdown b/source/_components/light.homekit_controller.markdown new file mode 100644 index 0000000000..f3f7243a10 --- /dev/null +++ b/source/_components/light.homekit_controller.markdown @@ -0,0 +1,16 @@ +--- +layout: page +title: "HomeKit Light" +description: "Instructions how to setup HomeKit lights within Home Assistant." +date: 2017-03-19 21:08 +sidebar: true +comments: false +sharing: true +footer: true +logo: apple-homekit.png +ha_category: Light +ha_iot_class: "Local Polling" +ha_release: 0.68 +--- + +To get your HomeKit lights working with Home Assistant, follow the instructions for the general [HomeKit controller component](/components/homekit_controller/). diff --git a/source/_components/light.homematic.markdown b/source/_components/light.homematic.markdown index b2223ae9e4..86249ce98e 100644 --- a/source/_components/light.homematic.markdown +++ b/source/_components/light.homematic.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Homematic Light" -description: "Instructions how to integrate Homematic lights within Home Assistant." +description: "Instructions on how to integrate Homematic lights within Home Assistant." date: 2016-06-28 08:30 sidebar: true comments: false diff --git a/source/_components/light.hue.markdown b/source/_components/light.hue.markdown index 8cd9aad47e..59e8b8e970 100644 --- a/source/_components/light.hue.markdown +++ b/source/_components/light.hue.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Philips Hue Light" -description: "Instructions how to integrate Philips Hue lights into Home Assistant." +description: "Instructions on how to integrate Philips Hue lights into Home Assistant." date: 2015-03-23 20:09 sidebar: true comments: false diff --git a/source/_components/light.hyperion.markdown b/source/_components/light.hyperion.markdown index 7f3b23ad6c..7cba5e18f4 100644 --- a/source/_components/light.hyperion.markdown +++ b/source/_components/light.hyperion.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Hyperion" -description: "Instructions how to integrate Hyperion into Home Assistant." +description: "Instructions on how to integrate Hyperion into Home Assistant." date: 2015-10-25 22:43 sidebar: true comments: false diff --git a/source/_components/light.ihc.markdown b/source/_components/light.ihc.markdown index 741d2168cd..214f19564b 100644 --- a/source/_components/light.ihc.markdown +++ b/source/_components/light.ihc.markdown @@ -1,7 +1,7 @@ --- layout: page title: "IHC Light" -description: "Instructions how to integrate IHC lights within Home Assistant." +description: "Instructions on how to integrate IHC lights within Home Assistant." date: 2017-11-27 13:35 sidebar: true comments: false diff --git a/source/_components/light.insteon_hub.markdown b/source/_components/light.insteon_hub.markdown index 82c4df9aa5..f581706b92 100644 --- a/source/_components/light.insteon_hub.markdown +++ b/source/_components/light.insteon_hub.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Insteon Hub Light" -description: "Instructions how to setup the Insteon Hub Lights within Home Assistant." +description: "Instructions on how to setup the Insteon Hub Lights within Home Assistant." date: 2016-09-10 08:00 sidebar: true comments: false diff --git a/source/_components/light.insteon_local.markdown b/source/_components/light.insteon_local.markdown index 06af902dfd..b9aacb3250 100644 --- a/source/_components/light.insteon_local.markdown +++ b/source/_components/light.insteon_local.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Insteon (Local) Light" -description: "Instructions how to setup the Insteon Hub Lights locally within Home Assistant." +description: "Instructions on how to setup the Insteon Hub Lights locally within Home Assistant." date: 2016-12-18 08:00 sidebar: true comments: false diff --git a/source/_components/light.insteon_plm.markdown b/source/_components/light.insteon_plm.markdown index 04ab92bdee..65026cf576 100644 --- a/source/_components/light.insteon_plm.markdown +++ b/source/_components/light.insteon_plm.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Insteon PLM Light" -description: "Instructions how to setup Insteon PLM lights locally within Home Assistant." +description: "Instructions on how to setup Insteon PLM lights locally within Home Assistant." date: 2017-02-19 17:00 sidebar: true comments: false diff --git a/source/_components/light.isy994.markdown b/source/_components/light.isy994.markdown index 8ae450edfc..6c03413c8b 100644 --- a/source/_components/light.isy994.markdown +++ b/source/_components/light.isy994.markdown @@ -1,7 +1,7 @@ --- layout: page title: "ISY994 Light" -description: "Instructions how to integrate ISY994 lights into Home Assistant." +description: "Instructions on how to integrate ISY994 lights into Home Assistant." date: 2016-09-03 23:00 sidebar: true comments: false diff --git a/source/_components/light.lifx.markdown b/source/_components/light.lifx.markdown index 805cb67e68..04f444540f 100644 --- a/source/_components/light.lifx.markdown +++ b/source/_components/light.lifx.markdown @@ -1,7 +1,7 @@ --- layout: page title: "LIFX" -description: "Instructions how to integrate LIFX into Home Assistant." +description: "Instructions on how to integrate LIFX into Home Assistant." date: 2016-01-27 08:00 sidebar: true comments: false diff --git a/source/_components/light.litejet.markdown b/source/_components/light.litejet.markdown index d51cfd70c7..fedc9fa2be 100644 --- a/source/_components/light.litejet.markdown +++ b/source/_components/light.litejet.markdown @@ -1,7 +1,7 @@ --- layout: page title: "LiteJet Light" -description: "Instructions how to setup the LiteJet lights within Home Assistant." +description: "Instructions on how to setup the LiteJet lights within Home Assistant." date: 2016-10-26 13:00 sidebar: true comments: false diff --git a/source/_components/light.lutron.markdown b/source/_components/light.lutron.markdown index 3872b5373b..9e380e8d7c 100644 --- a/source/_components/light.lutron.markdown +++ b/source/_components/light.lutron.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Lutron Light" -description: "Instructions how to setup the Lutron lights within Home Assistant." +description: "Instructions on how to setup the Lutron lights within Home Assistant." date: 2017-04-30 09:00 sidebar: true comments: false diff --git a/source/_components/light.lutron_caseta.markdown b/source/_components/light.lutron_caseta.markdown index 02e15710d6..4c61accdc6 100644 --- a/source/_components/light.lutron_caseta.markdown +++ b/source/_components/light.lutron_caseta.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Lutron Caseta Light" -description: "Instructions how to setup the Lutron Caseta lights within Home Assistant." +description: "Instructions on how to setup the Lutron Caseta lights within Home Assistant." date: 2017-04-30 09:00 sidebar: true comments: false diff --git a/source/_components/light.markdown b/source/_components/light.markdown index 4370674890..5eb3083f2d 100644 --- a/source/_components/light.markdown +++ b/source/_components/light.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Lights" -description: "Instructions how to setup your lights with Home Assistant." +description: "Instructions on how to setup your lights with Home Assistant." date: 2015-01-24 14:39 sidebar: true comments: false @@ -19,26 +19,27 @@ The light component supports multiple entries in configuration.yaml Turns one light on or multiple lights on using [groups]({{site_root}}/components/group/). -Most lights do not support all attributes. You can check the platform documentation of your particular light for hints but in general you will have to try things out and see what works. +Most lights do not support all attributes. You can check the platform documentation of your particular light for hints, but in general, you will have to try things out and see what works. | Service data attribute | Optional | Description | | ---------------------- | -------- | ----------- | | `entity_id` | no | String or list of strings that point at `entity_id`s of lights. Else targets all. | `transition` | yes | Number that represents the time (in seconds) the light should take to transition to the new state. -| `profile` | yes | String with the name of one of the [built-in profiles](https://github.com/home-assistant/home-assistant/blob/master/homeassistant/components/light/light_profiles.csv) (relax, energize, concentrate, reading) or one of the custom profiles defined in `light_profiles.csv` in the current working directory. Light profiles define a xy color and a brightness. If a profile is given and a brightness then the profile brightness will be overwritten. -| `xy_color` | yes | A list containing two floats representing the xy color you want the light to be. Two comma separated floats that represent the color in XY. -| `rgb_color` | yes | A list containing three integers representing the rgb color you want the light to be. Three comma separated integers that represent the color in RGB. You can find a great chart here: [Hue Color Chart](http://www.developers.meethue.com/documentation/hue-xy-values) +| `profile` | yes | String with the name of one of the [built-in profiles](https://github.com/home-assistant/home-assistant/blob/master/homeassistant/components/light/light_profiles.csv) (relax, energize, concentrate, reading) or one of the custom profiles defined in `light_profiles.csv` in the current working directory. Light profiles define an xy color and a brightness. If a profile is given and a brightness then the profile brightness will be overwritten. +| `hs_color` | yes | A list containing two floats representing the hue and saturation of the color you want the light to be. Hue is scaled 0-360, and saturation is scaled 0-100. +| `xy_color` | yes | A list containing two floats representing the xy color you want the light to be. Two comma-separated floats that represent the color in XY. You can find a great chart here: [Hue Color Chart](https://developers.meethue.com/documentation/core-concepts#color_gets_more_complicated). +| `rgb_color` | yes | A list containing three integers between 0 and 255 representing the RGB color you want the light to be. Three comma-separated integers that represent the color in RGB. Note that the specified RGB value will not change the light brightness, only the color. | `white_value` | yes | Integer between 0 and 255 for how bright a dedicated white LED should be. | `color_temp` | yes | An integer in mireds representing the color temperature you want the light to be. | `kelvin` | yes | Alternatively, you can specify the color temperature in Kelvin. -| `color_name` | yes | A human readable string of a color name, such as `blue` or `goldenrod`. All [CSS3 color names](https://www.w3.org/TR/2010/PR-css3-color-20101028/#svg-color) are supported. +| `color_name` | yes | A human-readable string of a color name, such as `blue` or `goldenrod`. All [CSS3 color names](https://www.w3.org/TR/css-color-3/#svg-color) are supported. | `brightness` | yes | Integer between 0 and 255 for how bright the color should be. | `brightness_pct`| yes | Alternatively, you can specify brightness in percent (a number between 0 and 100). | `flash` | yes | Tell light to flash, can be either value `short` or `long`. | `effect`| yes | Applies an effect such as `colorloop` or `random`.

-In order to apply attributes to an entity you will need to add `data:` to the configuration. See example below +In order to apply attributes to an entity, you will need to add `data:` to the configuration. See example below

```yaml diff --git a/source/_components/light.mochad.markdown b/source/_components/light.mochad.markdown index 2902cb71be..9721e9d6c9 100644 --- a/source/_components/light.mochad.markdown +++ b/source/_components/light.mochad.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Mochad Light" -description: "Instructions how to integrate X10 Mochad lights into Home Assistant." +description: "Instructions on how to integrate X10 Mochad lights into Home Assistant." date: 2017-07-14 11:29 sidebar: true comments: false @@ -11,13 +11,14 @@ ha_category: Light ha_release: 0.51 --- -The `mochad` light platform lets you control an X10 enabled dimmer/light -device. +The `mochad` light platform lets you control an X10 enabled dimmer/light device. + + To enable this sensor, you first have to set up the [mochad component](/components/mochad/) and then add the following to your `configuration.yaml` file: ```yaml -# Example configuration.yml entry +# Example configuration.yaml entry light: - platform: mochad devices: diff --git a/source/_components/light.mqtt.markdown b/source/_components/light.mqtt.markdown index ec582bfb0f..e92f859fb7 100644 --- a/source/_components/light.mqtt.markdown +++ b/source/_components/light.mqtt.markdown @@ -1,7 +1,7 @@ --- layout: page title: "MQTT Light" -description: "Instructions how to setup MQTT lights within Home Assistant." +description: "Instructions on how to setup MQTT lights within Home Assistant." date: 2015-11-13 08:30 sidebar: true comments: false @@ -14,6 +14,8 @@ ha_iot_class: depends The `mqtt` light platform lets you control your MQTT enabled lights. It supports setting brightness, color temperature, effects, flashing, on/off, RGB colors, transitions, XY colors and white values. +## {% linkable_title Configuration %} + In an ideal scenario, the MQTT device will have a state topic to publish state changes. If these messages are published with a `RETAIN` flag, the MQTT light will receive an instant state update after subscription and will start with the correct state. Otherwise, the initial state of the switch will be `false` / `off`. When a state topic is not available, the light will work in optimistic mode. In this mode, the light will immediately change state after every command. Otherwise, the light will wait for state confirmation from the device (message from `state_topic`). @@ -21,7 +23,7 @@ When a state topic is not available, the light will work in optimistic mode. In Optimistic mode can be forced, even if the `state_topic` is available. Try to enable it, if experiencing incorrect light operation. ```yaml -# Example configuration.yml entry +# Example configuration.yaml entry light: - platform: mqtt command_topic: "office/rgb1/light/switch" @@ -55,7 +57,7 @@ brightness_value_template: required: false type: string color_temp_command_topic: - description: The MQTT topic to publish commands to change the light’s color temperature state. The color temperature command slider has a range of 157 to 500 mireds (micro reciprocal degrees). + description: The MQTT topic to publish commands to change the light’s color temperature state. The color temperature command slider has a range of 153 to 500 mireds (micro reciprocal degrees). required: false type: string color_temp_state_topic: @@ -95,12 +97,12 @@ payload_on: description: The payload that represents enabled state. required: false type: string - default: ON + default: "ON" payload_off: description: The payload that represents disabled state. required: false type: string - default: OFF + default: "OFF" qos: description: The maximum QoS level of the state topic. required: false @@ -185,7 +187,7 @@ payload_not_available: ## {% linkable_title Comparison of light MQTT platforms %} -| Function | [`mqtt`](https://home-assistant.io/components/light.mqtt/) | [`mqtt_json`](https://home-assistant.io/components/light.mqtt_json/) | [`mqtt_template`](https://home-assistant.io/components/light.mqtt_template/) | +| Function | [`mqtt`](/components/light.mqtt/) | [`mqtt_json`](/components/light.mqtt_json/) | [`mqtt_template`](/components/light.mqtt_template/) | |-------------------|------------------------------------------------------------|----------------------------------------------------------------------|------------------------------------------------------------------------------| | Brightness | ✔ | ✔ | ✔ | | Color temperature | ✔ | ✔ | ✔ | @@ -194,6 +196,7 @@ payload_not_available: | RGB Color | ✔ | ✔ | ✔ | | Transitions | ✘ | ✔ | ✔ | | XY Color | ✔ | ✔ | ✘ | +| HS Color | ✘ | ✔ | ✘ | | White Value | ✔ | ✔ | ✔ | ## {% linkable_title Examples %} @@ -204,8 +207,9 @@ In this section you will find some real life examples of how to use this sensor. To enable a light with brightness and RGB support in your installation, add the following to your `configuration.yaml` file: +{% raw %} ```yaml -# Example configuration.yml entry +# Example configuration.yaml entry light: - platform: mqtt name: "Office Light RGB" @@ -215,21 +219,22 @@ light: brightness_command_topic: "office/rgb1/brightness/set" rgb_state_topic: "office/rgb1/rgb/status" rgb_command_topic: "office/rgb1/rgb/set" - state_value_template: "{% raw %}{{ value_json.state }}{% endraw %}" - brightness_value_template: "{% raw %}{{ value_json.brightness }}{% endraw %}" - rgb_value_template: "{% raw %}{{ value_json.rgb | join(',') }}{% endraw %}" + state_value_template: "{{ value_json.state }}" + brightness_value_template: "{{ value_json.brightness }}" + rgb_value_template: "{{ value_json.rgb | join(',') }}" qos: 0 payload_on: "ON" payload_off: "OFF" optimistic: false ``` +{% endraw %} ### {% linkable_title Brightness and no RGB support %} To enable a light with brightness (no RGB version) in your installation, add the following to your `configuration.yaml` file: ```yaml -# Example configuration.yml entry +# Example configuration.yaml entry light: - platform: mqtt name: "Office light" @@ -248,7 +253,7 @@ light: To enable a light that sends only brightness topics to turn it on, add the following to your `configuration.yaml` file. The `command_topic` is only used to send an off command in this case: ```yaml -# Example configuration.yml entry +# Example configuration.yaml entry light: - platform: mqtt name: "Brightness light" @@ -260,7 +265,6 @@ light: on_command_type: 'brightness' ``` - ### {% linkable_title Implementations %} - A [basic example](https://github.com/mertenats/open-home-automation/tree/master/ha_mqtt_light) using a nodeMCU board (ESP8266) to control its built-in LED (on/off). diff --git a/source/_components/light.mqtt_json.markdown b/source/_components/light.mqtt_json.markdown index bdcfaaab11..6e70c8be89 100644 --- a/source/_components/light.mqtt_json.markdown +++ b/source/_components/light.mqtt_json.markdown @@ -23,10 +23,12 @@ This platform supports on/off, brightness, RGB colors, XY colors, color temperat "color_temp": 155, "color": { "r": 255, - "g": 255, - "b": 255, - "x": 0.123, - "y": 0.123 + "g": 180, + "b": 200, + "x": 0.406, + "y": 0.301, + "h": 344.0, + "s": 29.412 }, "effect": "colorloop", "state": "ON", @@ -126,6 +128,11 @@ xy: required: false type: boolean default: false +hs: + description: Flag that defines if the light supports HS colors. + required: false + type: boolean + default: false availability_topic: description: The MQTT topic subscribed to receive availability (online/offline) updates. required: false @@ -147,12 +154,12 @@ payload_not_available:

- XY and RGB can not be used at the same time. If both are provided, XY overrides RGB. + RGB, XY and HSV can not be used at the same time in `state_topic` messages. Make sure that only one of the color models is in the "color" section of the state MQTT payload.

## {% linkable_title Comparison of light MQTT platforms %} -| Function | [`mqtt`](https://home-assistant.io/components/light.mqtt/) | [`mqtt_json`](https://home-assistant.io/components/light.mqtt_json/) | [`mqtt_template`](https://home-assistant.io/components/light.mqtt_template/) | +| Function | [`mqtt`](/components/light.mqtt/) | [`mqtt_json`](/components/light.mqtt_json/) | [`mqtt_template`](/components/light.mqtt_template/) | |-------------------|------------------------------------------------------------|----------------------------------------------------------------------|------------------------------------------------------------------------------| | Brightness | ✔ | ✔ | ✔ | | Color temperature | ✔ | ✔ | ✔ | @@ -161,6 +168,7 @@ payload_not_available: | RGB Color | ✔ | ✔ | ✔ | | Transitions | ✘ | ✔ | ✔ | | XY Color | ✔ | ✔ | ✘ | +| HS Color | ✘ | ✔ | ✘ | | White Value | ✔ | ✔ | ✔ | ## {% linkable_title Examples %} @@ -215,7 +223,32 @@ Home Assistant will then convert its 8bit value in the message to and from the d ```json { "brightness": 4095, + "state": "ON" +} +``` + +### {% linkable_title HS Color %} + +To use a light with hue+saturation as the color model, set `hs` to `true` in the platform configuration: + +```yaml +light: + - platform: mqtt_json + name: mqtt_json_hs_light + state_topic: "home/light" + command_topic: "home/light/set" + hs: True +``` + +Home Assistant expects the hue values to be in the range 0 to 360 and the saturation values to be scaled from 0 to 100. For example, the following is a blue color shade: + +```json +{ "state": "ON", + "color": { + "h": 24.0, + "s": 100.0 + } } ``` @@ -227,4 +260,6 @@ Home Assistant will then convert its 8bit value in the message to and from the d - [MQTT JSON Light](https://github.com/mertenats/Open-Home-Automation/tree/master/ha_mqtt_rgbw_light_with_discovery) is another implementation for ESP8266 including [MQTT discovery](/docs/mqtt/discovery/). -- [esphomelib](https://github.com/OttoWinter/esphomelib) is a library for ESP32-based boards that has many of Home Assistant's MQTT features (like [discovery](/docs/mqtt/discovery/)) pre-implemented and provides high-level abstractions for components such as lights or sensors. +- [esphomelib](https://github.com/OttoWinter/esphomelib) is a library for ESP8266 and ESP32 boards that has many of Home Assistant's MQTT features (like [discovery](/docs/mqtt/discovery/)) pre-implemented and provides high-level abstractions for components such as lights or sensors. + +- [AiLight](https://github.com/stelgenhof/AiLight) is a custom firmware for the Ai-Thinker (and equivalent) RGBW WiFi light bulbs that has an ESP8266 onboard and controlled by the MY9291 LED driver. It implements the [MQTT JSON light](/components/light.mqtt_json/) platform and supports ON/OFF, RGBW colours, brightness, colour temperature, flashing and transitions. Also it includes [MQTT Auto Discovery](/docs/mqtt/discovery/)) and the MQTT Last Will and Testament is enabled as well. \ No newline at end of file diff --git a/source/_components/light.mqtt_template.markdown b/source/_components/light.mqtt_template.markdown index 5a13ea9dfb..11b4372672 100644 --- a/source/_components/light.mqtt_template.markdown +++ b/source/_components/light.mqtt_template.markdown @@ -123,7 +123,7 @@ payload_not_available: ## {% linkable_title Comparison of light MQTT platforms %} -| Function | [`mqtt`](https://home-assistant.io/components/light.mqtt/) | [`mqtt_json`](https://home-assistant.io/components/light.mqtt_json/) | [`mqtt_template`](https://home-assistant.io/components/light.mqtt_template/) | +| Function | [`mqtt`](/components/light.mqtt/) | [`mqtt_json`](/components/light.mqtt_json/) | [`mqtt_template`](/components/light.mqtt_template/) | |-------------------|------------------------------------------------------------|----------------------------------------------------------------------|------------------------------------------------------------------------------| | Brightness | ✔ | ✔ | ✔ | | Color temperature | ✔ | ✔ | ✔ | @@ -132,6 +132,7 @@ payload_not_available: | RGB Color | ✔ | ✔ | ✔ | | Transitions | ✘ | ✔ | ✔ | | XY Color | ✔ | ✔ | ✘ | +| HS Color | ✘ | ✔ | ✘ | | White Value | ✔ | ✔ | ✔ | ## {% linkable_title Examples %} @@ -140,7 +141,7 @@ In this section you find some real life examples of how to use this light. ### {% linkable_title Simple string payload %} -For a simple string payload with the format `state,brightness,r-g-b` (e.g. `on,255,255-255-255`), add the following to your `configuration.yaml` file: +For a simple string payload with the format `state,brightness,r-g-b` (e.g., `on,255,255-255-255`), add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry diff --git a/source/_components/light.mysensors.markdown b/source/_components/light.mysensors.markdown index 4bf9a9d28a..5f91aa43fe 100644 --- a/source/_components/light.mysensors.markdown +++ b/source/_components/light.mysensors.markdown @@ -1,7 +1,7 @@ --- layout: page title: "MySensors Light" -description: "Instructions how to integrate MySensors lights into Home Assistant." +description: "Instructions on how to integrate MySensors lights into Home Assistant." date: 2016-10-01 15:00 +0200 sidebar: true comments: false diff --git a/source/_components/light.mystrom.markdown b/source/_components/light.mystrom.markdown index f9ceacdb22..9cc2555fb1 100644 --- a/source/_components/light.mystrom.markdown +++ b/source/_components/light.mystrom.markdown @@ -1,7 +1,7 @@ --- layout: page title: "myStrom WiFi Bulb" -description: "Instructions how to integrate myStrom WiFi Bulbs into Home Assistant." +description: "Instructions on how to integrate myStrom WiFi Bulbs into Home Assistant." date: 2017-04-18 06:00 sidebar: true comments: false diff --git a/source/_components/light.nanoleaf_aurora.markdown b/source/_components/light.nanoleaf_aurora.markdown new file mode 100644 index 0000000000..4f066dc7b2 --- /dev/null +++ b/source/_components/light.nanoleaf_aurora.markdown @@ -0,0 +1,52 @@ +--- +layout: page +title: "Nanoleaf Aurora Light Panel" +description: "Instructions how to integrate Nanoleaf Aurora Light Panels into Home Assistant." +date: 2018-01-04 20:00 +sidebar: true +comments: false +sharing: true +footer: true +logo: nanoleaf_aurora_light.png +ha_category: Light +ha_iot_class: "Local Polling" +featured: false +ha_release: 0.67 +--- + +### {% linkable_title Configuration Sample %} + +To enable the Aurora lights, add the following lines to your `configuration.yaml` file: + +```yaml +# Example configuration.yaml entry +light: + - platform: nanoleaf_aurora + host: 192.168.1.10 + token: xxxxxxxxxxxxxxxxxxxxx +``` + +{% configuration %} +host: + description: IP address or host-name of the device, e.g., 192.168.1.10. + required: true + type: string +token: + description: The *auth* token that you get via *POST* to */api/v1/new* + required: true + type: string +name: + description: Name of the component, make this unique if you have multiple Light Panels + required: false + type: string + default: Aurora +{% endconfiguration %} + +### {% linkable_title Getting The Auth Token %} + +1. Make sure that your Nanoleaf Aurora Panel is fully patched (as of the time of writing the latest version was 2.2.0) +2. Hold down the *ON* button on the Panel for 5 seconds; the LED will start flashing +3. Issue a *POST* request to the API endpoint, e.g., via `$ curl -i -X POST http://192.168.1.155:16021/api/v1/new` +4. The output should include the auth token like *{"auth_token":"xxxxxxxxxxxxxxxxxxxxx"}*, copy the resulting token into your configuration + +If you get a 403 Forbidden message, you probably did not press the *ON* button long enough. The time-frame to get a valid token is only 30 seconds, so you have to be quick to issue the curl request. diff --git a/source/_components/light.osramlightify.markdown b/source/_components/light.osramlightify.markdown index 86fa342c9b..df1abeece9 100644 --- a/source/_components/light.osramlightify.markdown +++ b/source/_components/light.osramlightify.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Osram Lightify" -description: "Instructions how to integrate Osram Lightify into Home Assistant." +description: "Instructions on how to integrate Osram Lightify into Home Assistant." date: 2016-05-29 08:00 sidebar: true comments: false diff --git a/source/_components/light.piglow.markdown b/source/_components/light.piglow.markdown index d261a81648..c2664af84c 100644 --- a/source/_components/light.piglow.markdown +++ b/source/_components/light.piglow.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Piglow" -description: "Instructions how to setup Piglow LED's within Home Assistant." +description: "Instructions on how to setup Piglow LED's within Home Assistant." date: 2017-01-13 18:00 sidebar: true comments: false diff --git a/source/_components/light.qwikswitch.markdown b/source/_components/light.qwikswitch.markdown index e1f600c98f..13f61413f6 100644 --- a/source/_components/light.qwikswitch.markdown +++ b/source/_components/light.qwikswitch.markdown @@ -1,7 +1,7 @@ --- layout: page title: "QwikSwitch Light" -description: "Instructions how to integrate Qwikswitch dimmers and relays as lights into Home Assistant." +description: "Instructions on how to integrate Qwikswitch dimmers and relays as lights into Home Assistant." date: 2016-05-04 00:00 sidebar: true comments: false diff --git a/source/_components/light.rflink.markdown b/source/_components/light.rflink.markdown index ebba128f88..cc56e6de3e 100644 --- a/source/_components/light.rflink.markdown +++ b/source/_components/light.rflink.markdown @@ -1,7 +1,7 @@ --- layout: page title: "RFLink Light" -description: "Instructions how to integrate RFLink lights into Home Assistant." +description: "Instructions on how to integrate RFLink lights into Home Assistant." date: 2016-01-04 sidebar: true comments: false diff --git a/source/_components/light.rfxtrx.markdown b/source/_components/light.rfxtrx.markdown index ee5c513fe8..b6a1b707cf 100644 --- a/source/_components/light.rfxtrx.markdown +++ b/source/_components/light.rfxtrx.markdown @@ -1,7 +1,7 @@ --- layout: page title: "RFXtrx Light" -description: "Instructions how to integrate RFXtrx lights into Home Assistant." +description: "Instructions on how to integrate RFXtrx lights into Home Assistant." date: 2015-10-08 10:15 sidebar: true comments: false diff --git a/source/_components/light.scsgate.markdown b/source/_components/light.scsgate.markdown index 5625b43cfb..07df0ca0f7 100644 --- a/source/_components/light.scsgate.markdown +++ b/source/_components/light.scsgate.markdown @@ -1,7 +1,7 @@ --- layout: page title: "SCSGate Light" -description: "Instructions how to integrate SCSGate lights into Home Assistant." +description: "Instructions on how to integrate SCSGate lights into Home Assistant." date: 2016-01-31 19:30 sidebar: true comments: false diff --git a/source/_components/light.sensehat.markdown b/source/_components/light.sensehat.markdown index b2bb9dbce5..55e09b1219 100644 --- a/source/_components/light.sensehat.markdown +++ b/source/_components/light.sensehat.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Sense HAT Light" -description: "Instructions how to setup Sense HAT LED lights within Home Assistant." +description: "Instructions on how to setup Sense HAT LED lights within Home Assistant." date: 2017-04-29 16:00 sidebar: true comments: false diff --git a/source/_components/light.tellstick.markdown b/source/_components/light.tellstick.markdown index a81d238464..9c66e121ec 100644 --- a/source/_components/light.tellstick.markdown +++ b/source/_components/light.tellstick.markdown @@ -1,7 +1,7 @@ --- layout: page title: "TellStick Light" -description: "Instructions how to integrate TellStick lights into Home Assistant." +description: "Instructions on how to integrate TellStick lights into Home Assistant." date: 2015-08-06 19:00 sidebar: true comments: false @@ -15,7 +15,7 @@ ha_iot_class: "Assumed State" This `tellstick` light platform allows you to control your [TellStick](http://www.telldus.se/products/tellstick) dimmers. -To use your TellStick device, you first have to set up your [Tellstick hub](https://home-assistant.io/components/tellstick/) and then add the following to your `configuration.yaml` file: +To use your TellStick device, you first have to set up your [Tellstick hub](/components/tellstick/) and then add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry diff --git a/source/_components/light.template.markdown b/source/_components/light.template.markdown index a9f1b834e4..9d1315b310 100755 --- a/source/_components/light.template.markdown +++ b/source/_components/light.template.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Template Light" -description: "Instructions how to integrate Template Lights into Home Assistant." +description: "Instructions on how to integrate Template Lights into Home Assistant." date: 2016-05-18 20:32 sidebar: true comments: false diff --git a/source/_components/light.tplink.markdown b/source/_components/light.tplink.markdown index 71fc4e9717..158504bcae 100644 --- a/source/_components/light.tplink.markdown +++ b/source/_components/light.tplink.markdown @@ -1,7 +1,7 @@ --- layout: page title: "TP-Link Bulb" -description: "Instructions how to integrate TP-Link bulbs into Home Assistant." +description: "Instructions on how to integrate TP-Link bulbs into Home Assistant." date: 2017-07-25 08:00 sidebar: true comments: false diff --git a/source/_components/light.vera.markdown b/source/_components/light.vera.markdown index da0fc42fff..dba42ffcaf 100644 --- a/source/_components/light.vera.markdown +++ b/source/_components/light.vera.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Vera Light" -description: "Instructions how to integrate Vera lights into Home Assistant." +description: "Instructions on how to integrate Vera lights into Home Assistant." date: 2015-10-20 21:00 sidebar: true comments: false diff --git a/source/_components/light.wemo.markdown b/source/_components/light.wemo.markdown index df44818d04..1ae147ef86 100644 --- a/source/_components/light.wemo.markdown +++ b/source/_components/light.wemo.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Belkin WeMo Lights" -description: "Instructions how to integrate Belkin WeMo LED lights and WeMo Dimmer Switch into Home Assistant." +description: "Instructions on how to integrate Belkin WeMo LED lights and WeMo Dimmer Switch into Home Assistant." date: 2016-02-20 00:45 sidebar: true comments: false diff --git a/source/_components/light.wink.markdown b/source/_components/light.wink.markdown index 5e7b74771e..e537c11601 100644 --- a/source/_components/light.wink.markdown +++ b/source/_components/light.wink.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Wink Light" -description: "Instructions how to setup the Wink lights within Home Assistant." +description: "Instructions on how to setup the Wink lights within Home Assistant." date: 2015-01-20 22:36 sidebar: true comments: false diff --git a/source/_components/light.x10.markdown b/source/_components/light.x10.markdown index b79a881441..45df065a49 100644 --- a/source/_components/light.x10.markdown +++ b/source/_components/light.x10.markdown @@ -1,7 +1,7 @@ --- layout: page title: "X10" -description: "Instructions how to setup X10 devices within Home Assistant." +description: "Instructions on how to setup X10 devices within Home Assistant." date: 2016-07-27 sidebar: true comments: false diff --git a/source/_components/light.xiaomi_aqara.markdown b/source/_components/light.xiaomi_aqara.markdown index 25e01ba22c..48bf4fb135 100644 --- a/source/_components/light.xiaomi_aqara.markdown +++ b/source/_components/light.xiaomi_aqara.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Xiaomi Light" -description: "Instructions how to setup the Xiaomi light within Home Assistant." +description: "Instructions on how to setup the Xiaomi light within Home Assistant." date: 2017-07-21 16:34 sidebar: true comments: false diff --git a/source/_components/light.xiaomi_miio.markdown b/source/_components/light.xiaomi_miio.markdown index 3af241a04e..991ff8c97f 100644 --- a/source/_components/light.xiaomi_miio.markdown +++ b/source/_components/light.xiaomi_miio.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Xiaomi Philips Light" -description: "Instructions how to integrate your Xiaomi Philips Lights within Home Assistant." +description: "Instructions on how to integrate your Xiaomi Philips Lights within Home Assistant." date: 2017-08-26 08:45 sidebar: true comments: false @@ -13,9 +13,54 @@ ha_version: 0.53 ha_iot_class: "Local Polling" --- -The `xiaomi_miio` platform allows you to control the state of your Xiaomi Philips LED Ball Lamp, Xiaomi Philips LED Ceiling Lamp and Xiaomi Philips Eyecare Lamp 2. +The `xiaomi_miio` platform allows you to control the state of your Xiaomi Philips LED Ball Lamp, Xiaomi Philips Zhirui LED Bulb E14 Candle Lamp, Xiaomi Philips LED Ceiling Lamp and Xiaomi Philips Eyecare Lamp 2. -Currently, the supported features are `on`, `off`, `set_cct` (colortemp) , `set_bright` (brightness). +## Features + +### Philips LED Ball Lamp and Philips Zhirui LED Candle Lamp + +* Power (on, off) +* Brightness +* Color temperature (175...333 mireds) +* Scene (1, 2, 3, 4) +* Delayed turn off (Resolution in seconds) +* Attributes + - model + - scene + - delayed_turn_off + +### Philips LED Ceiling Lamp + +* Power (on, off) +* Brightness +* Color temperature (175...370 mireds) +* Scene (1, 2, 3, 4) +* Night light mode (on, off) +* Delayed turn off (Resolution in seconds) +* Attributes + - model + - scene + - delayed_turn_off + - night_light_mode + - automatic_color_temperature + +### Philips Eyecare Smart Lamp 2 + +* Eyecare light (on, off) +* Ambient light (on, off) +* Brightness (of each light) +* Scene (1, 2, 3, 4) +* Night light mode (on, off) +* Delayed turn off (Resolution in seconds) +* Eye fatigue reminder / notification (on, off) +* Eyecare mode (on, off) +* Attributes + - model + - scene + - delayed_turn_off + - night_light_mode + - reminder + - eyecare_mode Please follow the instructions on [Retrieving the Access Token](/components/vacuum.xiaomi_miio/#retrieving-the-access-token) to get the API token to use in the `configuration.yaml` file. @@ -35,7 +80,7 @@ Configuration variables: - **host** (*Required*): The IP of your light. - **token** (*Required*): The API token of your light. - **name** (*Optional*): The name of your light. -- **model** (*Optional*): The model of your light. Valid values are `philips.light.bulb`, `philips.light.sread1`, `philips.light.ceiling` and `philips.light.zyceiling`. This setting can be used to bypass the device model detection and is recommended if your device isn't always available. +- **model** (*Optional*): The model of your light. Valid values are `philips.light.bulb`, `philips.light.candle2`, `philips.light.sread1`, `philips.light.ceiling` and `philips.light.zyceiling`. This setting can be used to bypass the device model detection and is recommended if your device isn't always available. {% configuration %} host: @@ -76,3 +121,51 @@ Delayed turn off. |---------------------------|----------|-------------------------------------------------------| | `entity_id` | yes | Only act on a specific light. Else targets all. | | `time_period` | no | Time period for the delayed turn off. | + +### {% linkable_title Service `light.xiaomi_miio_reminder_on` %} (Eyecare Smart Lamp 2 only) + +Enable the eye fatigue reminder/notification. + +| Service data attribute | Optional | Description | +|---------------------------|----------|-------------------------------------------------------| +| `entity_id` | yes | Only act on a specific light. Else targets all. | + +### {% linkable_title Service `light.xiaomi_miio_reminder_off` %} (Eyecare Smart Lamp 2 only) + +Disable the eye fatigue reminder/notification. + +| Service data attribute | Optional | Description | +|---------------------------|----------|-------------------------------------------------------| +| `entity_id` | yes | Only act on a specific light. Else targets all. | + +### {% linkable_title Service `light.xiaomi_miio_night_light_mode_on` %} (Eyecare Smart Lamp 2 only) + +Turn the smart night light mode on. + +| Service data attribute | Optional | Description | +|---------------------------|----------|-------------------------------------------------------| +| `entity_id` | yes | Only act on a specific light. Else targets all. | + +### {% linkable_title Service `light.xiaomi_miio_night_light_mode_off` %} (Eyecare Smart Lamp 2 only) + +Turn the smart night light mode off. + +| Service data attribute | Optional | Description | +|---------------------------|----------|-------------------------------------------------------| +| `entity_id` | yes | Only act on a specific light. Else targets all. | + +### {% linkable_title Service `light.xiaomi_miio_eyecare_mode_on` %} (Eyecare Smart Lamp 2 only) + +Turn the eyecare mode on. + +| Service data attribute | Optional | Description | +|---------------------------|----------|-------------------------------------------------------| +| `entity_id` | yes | Only act on a specific light. Else targets all. | + +### {% linkable_title Service `light.xiaomi_miio_eyecare_mode_off` %} (Eyecare Smart Lamp 2 only) + +Turn the eyecare mode off. + +| Service data attribute | Optional | Description | +|---------------------------|----------|-------------------------------------------------------| +| `entity_id` | yes | Only act on a specific light. Else targets all. | diff --git a/source/_components/light.yeelight.markdown b/source/_components/light.yeelight.markdown index b098d007d5..8ee047b47f 100644 --- a/source/_components/light.yeelight.markdown +++ b/source/_components/light.yeelight.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Yeelight Wifi Bulb" -description: "Instructions how to setup Yeelight Wifi devices within Home Assistant." +description: "Instructions on how to setup Yeelight Wifi devices within Home Assistant." date: 2016-10-29 sidebar: true comments: false @@ -35,7 +35,7 @@ light: Configuration variables: -- **ip** (*Required*): IP(s) of your wifi bulbs +- **ip** (*Required*): IP(s) of your Wifi bulbs - **name** (*Optional*): A friendly name for the device. - **transition** (*Optional*, default 350): Smooth transitions over time (in ms). - **use_music_mode** (*Optional*, default False): Enable music mode. @@ -62,6 +62,18 @@ This component is tested to work with the following models. If you have a differ - **YLDD01YL**: Lightstrip (Color) - **YLDD02YL**: Lightstrip (Color) - **MJCTD01YL**: Xiaomi Mijia Bedside Lamp - WIFI Version! +- **MJTD01YL**: Xiaomi Mijia Smart LED Desk Lamp (autodiscovery isn't possible because the device doesn't support mDNS due to the small amount of RAM) +- **YLXD02YL**: Yeelight Ceiling Light 4 (Jiaoyue 650) +- **YLXD01YL**: Yeelight Smart LED Ceiling Light - Youth Version +## {% linkable_title Platform Services %} +### {% linkable_title Service `light.yeelight_set_mode` %} + +Set a operation mode. + +| Service data attribute | Optional | Description | +|---------------------------|----------|---------------------------------------------------------------------------------------------| +| `entity_id` | yes | Only act on a specific yeelight. Else targets all. | +| `mode` | no | Operation mode. Valid values are 'last', 'normal', 'rgb', 'hsv', 'color_flow', 'moonlight'. | diff --git a/source/_components/light.yeelightsunflower.markdown b/source/_components/light.yeelightsunflower.markdown index 1b0e441970..0583084626 100644 --- a/source/_components/light.yeelightsunflower.markdown +++ b/source/_components/light.yeelightsunflower.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Yeelight Sunflower Bulb" -description: "Instructions how to setup Yeelight Sunflower hub and bulbs within Home Assistant." +description: "Instructions on how to setup Yeelight Sunflower hub and bulbs within Home Assistant." date: 2017-02-11 sidebar: true comments: false diff --git a/source/_components/light.zengge.markdown b/source/_components/light.zengge.markdown index ed15a92752..b2f46b065d 100644 --- a/source/_components/light.zengge.markdown +++ b/source/_components/light.zengge.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Zengge" -description: "Instructions how to integrate Zengge Bluetooth bulbs into Home Assistant." +description: "Instructions on how to integrate Zengge Bluetooth bulbs into Home Assistant." date: 2017-01-14 08:00 sidebar: true comments: false diff --git a/source/_components/light.zha.markdown b/source/_components/light.zha.markdown index c3b0cc2d8b..904c1e59de 100644 --- a/source/_components/light.zha.markdown +++ b/source/_components/light.zha.markdown @@ -1,7 +1,7 @@ --- layout: page title: "ZigBee Home Automation Light" -description: "Instructions how to setup ZigBee Home Automation lights within Home Assistant." +description: "Instructions on how to setup ZigBee Home Automation lights within Home Assistant." date: 2017-02-22 00:00 sidebar: true comments: false diff --git a/source/_components/light.zwave.markdown b/source/_components/light.zwave.markdown index 4053e61f1d..891f63e886 100644 --- a/source/_components/light.zwave.markdown +++ b/source/_components/light.zwave.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Z-Wave Light" -description: "Instructions how to setup the Z-Wave lights within Home Assistant." +description: "Instructions on how to setup the Z-Wave lights within Home Assistant." date: 2015-11-11 13:00 sidebar: true comments: false diff --git a/source/_components/lirc.markdown b/source/_components/lirc.markdown index 6d379e04ca..1c6dc56be3 100644 --- a/source/_components/lirc.markdown +++ b/source/_components/lirc.markdown @@ -1,7 +1,7 @@ --- layout: page title: "LIRC" -description: "Instructions how to integrate IR remotes with LIRC into Home Assistant." +description: "Instructions on how to integrate IR remotes with LIRC into Home Assistant." date: 2016-05-22 19:59 sidebar: true comments: false @@ -14,9 +14,9 @@ ha_release: 0.21 ha_iot_class: "Local Push" --- -[LIRC](http://www.lirc.org/) integration for Home Assistant allows you to receive signals from an infrared remote control and control actions based on the buttons you press. You can use them to set scenes or trigger any other [automation](https://home-assistant.io/components/automation/). +[LIRC](http://www.lirc.org/) integration for Home Assistant allows you to receive signals from an infrared remote control and control actions based on the buttons you press. You can use them to set scenes or trigger any other [automation](/components/automation/). -Sending IR commands is not supported in this component (yet), but can be accomplished using the [shell_command component](https://home-assistant.io/components/shell_command/) in conjunction with the `irsend` command. +Sending IR commands is not supported in this component (yet), but can be accomplished using the [shell_command component](/components/shell_command/) in conjunction with the `irsend` command. ### {% linkable_title Installation %} @@ -32,14 +32,14 @@ The configuration is slightly different : - The `hardware.conf` file is not supported, obsoleted by a new `lirc_options.conf` file and systemd unit definitions. - The former single `lirc` service is replaced with the three systemd services `lircd.service`, `lircmd.service` and `irexec.service`. There is no counterpart to the 0.9.0 `lirc` service which covered all of these. Using a separate transmitter device requires yet another service. - - 0.9.4 defaults to using systemd for controlling the services. This is not just start/stop functionality, systemd is used to implement new features and to address shortcomings in 0.9.0. However, traditional systemV scripts are also installed and could be used although this is less tested and not really documented. - + - 0.9.4 defaults to using systemd for controlling the services. This is not just start/stop functionality, systemd is used to implement new features and to address shortcomings in 0.9.0. However, traditional systemV scripts are also installed and could be used although this is less tested and not really documented. + For more information have a look at `/usr/share/doc/lirc/README.Debian.gz` where the update process is explained when you have updated from jessie to stretch.

### {% linkable_title Configuring LIRC %} -Now teach LIRC about your particular remote control by preparing a lircd configuration file (`/etc/lirc/lircd.conf`). Search the [LIRC remote database](http://lirc.sourceforge.net/remotes/) for your model. If you can't find it, then you can always use the `irrecord` program to learn your remote. This will create a valid configuration file. Add as many remotes as you want by pasting them into the file. If `irrecord` doesn't work (e.g. for some air conditioner remotes), then the `mode2` program is capable of reading the codes in raw mode, followed by `irrecord -a` to extract hex codes. +Now teach LIRC about your particular remote control by preparing a lircd configuration file (`/etc/lirc/lircd.conf`). Search the [LIRC remote database](http://lirc.sourceforge.net/remotes/) for your model. If you can't find it, then you can always use the `irrecord` program to learn your remote. This will create a valid configuration file. Add as many remotes as you want by pasting them into the file. If `irrecord` doesn't work (e.g., for some air conditioner remotes), then the `mode2` program is capable of reading the codes in raw mode, followed by `irrecord -a` to extract hex codes. Next, you have to make a `~/.lircrc` file that maps keypresses to system actions. [The configuration](http://www.lirc.org/html/configure.html) is a bit tedious but it must be done. Use the `prog = home-assistant` for all keys you want to be recognized by Home Assistant. The values you set for `button` must be the same as in the `lircd.conf` file and the values you put for `config` entry will be the sensor value in Home Assistant when you press the button. An example may look like this: @@ -98,4 +98,4 @@ automation: entity_id: group.a_lights ``` -The `button_name` data values (e.g. `KEY_0`) are set by you in the `.lircrc` file. +The `button_name` data values (e.g., `KEY_0`) are set by you in the `.lircrc` file. diff --git a/source/_components/litejet.markdown b/source/_components/litejet.markdown index 3770bb024b..fb33408953 100644 --- a/source/_components/litejet.markdown +++ b/source/_components/litejet.markdown @@ -1,7 +1,7 @@ --- layout: page title: "LiteJet" -description: "Instructions how to setup the LiteJet hub within Home Assistant." +description: "Instructions on how to setup the LiteJet hub within Home Assistant." date: 2015-10-26 09:37 sidebar: true comments: false diff --git a/source/_components/lock.abode.markdown b/source/_components/lock.abode.markdown index c1e2860370..9dcc3cff90 100644 --- a/source/_components/lock.abode.markdown +++ b/source/_components/lock.abode.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Abode Lock" -description: "Instructions how to integrate Abode locks into Home Assistant." +description: "Instructions on how to integrate Abode locks into Home Assistant." date: 2017-08-26 13:28 sidebar: true comments: false diff --git a/source/_components/lock.bmw_connected_drive.markdown b/source/_components/lock.bmw_connected_drive.markdown new file mode 100755 index 0000000000..4c6c7a2edc --- /dev/null +++ b/source/_components/lock.bmw_connected_drive.markdown @@ -0,0 +1,20 @@ +--- +layout: page +title: "BMW Connected Drive Lock" +description: "Instructions on how to setup your BMW Connected Drive account with Home Assistant." +date: 2018-02-22 23:00 +sidebar: true +comments: false +sharing: true +footer: true +logo: bmw.png +ha_category: Lock +ha_release: 0.66 +--- + + +The `bmw_connected_drive` platform allows you to import data on your BMW into Home Assistant. + +The lock will be automatically configured if `bmw_connected_drive` component is configured. + +For more configuration information see the [`bmw_connected_drive` component](/components/bmw_connected_drive/) documentation. diff --git a/source/_components/lock.homematic.markdown b/source/_components/lock.homematic.markdown new file mode 100644 index 0000000000..d536312e2e --- /dev/null +++ b/source/_components/lock.homematic.markdown @@ -0,0 +1,18 @@ +--- +layout: page +title: "Homematic Lock (KeyMatic)" +description: "Instructions how to integrate Homematic locks (KeyMatic) within Home Assistant." +date: 2018-01-28 03:00 +sidebar: true +comments: false +sharing: true +footer: true +logo: homematic.png +ha_category: Lock +ha_release: 0.66 +ha_iot_class: "Local Push" +--- + +The `homematic` lock platform lets you observe and control the state of the HomeMatic [Homematic](http://www.homematic.com/) KeyMatic lock through Home Assistant. + +Devices will be configured automatically. Please refer to the [component](/components/homematic/) configuration on how to setup Homematic. diff --git a/source/_components/lock.isy994.markdown b/source/_components/lock.isy994.markdown index 04109b9cd6..b019662a68 100644 --- a/source/_components/lock.isy994.markdown +++ b/source/_components/lock.isy994.markdown @@ -1,7 +1,7 @@ --- layout: page title: "ISY994 Lock" -description: "Instructions how to integrate ISY994 locks into Home Assistant." +description: "Instructions on how to integrate ISY994 locks into Home Assistant." date: 2016-09-03 23:00 sidebar: true comments: false diff --git a/source/_components/lock.lockitron.markdown b/source/_components/lock.lockitron.markdown index 418881c169..6b320e7108 100644 --- a/source/_components/lock.lockitron.markdown +++ b/source/_components/lock.lockitron.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Lockitron Lock" -description: "Instructions how to integrate Lockitron locks into Home Assistant." +description: "Instructions on how to integrate Lockitron locks into Home Assistant." date: 2017-03-24 00:00 sidebar: true comments: false diff --git a/source/_components/lock.markdown b/source/_components/lock.markdown index c2c3cc5530..67d5b6509a 100644 --- a/source/_components/lock.markdown +++ b/source/_components/lock.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Locks" -description: "Instructions how to setup your locks with Home Assistant." +description: "Instructions on how to setup your locks with Home Assistant." date: 2015-11-21 08:10 sidebar: true comments: false diff --git a/source/_components/lock.mqtt.markdown b/source/_components/lock.mqtt.markdown index 8ed47ccf4a..ff8eb05170 100644 --- a/source/_components/lock.mqtt.markdown +++ b/source/_components/lock.mqtt.markdown @@ -1,7 +1,7 @@ --- layout: page title: "MQTT Lock" -description: "Instructions how to integrate MQTT locks into Home Assistant." +description: "Instructions on how to integrate MQTT locks into Home Assistant." date: 2016-02-28 15:00 sidebar: true comments: false @@ -24,7 +24,7 @@ Optimistic mode can be forced, even if state topic is available. Try to enable i To enable MQTT locks in your installation, add the following to your `configuration.yaml` file: ```yaml -# Example configuration.yml entry +# Example configuration.yaml entry lock: - platform: mqtt command_topic: "home/frontdoor/set" diff --git a/source/_components/lock.nello.markdown b/source/_components/lock.nello.markdown index 53f2e26e79..558f9098b9 100644 --- a/source/_components/lock.nello.markdown +++ b/source/_components/lock.nello.markdown @@ -16,6 +16,7 @@ ha_iot_class: "Cloud Polling" --- The `nello` platform allows you to control [Nello](https://nello.io) intercoms. + To get started you need to create a secondary Nello account and authorize it to access your lock(s).

@@ -24,18 +25,26 @@ Be aware that if you use your main account for Home Assistant you may not be abl ## {% linkable_title Configuration %} +To add your Nello locks to your installation, add the following to your `configuration.yaml` file: + ```yaml # Example configuration.yaml entry lock: - platform: nello - username: mail@example.com - password: mySecretPassword + username: YOUR_USERNAME + password: YOUR_PASSWORD ``` -Configuration variables: - -- **username** (*Required*): The username of your Nello account. -- **password** (*Required*): The password of your Nello account. +{% configuration %} +username: + description: The username of your Nello account. + required: true + type: string +password: + description: The password of your Nello account. + required: true + type: string +{% endconfiguration %} ## {% linkable_title Events %} diff --git a/source/_components/lock.sesame.markdown b/source/_components/lock.sesame.markdown index 01d9910fda..affd029f63 100644 --- a/source/_components/lock.sesame.markdown +++ b/source/_components/lock.sesame.markdown @@ -15,18 +15,28 @@ ha_release: "0.47" The `sesame` platform allows you to control your [Sesame](https://candyhouse.co/) smart locks made by CANDY HOUSE, Inc. +## {% linkable_title Configuration %} + Your Sesame needs to be paired with a mobile device running the app in *virtual station* mode, or a standalone [Wi-Fi Access Point](https://candyhouse.co/collections/frontpage/products/wi-fi-access-point). Once you have remote access enabled using one of the above AND the Integration - cloud option enabled on the Sesame app for that lock settings, add the following to your `configuration.yaml` file: + ```yaml # Example configuration.yaml entry lock: - platform: sesame - email: abc@i-lovecandyhouse.co - password: super-strong-password + email: YOUR_E_MAIL_ADDRESS + password: YOUR_PASSWORD ``` -Configuration variables: +{% configuration %} +email: + description: The email address for your Sesame account. + required: true + type: string +password: + description: The password for your Sesame account. + required: true + type: string +{% endconfiguration %} -- **email** (*Required*): The email address for your Sesame account. -- **password** (*Required*): The password for your Sesame account. diff --git a/source/_components/lock.vera.markdown b/source/_components/lock.vera.markdown index 8baf864dfd..a305038987 100644 --- a/source/_components/lock.vera.markdown +++ b/source/_components/lock.vera.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Vera Lock" -description: "Instructions how to integrate Vera locks into Home Assistant." +description: "Instructions on how to integrate Vera locks into Home Assistant." date: 2016-06-29 15:00 sidebar: true comments: false diff --git a/source/_components/lock.verisure.markdown b/source/_components/lock.verisure.markdown index 2e72677179..e3c2d31e85 100644 --- a/source/_components/lock.verisure.markdown +++ b/source/_components/lock.verisure.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Verisure Lock" -description: "Instructions how to setup the Verisure locks within Home Assistant." +description: "Instructions on how to setup the Verisure locks within Home Assistant." date: 2016-02-12 06:00 sidebar: true comments: false diff --git a/source/_components/lock.wink.markdown b/source/_components/lock.wink.markdown index 1f51751b3f..a792e130a8 100644 --- a/source/_components/lock.wink.markdown +++ b/source/_components/lock.wink.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Wink Lock" -description: "Instructions how to setup the Wink locks within Home Assistant." +description: "Instructions on how to setup the Wink locks within Home Assistant." date: 2015-11-20 12:00 sidebar: true comments: false diff --git a/source/_components/lock.zwave.markdown b/source/_components/lock.zwave.markdown index e1d6fd7b33..ba25eacd6c 100644 --- a/source/_components/lock.zwave.markdown +++ b/source/_components/lock.zwave.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Z-Wave Lock" -description: "Instructions how to setup the Z-Wave Locks within Home Assistant." +description: "Instructions on how to setup the Z-Wave Locks within Home Assistant." date: 2016-05-07 08:00 sidebar: true comments: false diff --git a/source/_components/logbook.markdown b/source/_components/logbook.markdown index d1a76f3973..438e747430 100644 --- a/source/_components/logbook.markdown +++ b/source/_components/logbook.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Logbook" -description: "Instructions how to enable the logbook component for Home Assistant." +description: "Instructions on how to enable the logbook component for Home Assistant." date: 2015-04-25 9:23 sidebar: true comments: false @@ -11,7 +11,7 @@ logo: logbook.png ha_category: "History" --- - The logbook component provides a different perspective on the history of your house by showing all the changes that happened to your house in reverse chronological order. [See the demo for a live example](/demo/). It depends on the `recorder` component for storing the data. This means that if the [`recorder`](/components/recorder/) component is set up to use e.g. MySQL or PostgreSQL as data store, the `logbook` component does not use the default SQLite database to store data. + The logbook component provides a different perspective on the history of your house by showing all the changes that happened to your house in reverse chronological order. [See the demo for a live example](/demo/). It depends on the `recorder` component for storing the data. This means that if the [`recorder`](/components/recorder/) component is set up to use e.g., MySQL or PostgreSQL as data store, the `logbook` component does not use the default SQLite database to store data. To enable the logbook in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/logger.markdown b/source/_components/logger.markdown index 70168cf440..2f89e09096 100644 --- a/source/_components/logger.markdown +++ b/source/_components/logger.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Logger" -description: "Instructions how to enable the logger component for Home Assistant." +description: "Instructions on how to enable the logger component for Home Assistant." date: 2015-11-12 17:00 sidebar: true comments: false diff --git a/source/_components/lutron.markdown b/source/_components/lutron.markdown index c946160db1..6799e1feb5 100644 --- a/source/_components/lutron.markdown +++ b/source/_components/lutron.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Lutron" -description: "Instructions how to use Lutron devices with Home Assistant." +description: "Instructions on how to use Lutron devices with Home Assistant." date: 2017-01-28 13:00 sidebar: true comments: false @@ -18,6 +18,8 @@ ha_iot_class: "Local Polling" Presently, there's only support for communicating with the [RadioRA 2](http://www.lutron.com/en-US/Products/Pages/WholeHomeSystems/RadioRA2/Overview.aspx) Main Repeater and only handle light switches and dimmers. +## {% linkable_title Configuration %} + When configured, the `lutron` component will automatically discover the rooms and their associated switches/dimmers as configured by the RadioRA 2 software from Lutron. Each room will be treated as a separate group. To use Lutron RadioRA 2 devices in your installation, add the following to your `configuration.yaml` file using the IP address of your RadioRA 2 main repeater: diff --git a/source/_components/lutron_caseta.markdown b/source/_components/lutron_caseta.markdown index 912bd82dc4..9783766c89 100644 --- a/source/_components/lutron_caseta.markdown +++ b/source/_components/lutron_caseta.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Lutron Caseta" -description: "Instructions how to use Lutron Caseta devices with Home Assistant." +description: "Instructions on how to use Lutron Caseta devices with Home Assistant." date: 2017-01-28 13:00 sidebar: true comments: false @@ -25,7 +25,7 @@ The currently supported Caseta devices are: - Scenes as Home Assistant [scenes](/components/scene.lutron_caseta/) - Lutron shades as Home Assistant [covers](/components/cover.lutron_caseta/) -When configured, the `lutron_caseta` component will automatically discover the currently supported devices as setup in the Lutron Smart Bridge. The name assigned in the Lutron mobile app will be used to form the `entity_id` used in Home Assistant. e.g. a dimmer called 'Bedroom Lamp' becomes `light.bedroom_lamp` in Home Assistant. +When configured, the `lutron_caseta` component will automatically discover the currently supported devices as setup in the Lutron Smart Bridge. The name assigned in the Lutron mobile app will be used to form the `entity_id` used in Home Assistant. e.g., a dimmer called 'Bedroom Lamp' becomes `light.bedroom_lamp` in Home Assistant. To use Lutron Caseta devices in your installation, you must first log in to your Lutron account and generate a certificate that allows Home Assistant to connect to your bridge. This can be accomplished by downloading and executing [this script](/assets/get_lutron_cert.zip), which will generate three files: caseta.key, caseta.crt, caseta-bridge.crt when you run it. See the instructions at the top of the script for more information. diff --git a/source/_components/mailbox.asterisk_mbox.markdown b/source/_components/mailbox.asterisk_mbox.markdown index 25a0859aa9..15d5ec455f 100644 --- a/source/_components/mailbox.asterisk_mbox.markdown +++ b/source/_components/mailbox.asterisk_mbox.markdown @@ -1,15 +1,16 @@ --- layout: page title: "Asterisk Voicemail Mailbox" -description: "Instructions how to integrate an Asterisk Voicemail within Home Assistant." +description: "Instructions on how to integrate an Asterisk Voicemail within Home Assistant." date: 2017-06-30 18:30 sidebar: true comments: false sharing: true footer: true +logo: asterisk.png ha_category: Mailbox ha_version: 0.51 --- -The Asterisk Voicemail Mailbox provides visual and audio access to voicemail on the Asterisk PBX server. This mailbox is enabled automatically through the [Asterisk Voicemail component](/components/asterisk_mbox) configuration. +The Asterisk Voicemail Mailbox provides visual and audio access to voicemail on the Asterisk PBX server. This mailbox is enabled automatically through the [Asterisk Voicemail component](/components/asterisk_mbox/) configuration. diff --git a/source/_components/mailbox.markdown b/source/_components/mailbox.markdown index 28f4d77f43..16bfa603b8 100644 --- a/source/_components/mailbox.markdown +++ b/source/_components/mailbox.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Mailbox" -description: "Instructions how to setup your mailboxes with Home Assistant." +description: "Instructions on how to setup your mailboxes with Home Assistant." date: 2017-06-30 18:30 sidebar: true comments: false diff --git a/source/_components/mailgun.markdown b/source/_components/mailgun.markdown index 78764d7507..2f13d2c062 100644 --- a/source/_components/mailgun.markdown +++ b/source/_components/mailgun.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Mailgun" -description: "Instructions how to add Mailgun mail notifications to Home Assistant." +description: "Instructions on how to add Mailgun mail notifications to Home Assistant." date: 2017-02-06 16:52 sidebar: true comments: false diff --git a/source/_components/matrix.markdown b/source/_components/matrix.markdown new file mode 100644 index 0000000000..1047d54053 --- /dev/null +++ b/source/_components/matrix.markdown @@ -0,0 +1,136 @@ +--- +layout: page +title: "Matrix" +description: "Matrix chatbot support" +date: 2018-03-25 18:50 +sidebar: true +comments: false +sharing: true +footer: true +logo: matrix.png +ha_category: Hub +ha_version: 0.69 +--- + +This component allows you to send messages to matrix rooms, as well as to react to messages in matrix rooms. Reacting to commands is accomplished by firing an event when one of the configured commands is triggered. + +```yaml +# Example configuration.yaml entry +matrix: + homeserver: https://matrix.org + username: "@my_matrix_user:matrix.org" + password: supersecurepassword + rooms: + - "#hasstest:matrix.org" + commands: + - word: my_command + name: my_command +``` + +Configuration variables: + +{% configuration %} +username: + description: "The matrix username that home assistant should use to log in. *Note*: You must specify a full matrix ID here, including the homeserver domain, e.g. '@my_matrix_bot:matrix.org'. Please note also that the '@' character has a special meaning in YAML, so this must always be given in quotes." + required: true + type: string +password: + description: The password for your Matrix account. + required: true + type: string +homeserver: + description: "The full URL for your homeserver. If you use the defauls matrix.org homeserver, this is 'https://matrix.org'." + required: true + type: string +verify_ssl: + description: Verify the homeservers certificate. + required: false + type: string + default: true +rooms: + description: "The list of rooms that the bot should join and listen for commands (see below) in. While you can limit the list of rooms that a certain command applies to on a per-command basis (see below), you must still list all rooms here that commands should be received in. Rooms can be given either by their internal ID (e.g., '!cURbafjkfsMDVwdRDQ:matrix.org') or any of their aliases (e.g., '#matrix:matrix.org')." + required: false + type: [string] + default: empty +commands: + description: "A list of commands that the bot should listen for. If a command is triggered (via its *word* or *expression*, see below), an event is fired that you can handle using automations. Every command consists of these possible configuration options:" + required: false + type: map + default: empty + keys: + word: + description: "Specifies a word that the bot should listen for. If you specify 'my_command' here, the bot will react to any message starting with '!my_command'." + required: false + type: string + expression: + description: "Specifies a regular expression (in python regexp syntax) that the bot should listen to. The bot will react to any message that matches the regular expression." + required: false + type: string + name: + description: "The name of the command. This will be an attribute of the event that is fired when this command triggers." + required: true + type: string + rooms: + description: "A list of rooms that the bot should listen for this command in. If this is not given, the *rooms* list from the main config is used. Please note that every room in this list must also be in the main *room* config." + required: false + type: [string] + default: empty +{% endconfiguration %} + +### {% linkable_title Event Data %} + +If a command is triggered, a `matrix_command` event is fired. The event contains the name of the command in the `name` field. If the command is a word command that has no name set, the `name` field contains the word instead. + +If the command is a word command, the `data` field contains a list of the command's arguments, i.e., everything that stood behind the word, split at spaces. If the command is an expression command, the `data` field contains the [group dictionary](https://docs.python.org/3.6/library/re.html?highlight=re#re.match.groupdict) of the regular expression that matched the message. + +### {% linkable_title Comprehensive Configuration Example %} + +This example also uses the [matrix `notify` platform](/components/notify.matrix/). + +```yaml +# The Matrix component +matrix: + homeserver: https://matrix.org + username: "@my_matrix_user:matrix.org" + password: supersecurepassword + rooms: + - "#hasstest:matrix.org" + - "#someothertest:matrix.org" + commands: + - word: testword + rooms: + - "#someothertest:matrix.org" + - expression: "My name is (?P.*)" + name: introduction + +notify: + - name: matrix_notify + platform: matrix + default_room: "#hasstest:matrix.org" + +automation: + - alias: 'React to !testword' + trigger: + platform: event + event_type: matrix_command + event_data: + command: testword + action: + service: notify.matrix_notify + data: + message: 'It looks like you wrote !testword' + - alias: 'React to an introduction' + trigger: + platform: event + event_type: matrix_command + event_data: + command: introduction + action: + service: notify.matrix_notify + data_template: + message: "Hello {{trigger.event.data.name}}" +``` + +This configuration will: +- Listen for "!testword" in the room "#someothertest:matrix.org" (and *only*) there. If such a message is encountered, it will answer with "It looks like you wrote !testword" into the "#hasstest:matrix.org" channel. +- Listen in both rooms for any message matching "My name is " and answer with "Hello " into "#hasstest:matrix.org". diff --git a/source/_components/maxcube.markdown b/source/_components/maxcube.markdown index c9645e9fc5..7439d2d19f 100644 --- a/source/_components/maxcube.markdown +++ b/source/_components/maxcube.markdown @@ -25,13 +25,42 @@ Supported Devices: - MAX! Window Sensor (tested) - MAX! Wall Thermostat (tested) +### {% linkable_title One Gateway %} + A `maxcube` section must be present in the `configuration.yaml` file and contain the following options as required: ```yaml # Example configuration.yaml entry maxcube: - host: 192.168.0.20 + gateways: + - host: 192.168.0.20 ``` -Configuration variables: -- **host** (*Required*): The IP address of the eQ-3 MAX! Cube to use. -- **port** (*Optional*): The UDP port number. Defaults to `62910`. + +### {% linkable_title Multiple Gateways %} + +```yaml +# Example configuration.yaml entry +maxcube: + gateways: + - host: 192.168.0.20 + port: 62910 + - host: 192.168.0.21 + port: 62910 +``` + +{% configuration %} + host: + description: The IP address of the eQ-3 MAX! Cube to use. + required: true + type: string + port: + description: The UDP port number. + required: false + type: int + default: 62910 + scan_interval: + description: The update interval in seconds + required: false + type: int + default: 300 +{% endconfiguration %} diff --git a/source/_components/media_extractor.markdown b/source/_components/media_extractor.markdown index 114d70f3fe..8386b0390a 100644 --- a/source/_components/media_extractor.markdown +++ b/source/_components/media_extractor.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Media Extractor" -description: "Instructions how to integrate the Media Extractor into Home Assistant." +description: "Instructions on how to integrate the Media Extractor into Home Assistant." date: 2017-07-12 07:00 sidebar: true comments: false diff --git a/source/_components/media_player.anthemav.markdown b/source/_components/media_player.anthemav.markdown index 945fdc0c64..8e59296db9 100644 --- a/source/_components/media_player.anthemav.markdown +++ b/source/_components/media_player.anthemav.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Anthem A/V Receivers" -description: "Instructions how to integrate Anthem A/V Receivers into Home Assistant." +description: "Instructions on how to integrate Anthem A/V Receivers into Home Assistant." date: 2016-12-31 23:11 sidebar: true comments: false diff --git a/source/_components/media_player.apple_tv.markdown b/source/_components/media_player.apple_tv.markdown index 383afdae98..7b16307760 100644 --- a/source/_components/media_player.apple_tv.markdown +++ b/source/_components/media_player.apple_tv.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Apple TV Media Player" -description: "Instructions how to integrate Apple TV devices into Home Assistant." +description: "Instructions on how to integrate Apple TV devices into Home Assistant." date: 2017-02-08 07:11 sidebar: true comments: false diff --git a/source/_components/media_player.blackbird.markdown b/source/_components/media_player.blackbird.markdown new file mode 100644 index 0000000000..99873f1cc0 --- /dev/null +++ b/source/_components/media_player.blackbird.markdown @@ -0,0 +1,70 @@ +--- +layout: page +title: "Blackbird 8x8 HDMI Matrix Switch" +description: "Instructions on how to integrate Monoprice Blackbird 4k 8x8 HDBaseT Matrix Switch into Home Assistant." +date: 2018-03-29 16:35 +sidebar: true +comments: false +sharing: true +footer: true +logo: monoprice.svg +ha_category: Media Player +ha_release: 0.68 +ha_iot_class: "Local Polling" +--- + +The `blackbird` platform allows you to control [Monoprice Blackbird Matrix Switch](https://www.monoprice.com/product?p_id=21819) using a serial connection. + +To add a Blackbird device to your installation, add the following to your `configuration.yaml` file: + +```yaml +# Example configuration.yaml entry +media_player: + - platform: blackbird + type: serial + port: /dev/ttyUSB0 + zones: + 1: + name: Living Room + sources: + 3: + name: BluRay +``` + +{% configuration %} +type: + description: The type of device connection - serial or socket + required: true + type: string +port: + description: The serial port to which Blackbird matrix switch is connected. Either port or host must be defined. + required: optional + type: string +host: + description: The IP address of the Blackbird matrix switch. Either port or host must be defined. + required: optional + type: string +zones: + description: This is the list of zones available. Valid zones are 1,2,3,4,5,6,7,8. Each zone must have a name assigned to it. + required: true + type: int + keys: + name: + description: The name of the zone. +sources: + description: The list of sources available. Valid source numbers are 1,2,3,4,5,6,7,8. Each source number corresponds to the input number on the Blackbird matrix switch. Similar to zones, each source must have a name assigned to it. + required: true + type: int + keys: + name: + description: The name of the source. +{% endconfiguration%} + +### {% linkable_title Service `BLACKBIRD_SETALLZONES` %} + +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. + +| Service data attribute | Optional | Description | +| ---------------------- | -------- | ----------- | +| `entity_id` | yes | String that points at an `entity_id` of a zone. +| `source` | no | String of source name to activate. diff --git a/source/_components/media_player.bluesound.markdown b/source/_components/media_player.bluesound.markdown index 999d2cd929..69372c8c33 100644 --- a/source/_components/media_player.bluesound.markdown +++ b/source/_components/media_player.bluesound.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Bluesound" -description: "Instructions how to integrate Bluesound devices into Home Assistant." +description: "Instructions on how to integrate Bluesound devices into Home Assistant." date: 2017-04-21 19:00 sidebar: true comments: false diff --git a/source/_components/media_player.cast.markdown b/source/_components/media_player.cast.markdown index c97f391dab..13d18534ba 100644 --- a/source/_components/media_player.cast.markdown +++ b/source/_components/media_player.cast.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Google Cast" -description: "Instructions how to integrate Google Cast into Home Assistant." +description: "Instructions on how to integrate Google Cast into Home Assistant." date: 2015-03-23 19:59 sidebar: true comments: false diff --git a/source/_components/media_player.clementine.markdown b/source/_components/media_player.clementine.markdown index c730daf5d9..781ac147a5 100644 --- a/source/_components/media_player.clementine.markdown +++ b/source/_components/media_player.clementine.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Clementine Music Player" -description: "Instructions how to integrate Clementine Music Player within Home Assistant." +description: "Instructions on how to integrate Clementine Music Player within Home Assistant." date: 2017-02-11 17:15 sidebar: true comments: false diff --git a/source/_components/media_player.cmus.markdown b/source/_components/media_player.cmus.markdown index e798889686..1415de1e54 100644 --- a/source/_components/media_player.cmus.markdown +++ b/source/_components/media_player.cmus.markdown @@ -1,7 +1,7 @@ --- layout: page title: "cmus" -description: "Instructions how to integrate cmus Music Player into Home +description: "Instructions on how to integrate cmus Music Player into Home Assistant." date: 2016-06-17 18:45 sidebar: true @@ -23,19 +23,19 @@ media_player: - platform: cmus ``` -if cmus is running on a remote server: +If cmus is running on a remote server: ```yaml # Example configuration.yaml entry media_player: - platform: cmus - host: IP_ADDRESS - password: PASSWORD + host: IP_ADDRESS_OF_CMUS_PLAYER + password: YOUR_PASSWORD ``` Configuration variables: -- **host** (*Optional*): Hostname or IP address of the machine running cmus. Note if a remote cmus is configured that instance must be configured to listen to remote connections, which also requires a password to be set. +- **host** (*Optional*): Hostname or IP address of the machine running cmus. Note if a remote cmus is configured that instance must be configured to listen to remote connections, which also requires a password to be set. - **password** (*Required if host is set*): Password for your cmus player. - **port** (*Optional*): Port of the cmus socket, defaults to 3000. - **name** (*Optional*): The name you'd like to give the cmus player in Home Assistant diff --git a/source/_components/media_player.denon.markdown b/source/_components/media_player.denon.markdown index b8c0e38013..ebfe0177ba 100644 --- a/source/_components/media_player.denon.markdown +++ b/source/_components/media_player.denon.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Denon Network Receivers" -description: "Instructions how to integrate Denon Network Receivers into Home Assistant." +description: "Instructions on how to integrate Denon Network Receivers into Home Assistant." date: 2015-09-08 09:00 sidebar: true comments: false diff --git a/source/_components/media_player.denonavr.markdown b/source/_components/media_player.denonavr.markdown index 31ad2b0160..ee1c434ff4 100644 --- a/source/_components/media_player.denonavr.markdown +++ b/source/_components/media_player.denonavr.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Denon AVR Network Receivers" -description: "Instructions how to integrate Denon AVR Network Receivers into Home Assistant." +description: "Instructions on how to integrate Denon AVR Network Receivers into Home Assistant." date: 2015-09-08 09:00 sidebar: true comments: false diff --git a/source/_components/media_player.directv.markdown b/source/_components/media_player.directv.markdown index 2cd2c7f44d..f7f6559619 100644 --- a/source/_components/media_player.directv.markdown +++ b/source/_components/media_player.directv.markdown @@ -1,7 +1,7 @@ --- layout: page title: "DirecTV" -description: "Instructions how to integrate DirecTV receivers into Home Assistant." +description: "Instructions on how to integrate DirecTV receivers into Home Assistant." date: 2016-07-19 01:0+0000 sidebar: true comments: false diff --git a/source/_components/media_player.dunehd.markdown b/source/_components/media_player.dunehd.markdown index 76c084bcf4..bbf646f0fb 100644 --- a/source/_components/media_player.dunehd.markdown +++ b/source/_components/media_player.dunehd.markdown @@ -1,7 +1,7 @@ --- layout: page title: "DuneHD media players" -description: "Instructions how to integrate DuneHD media players into Home Assistant." +description: "Instructions on how to integrate DuneHD media players into Home Assistant." date: 2016-11-26 09:00 sidebar: true comments: false diff --git a/source/_components/media_player.emby.markdown b/source/_components/media_player.emby.markdown index ca77cbde1a..2f12bc1d80 100644 --- a/source/_components/media_player.emby.markdown +++ b/source/_components/media_player.emby.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Emby" -description: "Instructions how to integrate Emby into Home Assistant." +description: "Instructions on how to integrate Emby into Home Assistant." date: 2016-10-13 22:00 sidebar: true comments: false diff --git a/source/_components/media_player.firetv.markdown b/source/_components/media_player.firetv.markdown index 855333def8..0abf2b3dad 100644 --- a/source/_components/media_player.firetv.markdown +++ b/source/_components/media_player.firetv.markdown @@ -1,7 +1,7 @@ --- layout: page title: "FireTV" -description: "Instructions how to integrate Fire-TV into Home Assistant." +description: "Instructions on how to integrate Fire-TV into Home Assistant." date: 2015-10-23 18:00 sidebar: true comments: false @@ -16,7 +16,7 @@ ha_iot_class: "Local Polling" The `firetv` platform allows you to control a [Amazon Fire TV/stick](http://www.amazon.com/Amazon-DV83YW-Fire-TV/dp/B00U3FPN4U). -The python-firetv Python 2.x module with its helper script that exposes a HTTP server to fetch state and perform actions is used. +The python-firetv Python 2.x module with its helper script that exposes an HTTP server to fetch state and perform actions is used. Steps to configure your Amazon Fire TV stick with Home Assistant: diff --git a/source/_components/media_player.frontier_silicon.markdown b/source/_components/media_player.frontier_silicon.markdown index 0c6a5843fa..c7887e9c8b 100644 --- a/source/_components/media_player.frontier_silicon.markdown +++ b/source/_components/media_player.frontier_silicon.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Frontier Silicon Internet Radios" -description: "Instructions how to integrate Frontier Silicon Internet Radios into Home Assistant." +description: "Instructions on how to integrate Frontier Silicon Internet Radios into Home Assistant." date: 2017-02-04 00:01 sidebar: true comments: false diff --git a/source/_components/media_player.gpmdp.markdown b/source/_components/media_player.gpmdp.markdown index 7207e0e092..c65ed0dff0 100644 --- a/source/_components/media_player.gpmdp.markdown +++ b/source/_components/media_player.gpmdp.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Google Play Music Desktop Player" -description: "Instructions how to integrate GPMDP into Home Assistant." +description: "Instructions on how to integrate GPMDP into Home Assistant." date: 2016-05-09 08:00 sidebar: true comments: false diff --git a/source/_components/media_player.itunes.markdown b/source/_components/media_player.itunes.markdown index fd357eb8ec..6885a33385 100644 --- a/source/_components/media_player.itunes.markdown +++ b/source/_components/media_player.itunes.markdown @@ -1,7 +1,7 @@ --- layout: page title: "iTunes" -description: "Instructions how to integrate iTunes into Home Assistant." +description: "Instructions on how to integrate iTunes into Home Assistant." date: 2015-06-22 11:00 sidebar: true comments: false diff --git a/source/_components/media_player.kodi.markdown b/source/_components/media_player.kodi.markdown index 556812292c..83689d4c1a 100644 --- a/source/_components/media_player.kodi.markdown +++ b/source/_components/media_player.kodi.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Kodi" -description: "Instructions how to integrate Kodi into Home Assistant." +description: "Instructions on how to integrate Kodi into Home Assistant." date: 2015-06-22 11:00 sidebar: true comments: false @@ -17,7 +17,9 @@ ha_iot_class: "Local Push" The `kodi` platform allows you to control a [Kodi](http://kodi.tv/) multimedia system from Home Assistant. -To add Kodi to your installation, add the following to your `configuration.yaml` file: +The preferred way to set up the Kodi platform is by enabling the [discovery component](https://www.home-assistant.io/components/discovery/) which requires enabled [web interface](https://kodi.wiki/view/Web_interface) on your Kodi installation. + +In case the discovery does not work, or you need specific configuration variables, you can add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry diff --git a/source/_components/media_player.lg_netcast.markdown b/source/_components/media_player.lg_netcast.markdown index 138eaec8bd..7a60e23578 100644 --- a/source/_components/media_player.lg_netcast.markdown +++ b/source/_components/media_player.lg_netcast.markdown @@ -1,7 +1,7 @@ --- layout: page title: "LG Netcast TV" -description: "Instructions how to integrate a LG TV (Netcast 3.0 & 4.0) within Home Assistant." +description: "Instructions on how to integrate a LG TV (Netcast 3.0 & 4.0) within Home Assistant." date: 2016-05-12 23:22 sidebar: true comments: false diff --git a/source/_components/media_player.markdown b/source/_components/media_player.markdown index 90507d40e5..40b642dc0c 100644 --- a/source/_components/media_player.markdown +++ b/source/_components/media_player.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Media Player" -description: "Instructions how to setup your media players with Home Assistant." +description: "Instructions on how to setup your media players with Home Assistant." date: 2015-01-24 14:39 sidebar: true comments: false @@ -9,7 +9,7 @@ sharing: true footer: true --- -Interacts with media players on your network. Please check the sidebar for a full list of supported devices. +Interacts with media players on your network. Please check the right sidebar for a full list of supported devices. ## {% linkable_title Services %} @@ -27,7 +27,7 @@ Available services: `turn_on`, `turn_off`, `toggle`, `volume_up`, `volume_down`, | `entity_id` | yes | Target a specific media player. Defaults to all. | | `is_volume_muted` | no | True/false for mute/unmute | -#### {% linkable_title Service `media_player/volume_set` %} +#### {% linkable_title Service `media_player.volume_set` %} | Service data attribute | Optional | Description | |------------------------|----------|--------------------------------------------------| diff --git a/source/_components/media_player.mediaroom.markdown b/source/_components/media_player.mediaroom.markdown index a2eece639d..39a417a5f3 100644 --- a/source/_components/media_player.mediaroom.markdown +++ b/source/_components/media_player.mediaroom.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Mediaroom" -description: "Instructions how to integrate Mediaroom Set-Top Boxes into Home Assistant." +description: "Instructions on how to integrate Mediaroom Set-Top Boxes into Home Assistant." date: 2018-01-22 22:00 sidebar: true comments: false @@ -47,7 +47,7 @@ Notice that all parameters are optional, and discovery should configure everythi The component has been developed for Portuguese TV operators currently using the Mediaroom platform, but should also work in other deployments in which the STB can be controlled remotely through a socket on port 8082. -In most cases (single STB) you just need to setup the *platform* and discovery will do the rest. In case you have more than one STB you are required to set the *host* in each one of the entries. +In most cases (single STB) you just need to setup the *platform* and discovery will do the rest. If the STB is on the same network segment as Home Assistant, it can determine whether the device is turned on or off. Without this, the component will fail to determine the Set-top box status, and you are required to add the *optimistic* configuration variable. @@ -55,8 +55,9 @@ If the STB is on the same network segment as Home Assistant, it can determine wh ### {% linkable_title Example `press_button` script %} -The `play_media` function can be used in scripts to change channels. +The `play_media` function can be used in scripts to change channels and emulate button pressing from a remote control. +{% raw %} ```yaml # Example play_media script # @@ -67,6 +68,8 @@ press_button: entity_id: media_player.mediaroom_stb media_content_id: "{{ value }}" media_content_type: "channel" +``` +{% endraw %} ### {% linkable_title Example configuration with 2 STB %} diff --git a/source/_components/media_player.mpchc.markdown b/source/_components/media_player.mpchc.markdown index 4e4c187d0f..98f6846f3a 100644 --- a/source/_components/media_player.mpchc.markdown +++ b/source/_components/media_player.mpchc.markdown @@ -1,7 +1,7 @@ --- layout: page title: "MPC-HC" -description: "Instructions how to integrate MPC-HC into Home Assistant." +description: "Instructions on how to integrate MPC-HC into Home Assistant." date: 2016-07-27 21:21 sidebar: true comments: false diff --git a/source/_components/media_player.mpd.markdown b/source/_components/media_player.mpd.markdown index b561797aac..51888be2b2 100644 --- a/source/_components/media_player.mpd.markdown +++ b/source/_components/media_player.mpd.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Music Player Daemon (MPD)" -description: "Instructions how to integrate Music Player Daemon into Home Assistant." +description: "Instructions on how to integrate Music Player Daemon into Home Assistant." date: 2016-09-30 23:06 sidebar: true comments: false diff --git a/source/_components/media_player.nad.markdown b/source/_components/media_player.nad.markdown index b35a5ea99b..41684f7212 100644 --- a/source/_components/media_player.nad.markdown +++ b/source/_components/media_player.nad.markdown @@ -1,7 +1,7 @@ --- layout: page title: "NAD" -description: "Instructions how to integrate NAD receivers into Home Assistant." +description: "Instructions on how to integrate NAD receivers into Home Assistant." date: 2016-01-05 20:00 sidebar: true comments: false diff --git a/source/_components/media_player.nadtcp.markdown b/source/_components/media_player.nadtcp.markdown index 98a160f76b..e673e4472d 100644 --- a/source/_components/media_player.nadtcp.markdown +++ b/source/_components/media_player.nadtcp.markdown @@ -1,7 +1,7 @@ --- layout: page title: "NAD tcp" -description: "Instructions how to integrate the NAD D 7050 or C338 digital amplifiers into Home Assistant." +description: "Instructions on how to integrate the NAD D 7050 or C338 digital amplifiers into Home Assistant." date: 2017-06-07 20:00 sidebar: true comments: false diff --git a/source/_components/media_player.onkyo.markdown b/source/_components/media_player.onkyo.markdown index e78075c01a..19854cfe60 100644 --- a/source/_components/media_player.onkyo.markdown +++ b/source/_components/media_player.onkyo.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Onkyo" -description: "Instructions how to integrate Onkyo and some Pioneer receivers into Home Assistant." +description: "Instructions on how to integrate Onkyo and some Pioneer receivers into Home Assistant." date: 2016-03-30 08:00 sidebar: true comments: false @@ -16,6 +16,8 @@ ha_iot_class: "Local Polling" The `onkyo` platform allows you to control a [Onkyo](http://www.onkyo.com/) and some recent [Pioneer](http://www.pioneerelectronics.com) receivers from Home Assistant. Please be aware that you need to enable "Network Standby" for this component to work in your Hardware. +## {% linkable_title Configuration %} + To add an Onkyo or Pioneer receiver to your installation, add the following to your `configuration.yaml` file: ```yaml @@ -28,11 +30,28 @@ media_player: pc: 'HTPC' ``` -Configuration variables: - -- **host** (*Optional*): IP address of the device. Example:`192.168.1.2`. If not specified, the platform will load any discovered receivers. -- **name** (*Required if host is specified*): Name of the device. -- **sources** (*Optional*): A list of mappings from source to source name. Valid sources can be found below. A default list will be used if no source mapping is specified. +{% configuration %} +host: + description: IP address of the device. Example:`192.168.1.2`. If not specified, the platform will load any discovered receivers. + required: false + type: string +name: + description: Name of the device. (*Required if host is specified*) + required: false + type: string +max_volume: + description: Maximum volume. Defaults to 80. + required: false + type: number +sources: + description: A list of mappings from source to source name. Valid sources can be found below. A default list will be used if no source mapping is specified. + required: false + type: list +zone2: + description: Enables control for the receiver's second zone. + required: false + type: bool +{% endconfiguration %} List of source names: diff --git a/source/_components/media_player.openhome.markdown b/source/_components/media_player.openhome.markdown index e174968827..ae10d32d3c 100644 --- a/source/_components/media_player.openhome.markdown +++ b/source/_components/media_player.openhome.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Linn / Openhome" -description: "Instructions how to integrate Linn Ds and Openhome renderers into Home Assistant." +description: "Instructions on how to integrate Linn Ds and Openhome renderers into Home Assistant." date: 2017-02-21 22:40 sidebar: true comments: false diff --git a/source/_components/media_player.panasonic_viera.markdown b/source/_components/media_player.panasonic_viera.markdown index fbbe820c34..2877848601 100644 --- a/source/_components/media_player.panasonic_viera.markdown +++ b/source/_components/media_player.panasonic_viera.markdown @@ -44,9 +44,9 @@ media_player: Configuration variables: -- **host** (*Required*): The IP of the Panasonic Viera TV, e.g. `192.168.0.10`. +- **host** (*Required*): The IP of the Panasonic Viera TV, e.g., `192.168.0.10`. - **port** (*Optional*): The port number of your Panasonic Viera TV. Defaults to `55000`. -- **mac** (*Optional*): The MAC address of your Panasonic Viera TV, e.g. `AA:BB:CC:DD:99:1A`. +- **mac** (*Optional*): The MAC address of your Panasonic Viera TV, e.g., `AA:BB:CC:DD:99:1A`. - **name** (*Optional*): The name you would like to give to the Panasonic Viera TV. ### {% linkable_title Example `play_media` script %} diff --git a/source/_components/media_player.pandora.markdown b/source/_components/media_player.pandora.markdown index 5f0098cff8..76c0406125 100644 --- a/source/_components/media_player.pandora.markdown +++ b/source/_components/media_player.pandora.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Pandora" -description: "Instructions how to integrate Pandora radio into Home Assistant." +description: "Instructions on how to integrate Pandora radio into Home Assistant." date: 2016-06-10 19:59 sidebar: true comments: false @@ -14,17 +14,17 @@ ha_release: 0.22 ha_iot_class: "Local Polling" --- -If you have a Pandora account, you can control it from Home Assistant with this media player. +If you have a Pandora account, you can control it from Home Assistant with this media player. ### {% linkable_title Installation of Pianobar %} This media player uses the [Pianobar command-line Pandora client](https://github.com/PromyLOPh/pianobar), which you have to install separately. This can be done on a Raspberry Pi 2/3 with Raspbian Jessie as follows . _(Note: Other platforms may have different installation processes)_ -The version of pianobar that comes with Jessie has a bug, so you have to build a more recent version. The latest version depends on a recent version of libraries associated with ffmpeg, so you should make sure you go through the backport process documented in [The FFmpeg component](https://home-assistant.io/components/ffmpeg/) before doing this. Install the following basic dependencies: +The version of pianobar that comes with Jessie has a bug, so you have to build a more recent version. The latest version depends on a recent version of libraries associated with ffmpeg, so you should make sure you go through the backport process documented in [The FFmpeg component](/components/ffmpeg/) before doing this. Install the following basic dependencies: ```bash -$ sudo apt-get install git libao-dev libgcrypt11-dev libfaad-dev libmad0-dev libjson0-dev make pkg-config libcurl4-openssl-dev +$ sudo apt-get install git libao-dev libgcrypt11-dev libfaad-dev libmad0-dev libjson0-dev make pkg-config libcurl4-openssl-dev ``` And now install the backported ffmpeg-related libraries (note that if you're using an older version of ffmpeg for other things on this machine, you may encounter issues after doings this): @@ -61,7 +61,7 @@ media_player: - platform: pandora ``` -That's it! Now you will find a media player. If you click it you will find all your stations listed as different sources. If you switch to one, the station will begin playing. +That's it! Now you will find a media player. If you click it you will find all your stations listed as different sources. If you switch to one, the station will begin playing.

diff --git a/source/_components/media_player.philips_js.markdown b/source/_components/media_player.philips_js.markdown index 2db2fe8ded..e776db61a3 100644 --- a/source/_components/media_player.philips_js.markdown +++ b/source/_components/media_player.philips_js.markdown @@ -30,3 +30,4 @@ Configuration variables: - **host** (*Required*): IP address of TV. - **name** (*Optional*): The name you would like to give to the Philips TV. - **turn_on_action** (*Optional*): A script that will be executed to turn on the TV (can be used with wol). +- **api_version** (*Optional*): The JointSpace API version of your Philips TV, defaults to `1`. This is an experimental option and not all the functionalities are guaranteed to work with API versions different from `1`. diff --git a/source/_components/media_player.pioneer.markdown b/source/_components/media_player.pioneer.markdown index 66086c5ded..6bc6d1a5b0 100644 --- a/source/_components/media_player.pioneer.markdown +++ b/source/_components/media_player.pioneer.markdown @@ -29,7 +29,7 @@ Configuration variables: - **host** (*Required*): The IP of the Pioneer device, eg. `192.168.0.10` - **name** (*Optional*): The name you would like to give to the receiver. -- **port** (*Optional*): The port on which the Pioneer device listens, e.g. `23` (default) or `8102` +- **port** (*Optional*): The port on which the Pioneer device listens, e.g., `23` (default) or `8102` - **timeout** (*Optional*): Number of seconds (float) to wait for blocking operations like connect, write, and read. Notes: diff --git a/source/_components/media_player.plex.markdown b/source/_components/media_player.plex.markdown index ddaf3a611b..e17068d221 100644 --- a/source/_components/media_player.plex.markdown +++ b/source/_components/media_player.plex.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Plex" -description: "Instructions how to integrate Plex into Home Assistant." +description: "Instructions on how to integrate Plex into Home Assistant." date: 2015-10-05 21:21 sidebar: true comments: false @@ -69,6 +69,8 @@ media_player: show_all_controls: false use_custom_entity_ids: true use_episode_art: true + remove_unavailable_clients: true + client_remove_interval: 600 ``` - **entity_namespace** (*Optional*): Prefix for entity ID's. Defaults to `null`. Useful when using overlapping components (ex. Apple TV and Plex components when you have Apple TV's you use as Plex clients). Go from _media_player.playroom2_ to _media_player.plex_playroom_ - **include_non_clients** (*Optional*): Display non-recontrollable clients (ex. remote clients, PlexConnect Apple TV's). Defaults to `false`. @@ -76,6 +78,8 @@ media_player: - **show_all_controls** (*Optional*): Forces all controls to display. Defaults to `false`. Ignores dynamic controls (ex. show volume controls for client A but not for client B) based on detected client capabilities. This option allows you to override this detection if you suspect it to be incorrect. - **use_custom_entity_ids** (*Optional*): Name Entity ID's by client ID's instead of friendly names. Defaults to `false`. HA assigns entity ID's on a first come first serve basis. When you have identically named devices connecting (ex. media_player.plex_web_safari, media_player.plex_web_safari2), you can't reliably distinguish and or predict which device is which. This option avoids this issue by using unique client ID's (ex. media_player.dy4hdna2drhn). - **use_episode_art** (*Optional*): Display TV episode art instead of TV show art. Defaults to `false`. +- **remove_unavailable_clients** (*Optional*): Remove stale plex clients from UI after interval. Defaults to `true`. +- **client_remove_interval** (*Optional*): How long a client is to be unavailable for before it is cleaned up. Defaults to `600 seconds (10min)`. ### {% linkable_title Service `play_media` %} diff --git a/source/_components/media_player.roku.markdown b/source/_components/media_player.roku.markdown index 5c889727de..c7771e0f40 100644 --- a/source/_components/media_player.roku.markdown +++ b/source/_components/media_player.roku.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Roku" -description: "Instructions how to integrate Roku into Home Assistant." +description: "Instructions on how to integrate Roku into Home Assistant." date: 2016-05-16 20:0+0000 sidebar: true comments: false diff --git a/source/_components/media_player.samsungtv.markdown b/source/_components/media_player.samsungtv.markdown index 3cabb0f43d..d944b2b3a7 100644 --- a/source/_components/media_player.samsungtv.markdown +++ b/source/_components/media_player.samsungtv.markdown @@ -50,6 +50,7 @@ Currently known supported models: - EH5600 - F6400AF - F6400 +- F8000BF - D6505 - D6300SF - U6000 (port must be set to 8001) @@ -76,10 +77,10 @@ Currently tested but not working models: - JS9500 - State is always "on" and unable to control (but port 8001 *is* open) - MU6300 - Port set to 8001, `pip3 install websocket-client` must be executed, turning on works, status not working reliably, turning off is not permanent (it comes back on) -None of the 2014 (H) and 2015 (J) model series (e.g. J5200) will work, since Samsung have used a different (encrypted) type of interface for these. +None of the 2014 (H) and 2015 (J) model series (e.g., J5200) will work, since Samsung have used a different (encrypted) type of interface for these. If your model is not on the list then give it a test, if everything works correctly then add it to the list on [GitHub](https://github.com/home-assistant/home-assistant.github.io/tree/current/source/_components/media_player.samsungtv.markdown). -The first letter (U, P, L, H & K) represent the screen type, e.g. LED or Plasma. The second letter represents the region, E is Europe, N is North America and A is Asia & Australia. The two numbers following that represent the screen size. +The first letter (U, P, L, H & K) represent the screen type, e.g., LED or Plasma. The second letter represents the region, E is Europe, N is North America and A is Asia & Australia. The two numbers following that represent the screen size. If you add your model remember to remove these before adding them to the list. Currently the ability to select a source is not implemented. diff --git a/source/_components/media_player.songpal.markdown b/source/_components/media_player.songpal.markdown index 65874f99b2..0fd9a73f72 100644 --- a/source/_components/media_player.songpal.markdown +++ b/source/_components/media_player.songpal.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Sony SongPal compatible devices" -description: "Instructions how to integrate Sony Songpal devices into Home Assistant." +description: "Instructions on how to integrate Sony Songpal devices into Home Assistant." date: 2018-02-03 09:00 sidebar: true comments: false @@ -23,7 +23,7 @@ A few notes: - The quick start-up mode has to be enabled in order to turn the device on. - Supports currently only one output terminal, i.e. the volume control works only on the first volume controller as reported by the backend library. -- Some devices, e.g. HT-XT3, do not support decreasing the volume step-by-step correctly. +- Some devices, e.g., HT-XT3, do not support decreasing the volume step-by-step correctly. - Feel free to improve the available services! ## {% linkable_title Configuration %} @@ -52,7 +52,7 @@ See [python-songpal's documentation](https://github.com/rytilahti/python-songpal ## {% linkable_title Services %} -In addition to the general [media player services](https://home-assistant.io/components/media_player/#services), the following services are provided: +In addition to the general [media player services](/components/media_player/#services), the following services are provided: ### {% linkable_title Service `media_player/songpal_set_sound_setting` %} @@ -61,8 +61,8 @@ For a list of available settings and their values use [`songpal sound`](https:// | Service data attribute | Optional | Description | |------------------------|----------|--------------------------------------------------| | `entity_id` | yes | Target entity, leave unset for all devices | -| `name` | no | Configuration variable, e.g. `nightmode` | -| `value` | no | New configuration value, e.g. `on` | +| `name` | no | Configuration variable, e.g., `nightmode` | +| `value` | no | New configuration value, e.g., `on` | diff --git a/source/_components/media_player.sonos.markdown b/source/_components/media_player.sonos.markdown index 3afe420ff4..862cd822f8 100644 --- a/source/_components/media_player.sonos.markdown +++ b/source/_components/media_player.sonos.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Sonos" -description: "Instructions how to integrate Sonos devices into Home Assistant." +description: "Instructions on how to integrate Sonos devices into Home Assistant." date: 2015-09-12 13:00 sidebar: true comments: false diff --git a/source/_components/media_player.soundtouch.markdown b/source/_components/media_player.soundtouch.markdown index fa2a550b02..463914f236 100644 --- a/source/_components/media_player.soundtouch.markdown +++ b/source/_components/media_player.soundtouch.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Soundtouch" -description: "Instructions how to integrate Bose Soundtouch devices into Home Assistant." +description: "Instructions on how to integrate Bose Soundtouch devices into Home Assistant." date: 2016-11-06 13:00 sidebar: true comments: false diff --git a/source/_components/media_player.spotify.markdown b/source/_components/media_player.spotify.markdown index ec34749834..7097e06e20 100644 --- a/source/_components/media_player.spotify.markdown +++ b/source/_components/media_player.spotify.markdown @@ -29,7 +29,7 @@ To create the required Spotify Application: - Login to [Spotify Developer](https://developer.spotify.com) - Visit the [My Applications](https://developer.spotify.com/my-applications/#!/applications) page -- Select **Create An App**. Enter any name and description. Once your application is created, view it and copy your **Client ID** and **Client Secret**, which are used in the Home Assistant configuration file. +- Select **Create An App**. Enter any name and description. Once your application is created, view it and copy your **Client ID** and **Client Secret**, which are used in the Home Assistant configuration file. - Add a **Redirect URI** in the following forms: No SSL: `http://:/api/spotify` @@ -38,7 +38,7 @@ To create the required Spotify Application: The URL is whatever you use to access Home Assistant from outside your network (including port if applicable). -- Click **Save** after adding the URI. You may also need to set the `base_url` attribute of the [HTTP Component](https://home-assistant.io/components/http/). +- Click **Save** after adding the URI. You may also need to set the `base_url` attribute of the [HTTP Component](/components/http/). ## {% linkable_title Configuration %} diff --git a/source/_components/media_player.ue_smart_radio.markdown b/source/_components/media_player.ue_smart_radio.markdown index 217b625b8d..0a250b6b86 100644 --- a/source/_components/media_player.ue_smart_radio.markdown +++ b/source/_components/media_player.ue_smart_radio.markdown @@ -22,8 +22,8 @@ To add your UE Smart Radio player to your installation, add the following to you # Example configuration.yaml entry media_player: - platform: ue_smart_radio - username: USERNAME - password: PASSWORD + username: YOUR_USERNAME + password: YOUR_PASSWORD ``` {% configuration %} diff --git a/source/_components/media_player.universal.markdown b/source/_components/media_player.universal.markdown index 106f114f78..76cbc4a4ba 100644 --- a/source/_components/media_player.universal.markdown +++ b/source/_components/media_player.universal.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Universal" -description: "Instructions how to create a universal media player in Home Assistant." +description: "Instructions on how to create a universal media player in Home Assistant." date: 2016-01-12 22:00 sidebar: true comments: false diff --git a/source/_components/media_player.vizio.markdown b/source/_components/media_player.vizio.markdown index 7c8cfa363b..1557b16649 100644 --- a/source/_components/media_player.vizio.markdown +++ b/source/_components/media_player.vizio.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Vizio SmartCast TV" -description: "Instructions how to integrate Vizio SmartCast TV into Home Assistant." +description: "Instructions on how to integrate Vizio SmartCast TV into Home Assistant." date: 2017-07-10 19:00 sidebar: true comments: false @@ -14,7 +14,7 @@ ha_release: 0.49 ha_iot_class: "Local Polling" --- -The `vizio` component will allow you to control [SmartCast](https://www.vizio.com/smartcast-app) compatible TVs (2016+ models). +The `vizio` component will allow you to control [SmartCast](https://www.vizio.com/smartcast-app) compatible TVs (2016+ models). ## Pairing @@ -36,7 +36,7 @@ Make sure that your TV is on before continuing. If you don't know IP address of your TV run following command: -```bash +```bash $ pyvizio --ip=0 --auth=0 discover ``` @@ -56,14 +56,14 @@ Initiation will show you two different values: Finally, at this point a PIN code should be displayed at the top of your TV. With all these values, you can now finish pairing: ```bash -$ pyvizio --ip={ip} pair_finish --token={challenge_token} --pin={tv_pin} +$ pyvizio --ip={ip} pair_finish --token={challenge_token} --pin={tv_pin} ``` -You will need the authentication token returned by this command to configure Home Assistant. +You will need the authentication token returned by this command to configure Home Assistant. ## Configuration -To add your Vizio TV to your installation, add the following to your `configuration.yaml` file: +To add your Vizio TV to your installation, add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry @@ -84,9 +84,9 @@ Configuration variables: If the `Power Mode` of your TV is set to `Eco Mode`, turning the device ON won't work. -### Changing tracks +### Changing tracks -Changing tracks works like channels switching. If you have source other than regular TV it might end do nothing. +Changing tracks works like channels switching. If you have source other than regular TV it might end do nothing. ### Sources @@ -96,7 +96,7 @@ Source list shows all external devices connected to the TV through HDMI plus lis Vizio SmartCast service is accessible through HTTPS with self-signed certificate. If you have low LOGLEVEL in your Home Assistant configuration, you'll see a lot of warnings like this: `InsecureRequestWarning: Unverified HTTPS request is being made. Adding certificate verification is strongly advised.` -You can adjust the log level for `media_player` components with the [logger](https://home-assistant.io/components/logger/) component, or if you need to keep a low log level for `media_player` you could proxy calls to your TV through an NGINX reverse proxy. +You can adjust the log level for `media_player` components with the [logger](/components/logger/) component, or if you need to keep a low log level for `media_player` you could proxy calls to your TV through an NGINX reverse proxy. If you want to only ignore only this specific [python urllib3 SSL warning](https://urllib3.readthedocs.io/en/latest/advanced-usage.html#ssl-warnings), you will need to run Home Assistant with the python flag `-W` or the environment variable `PYTHONWARNINGS` set to: `ignore:Unverified HTTPS request is being made` diff --git a/source/_components/media_player.volumio.markdown b/source/_components/media_player.volumio.markdown index f8945adc88..26053822e8 100644 --- a/source/_components/media_player.volumio.markdown +++ b/source/_components/media_player.volumio.markdown @@ -12,12 +12,11 @@ ha_category: Media Player ha_release: 0.41 --- -The `Volumio` platform allows you to control a [Volumio](http://volumio.org) media player -from Home Assistant. +The `Volumio` platform allows you to control a [Volumio](http://volumio.org) media player from Home Assistant. +The preferred way to set up the Volumio platform is by enabling the [discovery component](/components/discovery/). -To add a Volumio player to your installation, add the following to -your `configuration.yaml` file. +In case the discovery does not work, or you need specific configuration variables, you can add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry diff --git a/source/_components/media_player.webostv.markdown b/source/_components/media_player.webostv.markdown index 3775ae8260..1d634dcebc 100644 --- a/source/_components/media_player.webostv.markdown +++ b/source/_components/media_player.webostv.markdown @@ -1,7 +1,7 @@ --- layout: page title: "LG webOS Smart TV" -description: "Instructions how to integrate a LG webOS Smart TV within Home Assistant." +description: "Instructions on how to integrate a LG webOS Smart TV within Home Assistant." date: 2016-04-18 23:24 sidebar: true comments: false @@ -19,7 +19,7 @@ The `webostv` platform allows you to control a [LG](http://www.lg.com/) webOS Sm To begin with enable *LG Connect Apps* feature in *Network* settings of the TV [instructions](http://www.lg.com/uk/support/product-help/CT00008334-1437131798537-others). -Once basic configuration is added to your `configuration.yaml` *Configuration* card should prompt on your HA's States. Follow the instructions and accept pairing request on your TV. +Once basic configuration is added to your `configuration.yaml` *Configuration* card should prompt on your Home Assistants's states. Follow the instructions and accept pairing request on your TV. Pairing information will be saved to the `filename:` provided in configuration; this process is IP sensitive, in case the IP address of your TV would change in future. @@ -36,16 +36,18 @@ media_player: Configuration variables: -- **host** (*Optional*): The IP of the LG webOS Smart TV, e.g. `192.168.0.10`. +- **host** (*Optional*): The IP of the LG webOS Smart TV, e.g., `192.168.0.10`. - **turn_on_action** (*Optional*): Defines an [action](/docs/automation/action/) to turn the TV on. - **name** (*Optional*): The name you would like to give to the LG webOS Smart TV. - **timeout** (*Optional*): The timeout for connections to the TV in seconds. - **filename** (*Optional*): The filename where the pairing key with the TV should be stored. This path is relative to Home Assistant's config directory. It defaults to `webostv.conf`. - **customize** array (*Optional*): List of options to customize. - - ***sources** array (*Optional*): List of hardware and webOS App inputs. + - **sources** array (*Optional*): List of hardware and webOS App inputs. If you do not specify `host:`, all LG webOS Smart TVs within your network will be auto-discovered. +### {% linkable_title Example %} + A full configuration example will look like the sample below: ```yaml @@ -53,7 +55,7 @@ A full configuration example will look like the sample below: media_player: - platform: webostv host: 192.168.0.10 - name: Living Room TV + name: Living Room TV timeout: 5 filename: webostv.conf turn_on_action: @@ -67,15 +69,15 @@ media_player: - makotv - netflix ``` -** avoid using `[ ]` in the `name:` of your device. +Avoid using `[ ]` in the `name:` of your device. -*Turn On Action* +### {% linkable_title Turn on action %} Home Assistant is able to turn on a LG webOS Smart TV if you specify an action, like HDMI-CEC or WakeOnLan. -Common for webOS 3.0 and higher would be to use WakeOnLan feature. -To use this feature your TV should be connected to your network via Ethernet rather than Wireless and you should enable *LG Connect Apps* feature in *Network* settings of the TV [instructions](http://www.lg.com/uk/support/product-help/CT00008334-1437131798537-others) (or *Mobile App* in *General* settings for older models) (*may vary by version). +Common for webOS 3.0 and higher would be to use WakeOnLan feature. +To use this feature your TV should be connected to your network via Ethernet rather than Wireless and you should enable *LG Connect Apps* feature in *Network* settings of the TV [instructions](http://www.lg.com/uk/support/product-help/CT00008334-1437131798537-others) (or *Mobile App* in *General* settings for older models). ```yaml # Example configuration.yaml entry @@ -90,9 +92,40 @@ media_player: data: mac: B4:E6:2A:1E:11:0F ``` -Any other [actions](/docs/automation/action/) to power on the device can be configured. +Any other [actions](/docs/automation/action/) to power on the device can be configured. -*Sources* +### {% linkable_title Sources %} To obtain complete list of available sources currently configured on the TV, once the webOS TV is configured and linked, while its powered on head to the **Developer Tools** > **States**, find your `media_player.` and use the sources listed in `source_list:` remembering to split them per line into your `sources:` configuration. + +### {% linkable_title Change channel through play_media service %} + +The `play_media` service can be used in a script to switch to the specified tv channel. +It selects the best matching cannel according to the `media_content_id` parameter: + 1. Channel number *(i.e. '1' or '6')* + 2. Exact channel name *(i.e. 'France 2' or 'CNN')* + 3. Substring in channel name *(i.e. 'BFM' in 'BFM TV')* + +```yaml +# Example action entry in script to switch to channel number 1 +service: media_player.play_media +data: + entity_id: media_player.lg_webos_smart_tv + media_content_id: 1 + media_content_type: "channel" + +# Example action entry in script to switch to channel including 'TF1' in its name +service: media_player.play_media +data: + entity_id: media_player.lg_webos_smart_tv + media_content_id: "TF1" + media_content_type: "channel" +``` + +### {% linkable_title Next/Previous buttons %} + +The behaviour of the next and previsous buttons is different depending on the active source: + + - if the source is 'LiveTV' (television): next/previous buttons act as channel up/down + - otherwise: next/previsous buttons act as next/previous track diff --git a/source/_components/media_player.yamaha.markdown b/source/_components/media_player.yamaha.markdown index c306b1d527..b996e642a4 100644 --- a/source/_components/media_player.yamaha.markdown +++ b/source/_components/media_player.yamaha.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Yamaha Network Receivers" -description: "Instructions how to integrate Yamaha Network Receivers into Home Assistant." +description: "Instructions on how to integrate Yamaha Network Receivers into Home Assistant." date: 2016-03-26 0:58 -0700 sidebar: true comments: false @@ -36,9 +36,9 @@ Configuration variables: default name (often model number) that is returned by the device. - **host** (*Optional*): IP address or hostname of the device - **source_ignore** (*Optional*): List of sources to hide in the front-end -- **source_names** (*Optional*): Mapping of internal AVR source names to custom ones, allowing one to rename e.g. `HDMI1` to `ChromeCast` +- **source_names** (*Optional*): Mapping of internal AVR source names to custom ones, allowing one to rename e.g., `HDMI1` to `ChromeCast` - **zone_ignore** (*Optional*): List of zones to hide in the front-end -- **zone_names** (*Optional*): Mapping of zone names to custom ones, allowing one to rename e.g. `Main_Zone` to `Family Room` +- **zone_names** (*Optional*): Mapping of zone names to custom ones, allowing one to rename e.g., `Main_Zone` to `Family Room` ### {% linkable_title Discovery notes %} @@ -121,5 +121,5 @@ Enable or disable an output port (HDMI) on the receiver. | Service data attribute | Optional | Description | | ---------------------- | -------- | ----------- | | `entity_id` | yes | String or list of strings that point at `entity_id`s of Yamaha receivers. -| `port` | no | Port to enable or disable, e.g. `hdmi1`. +| `port` | no | Port to enable or disable, e.g., `hdmi1`. | `enabled` | no | To enable set true, otherwise set to false. diff --git a/source/_components/media_player.ziggo_mediabox_xl.markdown b/source/_components/media_player.ziggo_mediabox_xl.markdown index 5919b19b50..0581b320a2 100644 --- a/source/_components/media_player.ziggo_mediabox_xl.markdown +++ b/source/_components/media_player.ziggo_mediabox_xl.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Ziggo Mediabox XL" -description: "Instructions how to integrate the Ziggo Mediabox XL into Home Assistant." +description: "Instructions on how to integrate the Ziggo Mediabox XL into Home Assistant." date: 2017-11-10 20:00 sidebar: true comments: false diff --git a/source/_components/melissa.markdown b/source/_components/melissa.markdown index ffc6364fc9..46be358b61 100644 --- a/source/_components/melissa.markdown +++ b/source/_components/melissa.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Melissa Climate" -description: "Instructions how to integrate Melissa Climate into Home Assistant." +description: "Instructions on how to integrate Melissa Climate into Home Assistant." date: 2017-01-05 17:30 sidebar: true comments: false @@ -16,13 +16,15 @@ ha_iot_class: "Cloud Polling" The `Melissa` component is the main component to connect to a [Melissa Climate](http://seemelissa.com/) A/C control. +## {% linkable_title Configuration %} + To set the Melissa component up, add the following information to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry melissa: - username: - password: ******** + username: YOUR_MELISSA_USERNAME + password: YOUR_PASSWORD ``` {% configuration %} diff --git a/source/_components/mercedesme.markdown b/source/_components/mercedesme.markdown index c85b54cd78..db5774c518 100644 --- a/source/_components/mercedesme.markdown +++ b/source/_components/mercedesme.markdown @@ -14,42 +14,14 @@ ha_iot_class: "Cloud Polling" --- -The `Mercedes me` component offers integration with the [Mercedes me](https://www.mercedes-benz.com/de/mercedes-me/) cloud service and provides presence detection as well as sensors such as doors, tires, windows, and service interval. +The `mercedesme` component offers integration with the [Mercedes me](https://www.mercedes-benz.com/de/mercedes-me/) cloud service and provides presence detection as well as sensors such as doors, tires, windows, and service interval. This component provides the following platforms: - - Binary Sensors - such as windows, tires, doors, lock - - Sensors - such as fuel status, service interval, remaining km... - - Device tracker - to track location of your car + + - Binary Sensors: Windows, tires, doors and lock. + - Sensors:Fuel status, service interval, remaining km, etc. + - Device tracker: To track location of your car.

- The component can integrate cars from European and African markets only. -

- -To use Mercedes me in your installation, add the following to your `configuration.yaml` file: - -```yaml -# Example configuration.yaml entry -mercedesme: - username: email - password: password -``` - -{% configuration %} -username: - description: The email address associated with your Mercedes me account. - required: true - type: string -password: - description: The password for your given Mercedes me account. - required: true - type: string -scan_interval: - description: API polling interval. The minimal value can't be less then 30 seconds. - required: true - default: 30 - type: int -{% endconfiguration %} - -

-The requirement `lxml` has to be [installed](http://lxml.de/installation.html) manually `pip install lxml` on some devices. + The component was removed. The vendor disabled the API endpoint and a new API is not available currently.

diff --git a/source/_components/mochad.markdown b/source/_components/mochad.markdown index f27367f0da..bf0617cefb 100644 --- a/source/_components/mochad.markdown +++ b/source/_components/mochad.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Mochad" -description: "Instructions how to integrate Mochad into Home Assistant." +description: "Instructions on how to integrate Mochad into Home Assistant." date: 2016-10-20 17:09 sidebar: true comments: false @@ -13,6 +13,8 @@ ha_release: 0.32 The `mochad` component is the main component to integrate all X10 platforms being controlled by [mochad](https://sourceforge.net/projects/mochad/). Besides this component you will have to setup your X10 devices separately. +## {% linkable_title Configuration %} + To integrate your Mochad units with Home Assistant, add the following section to your `configuration.yaml` file: ```yaml @@ -20,10 +22,20 @@ To integrate your Mochad units with Home Assistant, add the following section to mochad: ``` -Configuration variables: +{% configuration %} +host: + description: The host that mochad is running on. + required: false + type: string + default: localhost +port: + description: The port that mochad is running on. + required: false + type: int + default: 1099 +{% endconfiguration %} -- **host** (*Optional*): The host that mochad is running on. Defaults to `localhost`. -- **port** (*Optional*): The port that mochad is running on. Defaults to `1099`. +## {% linkable_title Example %} A full configuration sample could look like the one below: diff --git a/source/_components/modbus.markdown b/source/_components/modbus.markdown index 9d56005829..dcccf0ede6 100644 --- a/source/_components/modbus.markdown +++ b/source/_components/modbus.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Modbus" -description: "Instructions how to integrate Modbus within Home Assistant." +description: "Instructions on how to integrate Modbus within Home Assistant." date: 2015-04-25 9:16 sidebar: true comments: false @@ -16,6 +16,8 @@ ha_iot_class: "Local Push" [Modbus](http://www.modbus.org/) is a serial communication protocol to control PLCs (Programmable logic controller). It currently supports sensors and switches which can be controlled over serial, TCP, and UDP connections. +## {% linkable_title Configuration %} + To add modbus to your installation, add the following to your `configuration.yaml` file: For a network connection: diff --git a/source/_components/mqtt.markdown b/source/_components/mqtt.markdown index 5514b98c36..275cac866e 100644 --- a/source/_components/mqtt.markdown +++ b/source/_components/mqtt.markdown @@ -1,7 +1,7 @@ --- layout: page title: "MQTT" -description: "Instructions how to setup MQTT within Home Assistant." +description: "Instructions on how to setup MQTT within Home Assistant." date: 2015-08-07 18:00 sidebar: true comments: false @@ -33,6 +33,10 @@ mqtt: broker: IP_ADDRESS_BROKER ``` +

+The minimal setup uses the embedded MQTT broker, however a separate broker is advised for more stability. +

+ ## {% linkable_title Additional features %} - [Certificate](/docs/mqtt/certificate/) diff --git a/source/_components/mqtt_eventstream.markdown b/source/_components/mqtt_eventstream.markdown index da0f6fe3c3..4946433e63 100644 --- a/source/_components/mqtt_eventstream.markdown +++ b/source/_components/mqtt_eventstream.markdown @@ -1,7 +1,7 @@ --- layout: page title: "MQTT Eventstream" -description: "Instructions how to setup MQTT eventstream within Home Assistant." +description: "Instructions on how to setup MQTT eventstream within Home Assistant." date: 2016-01-13 08:00 sidebar: true comments: false @@ -15,6 +15,8 @@ ha_iot_class: depends The `mqtt_eventstream` component connects two Home Assistant instances via MQTT. +## {% linkable_title Configuration %} + To integrate MQTT Eventstream into Home Assistant, add the following section to your `configuration.yaml` file: ```yaml diff --git a/source/_components/mqtt_statestream.markdown b/source/_components/mqtt_statestream.markdown index 5b7b832fe9..8b1afaa89d 100644 --- a/source/_components/mqtt_statestream.markdown +++ b/source/_components/mqtt_statestream.markdown @@ -1,7 +1,7 @@ --- layout: page title: "MQTT Statestream" -description: "Instructions how to setup MQTT Statestream within Home Assistant." +description: "Instructions on how to setup MQTT Statestream within Home Assistant." date: 2017-10-01 20:00 sidebar: true comments: false @@ -15,6 +15,8 @@ ha_iot_class: depends The `mqtt_statestream` component publishes state changes in Home Assistant to individual MQTT topics. +## {% linkable_title Configuration %} + To enable MQTT Statestream in Home Assistant, add the following section to your `configuration.yaml` file: ```yaml diff --git a/source/_components/mychevy.markdown b/source/_components/mychevy.markdown index 64584db11d..15a6b88ff1 100644 --- a/source/_components/mychevy.markdown +++ b/source/_components/mychevy.markdown @@ -13,33 +13,31 @@ ha_release: 0.62 ha_iot_class: "Cloud Polling" --- -The `MyChevy` component communicates with the -[my.chevrolet](https://my.chevrolet.com) website using selenium to log -in as your user, and screen scrape the data provided. GM does not -make it easy to sign up for any official development program, so this -provides a workaround to get access to your data. +The `MyChevy` component communicates with the [my.chevrolet](https://my.chevrolet.com) website using selenium to log in as your user, and screen scrape the data provided. GM does not make it easy to sign up for any official development program, so this provides a workaround to get access to your data. This component provides the following platforms: - - Binary sensors - if the car is plugged in - - Sensors - such as Battery Level, Charge Mode, EST Range, Total - Distance Traveled + + - Binary sensors: if the car is plugged in + - Sensors: Battery Level, Charge Mode, EST Range, Total Distance Traveled + +## {% linkable_title Configuration %} To use MyChevy in your installation, add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry mychevy: - username: email - password: password + username: YOUR_E_MAIL_ADDRESS + password: YOUR_PASSWORD ``` {% configuration %} username: - description: The email address associated with your my.chevrolet account + description: The email address associated with your my.chevrolet account. required: true type: string password: - description: The password for your given my.chevrolet account + description: The password for your given my.chevrolet account. required: true type: string {% endconfiguration %} @@ -47,27 +45,15 @@ password: #### {% linkable_title Installation %} -Because this uses selenium behind the scenes, installation is more -complicated than merely pip install. See the installation instructions -at https://github.com/sdague/mychevy. +Because this uses selenium behind the scenes, installation is more complicated than merely pip install. See the [installation instructions](https://github.com/sdague/mychevy). #### {% linkable_title Limitations %} -The architecture of the GM automotive networking imposes some -limitations on the functionality of the component. +The architecture of the GM automotive networking imposes some limitations on the functionality of the component. -The OnStar network link is very slow, and takes 1 - 3 minutes to get -information back from the car. As such the mychevy component only -polls every 30 minutes to not overwhelms that connection. +The OnStar network link is very slow, and takes 1 - 3 minutes to get information back from the car. As such the mychevy component only polls every 30 minutes to not overwhelms that connection. -The OnStar network (or more specifically the gateway used by the -my.chevrolet website) appears to suffer more than most networks when -the car is a) in a garage, and b) it's cold outside (like < 15 degrees -F). One of the provided sensors is a status sensor which indicates if -we got connectivity with the car on the last polling cycle or not. +The OnStar network (or more specifically the gateway used by the my.chevrolet website) appears to suffer more than most networks when the car is a) in a garage, and b) it's cold outside (like < 15 degrees F). One of the provided sensors is a status sensor which indicates if we got connectivity with the car on the last polling cycle or not. + +The "API" for this is written by web scraping. As such, it only currently is known to work if you have a Chevy Bolt EV, and only 1 Chevy car connected to OnStar. Patches for extended support should go to the https://github.com/sdague/mychevy project first, then Home Assistant can be extended. -The "API" for this is written by web scraping. As such, it only -currently is known to work if you have a Chevy Bolt EV, and only 1 -Chevy car connected to OnStar. Patches for extended support should go -to the https://github.com/sdague/mychevy project first, then -Home Assistant can be extended. diff --git a/source/_components/mycroft.markdown b/source/_components/mycroft.markdown index 705800f6e3..9754096be0 100644 --- a/source/_components/mycroft.markdown +++ b/source/_components/mycroft.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Mycroft" -description: "Instructions how to setup Mycroft AI within Home Assistant." +description: "Instructions on how to setup Mycroft AI within Home Assistant." date: 2017-08-26 17:00 sidebar: true comments: false diff --git a/source/_components/mysensors.markdown b/source/_components/mysensors.markdown index c91f5a123e..f9e9388c67 100644 --- a/source/_components/mysensors.markdown +++ b/source/_components/mysensors.markdown @@ -1,7 +1,7 @@ --- layout: page title: "MySensors" -description: "Instructions how to integrate MySensors sensors into Home Assistant." +description: "Instructions on how to integrate MySensors sensors into Home Assistant." date: 2016-10-01 15:00 +0200 sidebar: true comments: false diff --git a/source/_components/neato.markdown b/source/_components/neato.markdown index 8c5b205e98..82c36d9dfa 100644 --- a/source/_components/neato.markdown +++ b/source/_components/neato.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Neato Robotics" -description: "Instructions how to integrate your Neato within Home Assistant." +description: "Instructions on how to integrate your Neato within Home Assistant." date: 2016-10-09 20:15 sidebar: true comments: false @@ -19,15 +19,21 @@ To enable `neato` in your installation, add the following to your `configuration ```yaml # Example configuration.yaml entry neato: - username: USERNAME - password: PASSWORD + username: YOUR_USERNAME + password: YOUR_PASSWORD ``` -Configuration variables: - -- **username** (*Required*): Username for the Neato account. -- **password** (*Required*): Password for the Neato account. +{% configuration %} +username: + description: Username for the Neato account. + required: true + type: string +password: + description: v + required: true + type: string +{% endconfiguration %}

-After the update to firmware 4.0 (which adds cleaning maps) there is also support for displaying the maps of the Botvac D3 Connected and Botvac D5 Connected robots. The start/stop functionality does not work. More information on how to update here: https://support.neatorobotics.com/hc/en-us/articles/115004320694-Software-Update-4-0-for-Neato-Botvac-Connected-D3-D5- +After the update to firmware 4.0 (which adds cleaning maps) there is also support for displaying the maps of the Botvac D3 Connected and Botvac D5 Connected robots. The start/stop functionality does not work. More information on how to update can be found [here](https://support.neatorobotics.com/hc/en-us/articles/115004320694-Software-Update-4-0-for-Neato-Botvac-Connected-D3-D5-).

diff --git a/source/_components/nest.markdown b/source/_components/nest.markdown index 7aa5adfb9c..718bddc253 100644 --- a/source/_components/nest.markdown +++ b/source/_components/nest.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Nest" -description: "Instructions how to integrate Nest into Home Assistant." +description: "Instructions on how to integrate Nest into Home Assistant." date: 2016-01-29 21:57 sidebar: true comments: false diff --git a/source/_components/netatmo.markdown b/source/_components/netatmo.markdown index ebb254a310..0efe4ac968 100644 --- a/source/_components/netatmo.markdown +++ b/source/_components/netatmo.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Netatmo" -description: "Instructions how to integrate Netatmo component into Home Assistant." +description: "Instructions on how to integrate Netatmo component into Home Assistant." date: 2016-06-02 08:10 sidebar: true comments: false diff --git a/source/_components/notify.apns.markdown b/source/_components/notify.apns.markdown index 30737d617e..dcad472dbb 100644 --- a/source/_components/notify.apns.markdown +++ b/source/_components/notify.apns.markdown @@ -1,7 +1,7 @@ --- layout: page title: "APNS" -description: "Instructions how to add APNS notifications to Home Assistant." +description: "Instructions on how to add APNS notifications to Home Assistant." date: 2016-09-05 23:00 sidebar: true comments: false diff --git a/source/_components/notify.aws_lambda.markdown b/source/_components/notify.aws_lambda.markdown index 21ef850da9..be5a5494ca 100644 --- a/source/_components/notify.aws_lambda.markdown +++ b/source/_components/notify.aws_lambda.markdown @@ -1,7 +1,7 @@ --- layout: page title: "AWS Lambda" -description: "Instructions how to invoke AWS Lambda functions from Home Assistant." +description: "Instructions on how to invoke AWS Lambda functions from Home Assistant." date: 2016-05-14 16:35 sidebar: true comments: false diff --git a/source/_components/notify.aws_sns.markdown b/source/_components/notify.aws_sns.markdown index 21a6b48cc5..cfa69e0084 100644 --- a/source/_components/notify.aws_sns.markdown +++ b/source/_components/notify.aws_sns.markdown @@ -1,7 +1,7 @@ --- layout: page title: "AWS SNS" -description: "Instructions how to publish messages to AWS SNS from Home Assistant." +description: "Instructions on how to publish messages to AWS SNS from Home Assistant." date: 2016-05-14 16:35 sidebar: true comments: false diff --git a/source/_components/notify.aws_sqs.markdown b/source/_components/notify.aws_sqs.markdown index e40e81050b..a1e8a33f8b 100644 --- a/source/_components/notify.aws_sqs.markdown +++ b/source/_components/notify.aws_sqs.markdown @@ -1,7 +1,7 @@ --- layout: page title: "AWS SQS" -description: "Instructions how to publish messages to AWS SQS from Home Assistant." +description: "Instructions on how to publish messages to AWS SQS from Home Assistant." date: 2016-05-14 16:35 sidebar: true comments: false diff --git a/source/_components/notify.ciscospark.markdown b/source/_components/notify.ciscospark.markdown index cf2449fac4..fb55b90a6f 100644 --- a/source/_components/notify.ciscospark.markdown +++ b/source/_components/notify.ciscospark.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Cisco Spark" -description: "Instructions how to add CiscoSpark notifications to Home Assistant." +description: "Instructions on how to add CiscoSpark notifications to Home Assistant." date: 2017-02-20 15:00 sidebar: true comments: false diff --git a/source/_components/notify.clickatell.markdown b/source/_components/notify.clickatell.markdown index 783f3deb58..8ac5d9a614 100644 --- a/source/_components/notify.clickatell.markdown +++ b/source/_components/notify.clickatell.markdown @@ -40,7 +40,7 @@ Configuration variables: * **name** (Optional): Setting the optional parameter name allows multiple notifiers to be created. The default value is `clickatell`. The notifier will bind to the service notify.NOTIFIER_NAME. * **api_key** (Required): Your API key. -* **recipient** (Required): Your phone number. This is where you want to send your notification SMS messages. e.g. `61444333444`. +* **recipient** (Required): Your phone number. This is where you want to send your notification SMS messages. e.g., `61444333444`. -To use notifications, please see the [getting started with automation page](https://home-assistant.io/getting-started/automation/). +To use notifications, please see the [getting started with automation page](/getting-started/automation/). diff --git a/source/_components/notify.clicksend.markdown b/source/_components/notify.clicksend.markdown index e7eb8acc81..8d619617b4 100644 --- a/source/_components/notify.clicksend.markdown +++ b/source/_components/notify.clicksend.markdown @@ -15,9 +15,12 @@ ha_release: 0.48 The `clicksend` platform uses [ClickSend](https://clicksend.com) to deliver notifications from Home Assistant. -### Get your ClickSend API Credentials +## {% linkable_title Prerequisites %} + Go to your [ClickSend Dashboard](https://dashboard.clicksend.com) section and create your new project. After creating your project, you should now be able to obtain your `username` and `api_key`. +## {% linkable_title Configuration %} + To add ClickSend to your installation, add the following to your Home Assistant `configuration.yaml` file: ```yaml @@ -28,6 +31,14 @@ notify: username: CLICKSEND_USERNAME api_key: CLICKSEND_API_KEY recipient: PHONE_NO + +# Multiple recipients +notify: + - platform: clicksend + name: ClickSend + username: CLICKSEND_USERNAME + api_key: CLICKSEND_API_KEY + recipient: [PHONE_NO1, PHONE_NO2] ``` {% configuration %} @@ -44,9 +55,9 @@ api_key: required: true type: string recipient: - description: "Your phone number. This is where you want to send your notification SMS messages, e.g., `09171234567`." + description: "A single or multiple phone numbers. This is where you want to send your SMS notification messages, e.g., `09171234567` or `[09171234567, 09177654321]`." required: true - type: string + type: string or list sender: description: The name or number of the sender. required: false @@ -54,4 +65,4 @@ sender: default: recipient {% endconfiguration %} -To use notifications, please see the [getting started with automation page](https://home-assistant.io/getting-started/automation/). +To use notifications, please see the [getting started with automation page](/getting-started/automation/). diff --git a/source/_components/notify.clicksend_tts.markdown b/source/_components/notify.clicksend_tts.markdown index 28e860834f..6009c9e987 100644 --- a/source/_components/notify.clicksend_tts.markdown +++ b/source/_components/notify.clicksend_tts.markdown @@ -38,5 +38,5 @@ Configuration variables: * **language** (Optional): The language you want to use to convert the message to audio. Accepted values are found in the [ClickSend Documentation](http://docs.clicksend.apiary.io/#reference/voice/voice-languages). Default value is `en-us`. * **voice** (Optional): The voice that needs to be used to play the message to the recipient. Allowed values are `female` or `male`. Default value is `female`. -To use notifications, please see the [getting started with automation page](https://home-assistant.io/getting-started/automation/). +To use notifications, please see the [getting started with automation page](/getting-started/automation/). diff --git a/source/_components/notify.command_line.markdown b/source/_components/notify.command_line.markdown index a5d3b6a594..4f82febe40 100644 --- a/source/_components/notify.command_line.markdown +++ b/source/_components/notify.command_line.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Command line Notify" -description: "Instructions how to add command line notifications to Home Assistant." +description: "Instructions on how to add command line notifications to Home Assistant." date: 2016-02-22 20:00 sidebar: true comments: false diff --git a/source/_components/notify.discord.markdown b/source/_components/notify.discord.markdown index 657b94e84e..01029fb4b1 100644 --- a/source/_components/notify.discord.markdown +++ b/source/_components/notify.discord.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Discord" -description: "Instructions how to add Discord notifications to Home Assistant." +description: "Instructions on how to add Discord notifications to Home Assistant." date: 2016-01-14 15:15 sidebar: true comments: false @@ -16,7 +16,7 @@ The [Discord service](https://discordapp.com/) is a platform for the notify comp In order to get a token you need to go to the [Discord My Apps page](https://discordapp.com/developers/applications/me) and create a new application. Once the application is ready, create a [bot](https://discordapp.com/developers/docs/topics/oauth2#bots) user (**Create a Bot User**) and activate **Require OAuth2 Code Grant**. Retrieve the **Client ID** and the (hidden) **Token** of your bot for later. -When setting up the application you can use this [icon](https://home-assistant.io/demo/favicon-192x192.png). +When setting up the application you can use this [icon](/demo/favicon-192x192.png). To use Discord notifications, add the following to your `configuration.yaml` file: @@ -35,11 +35,11 @@ Configuration variables: ### {% linkable_title Setting up the bot %} -Bots can only send messages to servers. To add the bot to a server you are an admin on, get the details of the bot from the [Discord My Apps page](https://discordapp.com/developers/applications/me). +Bots can only send messages to servers. To add the bot to a server you are an admin on, get the details of the bot from the [Discord My Apps page](https://discordapp.com/developers/applications/me).

-

+

Now use the Discord Authorization page with the **Client ID** of your [bot](https://discordapp.com/developers/docs/topics/oauth2#bots). diff --git a/source/_components/notify.ecobee.markdown b/source/_components/notify.ecobee.markdown index 18ba15b94b..53f97f69d1 100644 --- a/source/_components/notify.ecobee.markdown +++ b/source/_components/notify.ecobee.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Ecobee Notify" -description: "Instructions how to setup the Ecobee notification component within Home Assistant." +description: "Instructions on how to setup the Ecobee notification component within Home Assistant." date: 2016-05-12 09:00 sidebar: true comments: false diff --git a/source/_components/notify.facebook.markdown b/source/_components/notify.facebook.markdown index 0bdb62c8a7..5b4e497947 100644 --- a/source/_components/notify.facebook.markdown +++ b/source/_components/notify.facebook.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Facebook Messenger" -description: "Instructions how to add Facebook user notifications to Home Assistant." +description: "Instructions on how to add Facebook user notifications to Home Assistant." date: 2016-12-31 14:14 sidebar: true comments: false @@ -50,7 +50,7 @@ automation: - '+919784516314' ``` -You can also send messages to users that do not have stored their phone number with Facebook, but this requires a bit more work. The Messenger platform uses page specific user IDs instead of a global user ID. You will need to enable a webhook for the "messages" event in Facebook's developer console. Once a user writes a message to a page, that webhook will then receive the user's page specific ID as part of the webhook's payload. Below is a simple PHP script that reacts to the message "get my id" and sends a reply containing the user's ID: +You can also send messages to users that do not have stored their phone number on Facebook, but this requires a bit more work. The Messenger platform uses page-specific user IDs instead of a global user ID. You will need to enable a webhook for the "messages" event in Facebook's developer console. Once a user writes a message to a page, that webhook will then receive the user's page specific ID as part of the webhook's payload. Below is a simple PHP script that reacts to the message "get my id" and sends a reply containing the user's ID: ```php :homeserver.tld"`, but can also be allocated aliases like `"#roomname:homeserver.tld"`. Make sure to use quotes around the room id or alias to escape special characters (`!`, and `#`) in YAML. The notifying account may need to be invited to the room, depending on the individual rooms policies. diff --git a/source/_components/notify.message_bird.markdown b/source/_components/notify.message_bird.markdown index d8baf5fa0d..2234a86310 100644 --- a/source/_components/notify.message_bird.markdown +++ b/source/_components/notify.message_bird.markdown @@ -1,7 +1,7 @@ --- layout: page title: "MessageBird" -description: "Instructions how to add user notifications to Home Assistant." +description: "Instructions on how to add user notifications to Home Assistant." date: 2016-03-15 17:00 sidebar: true comments: false @@ -28,7 +28,7 @@ Configuration variables: - **api_key** (*Required*): Enter the API key for MessageBird. Go to https://www.messagebird.com/ to retrieve your API key. - **name** (*Optional*): Setting the optional parameter `name` allows multiple notifiers to be created. The default value is `notify`. The notifier will bind to the service `notify.NOTIFIER_NAME`. -- **sender** (*Optional*): Setting the optional parameter `sender`. This will be the sender of the SMS. It may be either a telephone number (e.g. `+4915112345678`) or a text with a maximum length of 11 characters. Defaults to `HA`. +- **sender** (*Optional*): Setting the optional parameter `sender`. This will be the sender of the SMS. It may be either a telephone number (e.g., `+4915112345678`) or a text with a maximum length of 11 characters. Defaults to `HA`. ### {% linkable_title Usage %} diff --git a/source/_components/notify.mqtt.markdown b/source/_components/notify.mqtt.markdown index 7aefb8743f..3f2cb633a9 100644 --- a/source/_components/notify.mqtt.markdown +++ b/source/_components/notify.mqtt.markdown @@ -1,7 +1,7 @@ --- layout: page title: "MQTT Notifications" -description: "Instructions how to add MQTT notifications to Home Assistant." +description: "Instructions on how to add MQTT notifications to Home Assistant." date: 2016-02-01 08:00 sidebar: true comments: false diff --git a/source/_components/notify.mycroft.markdown b/source/_components/notify.mycroft.markdown index f2e7680098..8191788499 100644 --- a/source/_components/notify.mycroft.markdown +++ b/source/_components/notify.mycroft.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Mycroft AI" -description: "Instructions how to add Mycroft AI notifications to Home Assistant." +description: "Instructions on how to add Mycroft AI notifications to Home Assistant." date: 2017-08-26 17:00 UTC sidebar: true comments: false diff --git a/source/_components/notify.mysensors.markdown b/source/_components/notify.mysensors.markdown index e465afe63d..3dab5bc10d 100644 --- a/source/_components/notify.mysensors.markdown +++ b/source/_components/notify.mysensors.markdown @@ -1,7 +1,7 @@ --- layout: page title: "MySensors Notify" -description: "Instructions how to integrate MySensors notifications into Home Assistant." +description: "Instructions on how to integrate MySensors notifications into Home Assistant." date: 2017-01-07 15:00 +0100 sidebar: true comments: false diff --git a/source/_components/notify.nfandroidtv.markdown b/source/_components/notify.nfandroidtv.markdown index cebd644707..e1bf8659ba 100644 --- a/source/_components/notify.nfandroidtv.markdown +++ b/source/_components/notify.nfandroidtv.markdown @@ -38,7 +38,7 @@ Configuration variables: - **position** (*Optional*): Has to be one of: bottom-right (default), bottom-left, top-right, top-left, center - **color** (*Optional*): Has to be one of: grey (default), black, indigo, green, red, cyan, teal, amber, pink - **transparency** (*Optional*): Has to be one of: 0%, 25% (default), 50%, 75%, 100% -- **interrupt** (*Optional*): If set to true, 1, on etc., the notification is interactive and can be dismissed or selected to display more details. Depending on the running app (e.g. Netflix), this may stop playback. +- **interrupt** (*Optional*): If set to true, 1, on etc., the notification is interactive and can be dismissed or selected to display more details. Depending on the running app (e.g., Netflix), this may stop playback. The configuration will be used to configure the default values for the notification for the host specified by the IP. However, you can override most of the settings by passing them with the data-attribute when calling the service. This is a fully customized JSON you can use to test how the final notification will look like: diff --git a/source/_components/notify.nma.markdown b/source/_components/notify.nma.markdown index bbe4e87110..c6165bb898 100644 --- a/source/_components/notify.nma.markdown +++ b/source/_components/notify.nma.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Notify My Android" -description: "Instructions how to add NMA notifications to Home Assistant." +description: "Instructions on how to add NMA notifications to Home Assistant." date: 2015-05-01 18:00 sidebar: true comments: false diff --git a/source/_components/notify.prowl.markdown b/source/_components/notify.prowl.markdown index 2bfeb97fc4..4fbe377bb6 100644 --- a/source/_components/notify.prowl.markdown +++ b/source/_components/notify.prowl.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Prowl" -description: "Instructions how to add Prowl notifications to Home Assistant." +description: "Instructions on how to add Prowl notifications to Home Assistant." date: 2017-08-17 18:00 sidebar: true comments: false diff --git a/source/_components/notify.pushbullet.markdown b/source/_components/notify.pushbullet.markdown index 0ba8c606f3..cadfd99cf9 100644 --- a/source/_components/notify.pushbullet.markdown +++ b/source/_components/notify.pushbullet.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Pushbullet" -description: "Instructions how to add user notifications to Home Assistant." +description: "Instructions on how to add user notifications to Home Assistant." date: 2015-01-20 22:36 sidebar: true comments: false diff --git a/source/_components/notify.pushetta.markdown b/source/_components/notify.pushetta.markdown index 6209d6bcd1..bf31900c34 100644 --- a/source/_components/notify.pushetta.markdown +++ b/source/_components/notify.pushetta.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Pushetta" -description: "Instructions how to add Pushetta notifications to Home Assistant." +description: "Instructions on how to add Pushetta notifications to Home Assistant." date: 2015-11-10 18:00 sidebar: true comments: false diff --git a/source/_components/notify.pushover.markdown b/source/_components/notify.pushover.markdown index 67e7db1098..7e7680db7e 100644 --- a/source/_components/notify.pushover.markdown +++ b/source/_components/notify.pushover.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Pushover" -description: "Instructions how to add Pushover notifications to Home Assistant." +description: "Instructions on how to add Pushover notifications to Home Assistant." date: 2015-01-20 22:36 sidebar: true comments: false @@ -15,7 +15,9 @@ ha_release: pre 0.7 The [Pushover service](https://pushover.net/) is a platform for the notify component. This allows components to send messages to the user using Pushover. -In order to get an API key you need to go to the [Pushover website](https://pushover.net) and register a new application. From the website you can also retrieve your user key. +## {% linkable_title Configuration %} + +In order to get an API key you need to [register an application](https://pushover.net/apps/clone/home_assistant) on the Pushover website. Your Pushover user key can be found on the [Pushover dashboard](https://pushover.net/dashboard). To use Pushover notifications, add the following to your `configuration.yaml` file: @@ -35,32 +37,27 @@ Configuration variables: - **user_key** (*Required*): Your user key for Pushover. Example Automation: + ```yaml - service: notify.entity_id data: message: "This is the message" title: "Title of message" data: - url: "https://home-assistant.io/" + url: "https://www.home-assistant.io/" sound: pianobar priority: 0 ``` + Component specific values in the nested `data` section are optional. -This is a quote from the Pushover website regarding free/open source apps: - -
- If you are creating a client-side library, application, or open source project that will be redistributed and installed by end-users, you may want to require each of your users to register their own application rather than including your own API token with the software. -
- -When setting up the application you can use this [icon](https://home-assistant.io/images/favicon-192x192.png). - To use notifications, please see the [getting started with automation page](/getting-started/automation/). When sending a notification, optional parameters can also be set as per the pushover [API documentation](https://pushover.net/api). Example notification triggered from the Alexa component for an intents is shown below which also uses [Automation Templating](/getting-started/automation-templating/) for the message: +{% raw %} ```yaml # Example configuration.yaml entries alexa: @@ -69,11 +66,12 @@ alexa: action: service: notify.notify data_template: - message: "The location of {% raw %}{{ User }}{% endraw %} has been queried via Alexa." + message: "The location of {{ User }} has been queried via Alexa." data: title: "Home Assistant" data: sound: falling device: pixel - url: "https://home-assistant.io/" + url: "https://www.home-assistant.io/" ``` +{% endraw %} diff --git a/source/_components/notify.pushsafer.markdown b/source/_components/notify.pushsafer.markdown index 61edbe9d8d..5b1ce8ed54 100644 --- a/source/_components/notify.pushsafer.markdown +++ b/source/_components/notify.pushsafer.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Pushsafer" -description: "Instructions how to add Pushsafer notifications to Home Assistant." +description: "Instructions on how to add Pushsafer notifications to Home Assistant." date: 2018-01-05 11:15 sidebar: true comments: false @@ -42,11 +42,11 @@ Message to two devices with formatted text. "message": "Attention [b]bold[/b] text[br][url=https://www.pushsafer.com]Link to Pushsafer[/url]", "target": ["1111", "2222"], "data": { - "icon": "2", + "icon": "2", "iconcolor": "#FF0000", "sound": "2", "vibration": "1", - "url": "https://home-assistant.io/", + "url": "https://www.home-assistant.io/", "urltitle": "Open Home Assistant", "time2live": "0" } @@ -58,18 +58,18 @@ Message to one device with formatted text and image from an external URL. ```json { "title": "Test to 1 device with image from an url", - "message": "Attention [i]italic[/i] Text[br][url=https://home-assistant.io/]Testlink[/url]", + "message": "Attention [i]italic[/i] Text[br][url=https://www.home-assistant.io/]Testlink[/url]", "target": ["1111"], "data": { - "icon": "14", + "icon": "14", "iconcolor": "#FFFF00", "sound": "22", "vibration": "3", - "url": "https://home-assistant.io/", + "url": "https://www.home-assistant.io/", "urltitle": "Open Home Assistant", "time2live": "60", "picture1": { - "url":"https://home-assistant.io/images/components/alexa/alexa-512x512.png" + "url":"https://www.home-assistant.io/images/components/alexa/alexa-512x512.png" } } } @@ -80,14 +80,14 @@ Message to two devices and one device group with formatted text and local image. ```json { "title": "Test to 3 devices with local image", - "message": "Attention [i]italic[/i] Text[br][url=https://home-assistant.io/]Testlink[/url]", + "message": "Attention [i]italic[/i] Text[br][url=https://www.home-assistant.io/]Testlink[/url]", "target": ["1111","2222","gs3333"], "data": { - "icon": "20", + "icon": "20", "iconcolor": "#FF00FF", "sound": "33", "vibration": "0", - "url": "https://home-assistant.io/", + "url": "https://www.home-assistant.io/", "urltitle": "Open Home Assistant", "time2live": "10", "picture1": { @@ -99,6 +99,6 @@ Message to two devices and one device group with formatted text and local image. To customize your push-notification you can take a look at the [Pushsafer API description](https://www.pushsafer.com/en/pushapi). -When setting up the application you can use this [icon](https://home-assistant.io/images/favicon-192x192.png). +When setting up the application you can use this [icon](/images/favicon-192x192.png). To use notifications, please see the [getting started with automation page](/getting-started/automation/). diff --git a/source/_components/notify.rest.markdown b/source/_components/notify.rest.markdown index 370f26be8c..4d1d83c581 100644 --- a/source/_components/notify.rest.markdown +++ b/source/_components/notify.rest.markdown @@ -1,7 +1,7 @@ --- layout: page title: "REST" -description: "Instructions how to add RESTful notifications to Home Assistant." +description: "Instructions on how to add RESTful notifications to Home Assistant." date: 2016-02-12 07:00 sidebar: true comments: false @@ -30,6 +30,7 @@ Configuration variables: - **name** (*Optional*): Setting the optional parameter `name` allows multiple notifiers to be created. The default value is `notify`. The notifier will bind to the service `notify.NOTIFIER_NAME`. - **resource** (*Required*): The resource or endpoint that will receive the value. - **method** (*Optional*): The method of the request. Default is GET. +- **headers** (*Optional*): The headers for the request. - **message_param_name** (*Optional*): Parameter name for the message. Defaults to `message`. - **title_param_name** (*Optional*): Parameter name for the title. Defaults to none. - **target_param_name** (*Optional*): Parameter name for the target. Defaults to none. diff --git a/source/_components/notify.rocketchat.markdown b/source/_components/notify.rocketchat.markdown index 2c014c3054..19d9c876d9 100644 --- a/source/_components/notify.rocketchat.markdown +++ b/source/_components/notify.rocketchat.markdown @@ -13,7 +13,9 @@ ha_release: 0.56 --- -The `rocketchat` platform allows you to send messages to your [Rocket.Chat](https://rocket.chat/) instance from Home Assistant. +The `rocketchat` notify platform allows you to send messages to your [Rocket.Chat](https://rocket.chat/) instance from Home Assistant. + +## {% linkable_title Configuration %} To add Rocket.Chat to your installation, add the following to your `configuration.yaml` file: @@ -23,9 +25,9 @@ notify: - platform: rocketchat name: NOTIFIER_NAME url: https://rocketchat.example.com - username: USERNAME - password: PASSWORD - room: my-awesome-room + username: YOUR_USERNAME + password: YOUR_PASSWORD + room: YOUR_ROOM_NAME ``` - **name** (*Optional*): Name displayed in the frontend. The notifier will bind to the service `notify.NOTIFIER_NAME`. @@ -49,8 +51,7 @@ rocketchat_notification: #### {% linkable_title Message variables %} - **message** (*Required*): Message to be displayed. -- **data** (*Optional*): Dictionary containing any of the variables defined in the - [Rocket.Chat docs](https://rocket.chat/docs/developer-guides/rest-api/chat/postmessage#message-object-example) +- **data** (*Optional*): Dictionary containing any of the variables defined in the [Rocket.Chat docs](https://rocket.chat/docs/developer-guides/rest-api/chat/postmessage#message-object-example) To use notifications, please see the [getting started with automation page](/getting-started/automation/). diff --git a/source/_components/notify.sendgrid.markdown b/source/_components/notify.sendgrid.markdown index 16bf7e992a..2491bac32e 100644 --- a/source/_components/notify.sendgrid.markdown +++ b/source/_components/notify.sendgrid.markdown @@ -1,7 +1,7 @@ --- layout: page title: "SendGrid" -description: "Instructions how to add email notifications via SendGrid to Home Assistant." +description: "Instructions on how to add email notifications via SendGrid to Home Assistant." date: 2016-02-27 18:00 sidebar: true comments: false diff --git a/source/_components/notify.simplepush.markdown b/source/_components/notify.simplepush.markdown index 4747d9a5f4..2556c82037 100644 --- a/source/_components/notify.simplepush.markdown +++ b/source/_components/notify.simplepush.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Simplepush" -description: "Instructions how to add Simplepush notifications to Home Assistant." +description: "Instructions on how to add Simplepush notifications to Home Assistant." date: 2016-09-11 18:00 sidebar: true comments: false diff --git a/source/_components/notify.slack.markdown b/source/_components/notify.slack.markdown index 75b5419f59..3e38499010 100644 --- a/source/_components/notify.slack.markdown +++ b/source/_components/notify.slack.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Slack" -description: "Instructions how to add Slack notifications to Home Assistant." +description: "Instructions on how to add Slack notifications to Home Assistant." date: 2015-08-06 18:00 sidebar: true comments: false diff --git a/source/_components/notify.smtp.markdown b/source/_components/notify.smtp.markdown index 533129e36c..130f3dcf0d 100644 --- a/source/_components/notify.smtp.markdown +++ b/source/_components/notify.smtp.markdown @@ -1,7 +1,7 @@ --- layout: page title: "SMTP" -description: "Instructions how to add e-mail notifications to Home Assistant." +description: "Instructions on how to add e-mail notifications to Home Assistant." date: 2015-06-03 18:00 sidebar: true comments: false @@ -148,7 +148,7 @@ The optional `html` field makes a custom text/HTML multi-part message, allowing ``` -Obviously, this kind of complex html email reporting is done much more conveniently using Jinja2 templating from an [AppDaemon app](https://home-assistant.io/docs/ecosystem/appdaemon/tutorial/), for example. +Obviously, this kind of complex html email reporting is done much more conveniently using Jinja2 templating from an [AppDaemon app](/docs/ecosystem/appdaemon/tutorial/), for example. This platform is fragile and not able to catch all exceptions in a smart way because of the large number of possible configuration combinations. diff --git a/source/_components/notify.stride.markdown b/source/_components/notify.stride.markdown new file mode 100644 index 0000000000..0c79c44667 --- /dev/null +++ b/source/_components/notify.stride.markdown @@ -0,0 +1,63 @@ +--- +layout: page +title: "Stride" +description: "Instructions how to add Stride notifications to Home Assistant." +date: 2018-03-14 15:00 +sidebar: true +comments: false +sharing: true +footer: true +logo: stride.png +ha_category: Notifications +ha_release: 0.66 +--- + +The `stride` platform allows you to send notifications from Home Assistant to [Stride](https://stride.com/). + +You need to obtain a [Stride API token](https://developer.atlassian.com/cloud/stride/security/authentication/#using-room-tokens) to be able to send notifications. When creating the token, you'll see a section labeled "Use this conversation URL to post messages" - it will look something like "https://api.atlassian.com/site/55872e9f-047e-a619-b32c-19d37fbc6038/conversation/26c98c26-0ffd-a11e-3a55-1b397cb71fe0/message". The first set of numbers and letters (`55872e9f-047e-a619-b32c-19d37fbc6038`) is the Cloud ID, and the second set (`26c98c26-0ffd-a11e-3a55-1b397cb71fe0`) is the Room ID. + +To enable the Stride notification in your installation, add the following to your `configuration.yaml` file: + +```yaml +# Example configuration.yaml entry +notify: + - platform: stride + cloudid: CLOUD-ID + token: TOKEN + room: ROOM-ID +``` + +{% configuration %} +name: + description: Setting the optional parameter `name` allows multiple notifiers to be created. The notifier will bind to the service `notify.NOTIFIER_NAME`. + required: false + default: notify + type: string +cloudid: + description: The Stride Cloud ID to use for sending Stride notification. + required: true + type: string +token: + description: The Stride API token to use for sending Stride notifications. + required: true + type: string +room: + description: The default room to post to if no room is explicitly specified when sending the notification. + required: true + type: string +panel: + description: Setting panel will override the default panel type (`None`) for the notification. By default not setting this will post to Stride without using a panel type. Valid options are 'None', 'info', 'note', 'tip', 'warning'. + required: false + type: string +{% endconfiguration %} + +### {% linkable_title Stride service data %} + +The following attributes can be placed `data` for extended functionality. + +| Service data attribute | Optional | Description | +| ---------------------- | -------- | ----------- | +| `room` | yes | (int) Same usage as in configuration.yaml. Overrides any setting set in configuration.yaml. +| `panel` | yes | (str) Same usage as in configuration.yaml. Overrides any setting set in configuration.yaml. + +To use notifications, please see the [getting started with automation page](/getting-started/automation/). diff --git a/source/_components/notify.synology_chat.markdown b/source/_components/notify.synology_chat.markdown index 2ea2dd577d..5fbbae6a04 100644 --- a/source/_components/notify.synology_chat.markdown +++ b/source/_components/notify.synology_chat.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Synology Chat" -description: "Instructions how to add a Synology Chat Bot notifications to Home Assistant." +description: "Instructions on how to add a Synology Chat Bot notifications to Home Assistant." date: 2018-02-15 07:00 sidebar: true comments: false diff --git a/source/_components/notify.syslog.markdown b/source/_components/notify.syslog.markdown index 5e905e73e5..13683e8a8a 100644 --- a/source/_components/notify.syslog.markdown +++ b/source/_components/notify.syslog.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Syslog" -description: "Instructions how to add syslog notifications to Home Assistant." +description: "Instructions on how to add syslog notifications to Home Assistant." date: 2015-06-09 16:00 sidebar: true comments: false diff --git a/source/_components/notify.telegram.markdown b/source/_components/notify.telegram.markdown index ac89f6f23c..534924105d 100644 --- a/source/_components/notify.telegram.markdown +++ b/source/_components/notify.telegram.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Telegram" -description: "Instructions how to add Telegram notifications to Home Assistant." +description: "Instructions on how to add Telegram notifications to Home Assistant." date: 2015-10-09 18:00 sidebar: true comments: false diff --git a/source/_components/notify.twilio_call.markdown b/source/_components/notify.twilio_call.markdown index 9caf251d04..7f0fa2a989 100644 --- a/source/_components/notify.twilio_call.markdown +++ b/source/_components/notify.twilio_call.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Twilio Call" -description: "Instructions how to add user notifications to Home Assistant." +description: "Instructions on how to add user notifications to Home Assistant." date: 2017-01-27 00:09 sidebar: true comments: false diff --git a/source/_components/notify.twilio_sms.markdown b/source/_components/notify.twilio_sms.markdown index ec5002258c..7cec94cf33 100644 --- a/source/_components/notify.twilio_sms.markdown +++ b/source/_components/notify.twilio_sms.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Twilio SMS" -description: "Instructions how to add user notifications to Home Assistant." +description: "Instructions on how to add user notifications to Home Assistant." date: 2016-05-14 14:14 sidebar: true comments: false diff --git a/source/_components/notify.twitter.markdown b/source/_components/notify.twitter.markdown index f63810e68e..6bf8867709 100644 --- a/source/_components/notify.twitter.markdown +++ b/source/_components/notify.twitter.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Twitter" -description: "Instructions how to add Twitter notifications to Home Assistant." +description: "Instructions on how to add Twitter notifications to Home Assistant." date: 2016-01-27 07:00 sidebar: true comments: false diff --git a/source/_components/notify.webostv.markdown b/source/_components/notify.webostv.markdown index 8064c8fbf8..c3dbadfbe4 100644 --- a/source/_components/notify.webostv.markdown +++ b/source/_components/notify.webostv.markdown @@ -1,7 +1,7 @@ --- layout: page title: "LG WebOS TV notifications" -description: "Instructions how to integrate a LG WebOS TV within Home Assistant." +description: "Instructions on how to integrate a LG WebOS TV within Home Assistant." date: 2016-04-18 23:24 sidebar: true comments: false @@ -30,7 +30,7 @@ notify: Configuration variables: -- **host** (*Required*): The IP of the LG WebOS Smart TV, e.g. 192.168.0.10 +- **host** (*Required*): The IP of the LG WebOS Smart TV, e.g., 192.168.0.10 - **name** (*Required*): The name you would like to give to the LG WebOS Smart TV. - **filename** (*Optional*): The filename where the pairing key with the TV should be stored. This path is relative to Home Assistant's config directory. It defaults to `webostv.conf`. - **icon** (*Optional*): The path to an image file to use as the icon in notifications. diff --git a/source/_components/notify.xmpp.markdown b/source/_components/notify.xmpp.markdown index db062932d0..930aa496ac 100644 --- a/source/_components/notify.xmpp.markdown +++ b/source/_components/notify.xmpp.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Jabber (XMPP)" -description: "Instructions how to add Jabber (XMPP) notifications to Home Assistant." +description: "Instructions on how to add Jabber (XMPP) notifications to Home Assistant." date: 2015-05-08 18:00 sidebar: true comments: false diff --git a/source/_components/notify.yessssms.markdown b/source/_components/notify.yessssms.markdown index e320de496a..040acd518b 100644 --- a/source/_components/notify.yessssms.markdown +++ b/source/_components/notify.yessssms.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Yesss SMS" -description: "Instructions how to add user notifications to Home Assistant." +description: "Instructions on how to add user notifications to Home Assistant." date: 2017-10-27 16:00 sidebar: true comments: false diff --git a/source/_components/nuheat.markdown b/source/_components/nuheat.markdown index a261aececb..b3654ebbae 100644 --- a/source/_components/nuheat.markdown +++ b/source/_components/nuheat.markdown @@ -1,7 +1,7 @@ --- layout: page title: "NuHeat" -description: "Instructions how to integrate your NuHeat Signature thermostats within Home Assistant." +description: "Instructions on how to integrate your NuHeat Signature thermostats within Home Assistant." date: 2017-11-11 18:00 sidebar: true comments: false @@ -22,14 +22,14 @@ Once you have the Thermostat ID(s), add the following information to your `confi ```yaml # Example configuration.yaml entry nuheat: - username: you@example.com - password: very-secure-password + username: YOUR_USERNAME + password: YOUR_PASSWORD devices: 12345 # Example configuration.yaml entry with multiple thermostats nuheat: - username: you@example.com - password: very-secure-password + username: YOUR_USERNAME + password: YOUR_PASSWORD devices: - 12345 - 67890 diff --git a/source/_components/nuimo_controller.markdown b/source/_components/nuimo_controller.markdown index e2ed36fba8..92b1bbd618 100644 --- a/source/_components/nuimo_controller.markdown +++ b/source/_components/nuimo_controller.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Nuimo controller" -description: "Instructions how to setup and use a Nuimo device in Home Assistant." +description: "Instructions on how to setup and use a Nuimo device in Home Assistant." date: 2016-08-30 12:00 sidebar: true comments: false diff --git a/source/_components/octoprint.markdown b/source/_components/octoprint.markdown index 192d5d9d9a..03f0fae06d 100644 --- a/source/_components/octoprint.markdown +++ b/source/_components/octoprint.markdown @@ -1,7 +1,7 @@ --- layout: page title: "OctoPrint" -description: "Instructions how to setup the OctoPrint in Home Assistant." +description: "Instructions on how to setup the OctoPrint in Home Assistant." date: 2015-01-20 22:36 sidebar: true comments: false diff --git a/source/_components/panel_custom.markdown b/source/_components/panel_custom.markdown index 49775f2855..0415c561a7 100644 --- a/source/_components/panel_custom.markdown +++ b/source/_components/panel_custom.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Panel Custom" -description: "Instructions how to add customized panels to the frontend of Home Assistant." +description: "Instructions on how to add customized panels to the frontend of Home Assistant." date: 2015-08-08 11:00 sidebar: true comments: false diff --git a/source/_components/panel_iframe.markdown b/source/_components/panel_iframe.markdown index 71ba4b2aec..8aa5514f0c 100644 --- a/source/_components/panel_iframe.markdown +++ b/source/_components/panel_iframe.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Panel iFrame" -description: "Instructions how to add iFrames in the frontend of Home Assistant." +description: "Instructions on how to add iFrames in the frontend of Home Assistant." date: 2015-07-17 18:00 sidebar: true comments: false diff --git a/source/_components/persistent_notification.markdown b/source/_components/persistent_notification.markdown index fbf07e6deb..9fac3ddc0c 100644 --- a/source/_components/persistent_notification.markdown +++ b/source/_components/persistent_notification.markdown @@ -30,7 +30,7 @@ The service `persistent_notification/create` takes in `message`, `title`, and `n The `persistent_notification` component supports specifying [templates](/topics/templating/) for both the `message` and the `title`. This will allow you to use the current state of Home Assistant in your notifications. -In an [action](https://home-assistant.io/getting-started/automation-action/) of your [automation setup](/getting-started/automation/) it could look like this with a customized subject. +In an [action](/getting-started/automation-action/) of your [automation setup](/getting-started/automation/) it could look like this with a customized subject. ```yaml action: @@ -55,6 +55,26 @@ action: notification_id: "1234" ``` + +### {% linkable_title Markdown support %} + +The message attribute supports the [Markdown formatting syntax](https://daringfireball.net/projects/markdown/syntax). Some examples are: + +| Type | Message | +| ---- | ------- | +| Headline 1 | `# Headline` | +| Headline 2 | `## Headline` | +| Newline | `\n` | +| Bold | `**My bold text**` | +| Cursive | `*My cursive text*` | +| Link | `[Link](https://home-assistant.io/)` | +| Image | `![image](/local/my_image.jpg)` | + +

+ `/local/` in this context refers to the `.homeassistant/www/` folder. +

+ + ### {% linkable_title Create a persistent notification %} Choose service developer tool icon **Services** from the **Developer Tools** to call the `persistent_notification` service. Select `persistent_notification/create` from the list of **Available services:** and enter something like the sample below into the **Service Data** field and hit **CALL SERVICE**. diff --git a/source/_components/pilight.markdown b/source/_components/pilight.markdown index a08f4cd935..45e9832381 100644 --- a/source/_components/pilight.markdown +++ b/source/_components/pilight.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Pilight" -description: "Instructions how to setup Pilight within Home Assistant." +description: "Instructions on how to setup Pilight within Home Assistant." date: 2015-08-07 18:00 sidebar: true comments: false @@ -17,23 +17,23 @@ ha_iot_class: "Local Push" This pilight hub connects to the [pilight-daemon](https://manual.pilight.org/programs/daemon.html) via a socket connection to receive and send codes. Thus Home Assistant does not have to run on the computer in charge of the RF communication. -The received and supported RF codes are put on the event bus of Home Assistant and are therefore directly usable by other components (e.g. automation). Additionally a send service is provided to send RF codes. +The received and supported RF codes are put on the event bus of Home Assistant and are therefore directly usable by other components (e.g., automation). Additionally a send service is provided to send RF codes. + +## {% linkable_title Configuration %} To integrate pilight into Home Assistant, add the following section to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry pilight: - host: 127.0.0.1 - port: 5000 ``` Configuration variables: -- **host** (*Required*): The IP address of the computer running the pilight-daemon, e.g. 192.168.1.32. -- **port** (*Required*): The network port to connect to. The usual port is [5000](https://manual.pilight.org/development/api.html). +- **host** (*Optional*): The IP address of the computer running the pilight-daemon, e.g., 192.168.1.32. +- **port** (*Optional*): The network port to connect to. The usual port is [5001](https://manual.pilight.org/development/api.html). - **send_delay** (*Optional*): You can define a send delay as a fraction of seconds if you experience transmission problems when you try to switch multiple switches at once. This can happen when you use a [pilight USB Nano](https://github.com/pilight/pilight-usb-nano) as hardware and switches a whole group of multiple switches on or off. Tested values are between 0.3 and 0.8 seconds depending on the hardware. -- **whitelist** (*Optional*): You can define a whitelist to prevent that too many unwanted RF codes (e.g. the neighbors weather station) are put on your HA event bus. All defined subsections have to be matched. A subsection is matched if one of the items are true. +- **whitelist** (*Optional*): You can define a whitelist to prevent that too many unwanted RF codes (e.g., the neighbors weather station) are put on your HA event bus. All defined subsections have to be matched. A subsection is matched if one of the items are true. In this example only received RF codes using a daycom or Intertechno protocol are put on the event bus and only when the device id is 42. For more possible settings please look at the receiver section of the pilight [API](https://manual.pilight.org/development/api.html). diff --git a/source/_components/plant.markdown b/source/_components/plant.markdown index 80fccc281d..6beaa00557 100644 --- a/source/_components/plant.markdown +++ b/source/_components/plant.markdown @@ -59,7 +59,7 @@ If the sensor data is within the min/max values the status will be `ok`, if not ## Data Source -The main sources of the data will usually be a [MiFlora sensor](/components/sensor.miflora/) or a [MQTT sensor](/components/sensor.miflora/) receiving the data from a [PlantGateway](https://github.com/ChristianKuehnel/plantgateway). +The main sources of the data will usually be a [MiFlora sensor](/components/sensor.miflora/) or a [MQTT sensor](/components/sensor.mqtt/) receiving the data from a [PlantGateway](https://github.com/ChristianKuehnel/plantgateway). If you want to get the date via a PlantGateway, this is a typical configuration for the MQTT sensors: diff --git a/source/_components/proximity.markdown b/source/_components/proximity.markdown index 3d8c45b736..ba8882accd 100644 --- a/source/_components/proximity.markdown +++ b/source/_components/proximity.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Proximity" -description: "Instructions how to setup Proximity monitoring within Home Assistant." +description: "Instructions on how to setup Proximity monitoring within Home Assistant." date: 2016-02-07 10:00 sidebar: true comments: false @@ -50,7 +50,7 @@ proximity: Configuration variables: - **zone** (*Optional*): The zone to which this component is measuring the distance to. Default is the home zone. -- **ignored_zones** array (*Optional*): Where proximity is not calculated for a device (either the device being monitored or ones being compared (e.g. work or school). +- **ignored_zones** array (*Optional*): Where proximity is not calculated for a device (either the device being monitored or ones being compared (e.g., work or school). - **devices** array (*Optional*): A list of devices to compare location against to check closeness to the configured zone. - **tolerance** (*Optional*): The tolerance used to calculate the direction of travel in meters (m) to filter out small GPS coordinate changes. - **unit_of_measurement** (*Optional*): The unit of measurement for distance. Valid values are (km, m, mi, ft) [kilometers, meters, miles and feet respectively]. The default value is kilometers. diff --git a/source/_components/python_script.markdown b/source/_components/python_script.markdown index 5e03edc16c..6881352431 100644 --- a/source/_components/python_script.markdown +++ b/source/_components/python_script.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Python Scripts" -description: "Instructions how to setup Python scripts within Home Assistant." +description: "Instructions on how to setup Python scripts within Home Assistant." date: 2017-06-15 19:59 sidebar: true comments: false @@ -20,7 +20,7 @@ This component allows you to write Python scripts that are exposed as services i | `data` | The data passed to the Python Script service call. | `logger` | A logger to allow you to log messages: `logger.info()`, `logger.warning()`, `logger.error()`. [API reference][logger-api] -[hass-api]: https://home-assistant.io/developers/development_hass_object/ +[hass-api]: /developers/development_hass_object/ [logger-api]: https://docs.python.org/3.4/library/logging.html#logger-objects ## {% linkable_title Writing your first script %} diff --git a/source/_components/qwikswitch.markdown b/source/_components/qwikswitch.markdown index b7958abeda..e915be3979 100644 --- a/source/_components/qwikswitch.markdown +++ b/source/_components/qwikswitch.markdown @@ -1,7 +1,7 @@ --- layout: page title: "QwikSwitch QSUSB Hub" -description: "Instructions how to integrate the QwikSwitch QSUSB Hub into Home Assistant." +description: "Instructions on how to integrate the QwikSwitch QSUSB Hub into Home Assistant." date: 2016-05-04 00:00 sidebar: true comments: false @@ -13,12 +13,9 @@ featured: false ha_release: "0.20" --- +The `qwikswitch` component is the main component to integrate various [QwikSwitch](http://www.qwikswitch.co.za/) devices with Home Assistant. The integration requires the QSUSB Modem device and connects to the QS Mobile application. -The `qwikswitch` component is the main component to integrate various [QwikSwitch](http://www.qwikswitch.co.za/) devices with Home Assistant. - -Loading the `qwikswitch` component automatically adds all devices from the QS Mobile application. QS Mobile controls the QSUSB Modem device. - -Currently QwikSwitch relays and LED dimmers are supported (tested). QwikSwitch relay devices can be [switches](/components/switch.qwikswitch/) or [lights](/components/light.qwikswitch/) in Home-Assistant. If the device name in the QSUSB app ends with ` Switch` it will be created as a switch, otherwise as a light. +The `qwikswitch` component discovers all devices from QS Mobile. Currently, Relays and LED dimmers are discovered in Home Assistant. Relay devices are [lights](/components/light.qwikswitch/) by default, and can be configured as [switches](/components/switch.qwikswitch/). Example configuration: @@ -31,28 +28,67 @@ qwikswitch: Configuration variables: - **url** (*Required*): The URL including the port of your QwikSwitch hub. -- **dimmer_adjust** (*Optional*): A decimal value to adjust the brightness of the dimmer exponentially. Increasing this value allows dimmers that reaches full brightness with low values in QS Mobile to appear more linear in Home Assistant. Recommended values between 1 and 2 and the default is 1. -- **button_events** (*Optional*): A comma separated list of button types that will generate events. Details below. +- **dimmer_adjust** (*Optional*): A decimal value to adjust the brightness of the dimmer exponentially. Increasing this value allows dimmers that reach full brightness with low values in QS Mobile to appear more linear in Home Assistant. Recommended values between 1 and 2 and the default is 1. +- **button_events** (*Optional*): A comma-separated list of button types that will generate events. See [QwikSwitch Events] for detail. +- **switches** (*Optional*): A list of device QS_id's that should be switches, and not lights (i.e. `['@0dev01', '@0dev02']`) +- **sensors** (*Optional*): A dictionary of sensors. In the format of {entity_id: QS_id}. (i.e. `{door_sensor: '@0dev03'}`) -### {% linkable_title QwikSwitch Buttons %} +### {% linkable_title QwikSwitch Events %} -QwikSwitch devices (i.e. transmitter buttons) will fire events on the Home Assistant bus. These events can then be used as triggers for any `automation` action, as follows: +QwikSwitch devices (i.e., transmitter buttons) will fire events on the Home Assistant bus. These events can then be used as triggers for any `automation` action, as follows: ```yaml automation: - - alias: Action - Respond to button press + - alias: Action - Respond to A button press trigger: platform: event event_type: qwikswitch.button.@12df34 ``` -`event_type` names should be in the format **qwikswitch.button.@__ID__**. where **@__ID__** will be captured in the Home Assistant log when pressing the button. Alternatively, you can also get the device ID from the QS Mobile application or using the listen API call by browsing to `http://127.0.0.1:2020/&listen` and then pressing the button. +`event_type` names should be in the format **qwikswitch.button.@_QS_id_**. where **@_QS_id_** will be captured in the Home Assistant log when pressing the button. Alternatively, you can also get the device ID from the QS Mobile application or by using the listen API call by browsing to `http://127.0.0.1:2020/&listen` and then pressing the button. + +The full packet from the QSUSB API will be passed as `data` By default events will be fired if the value in the command (cmd) field of the listen packet equals: - `TOGGLE` - Normal QwikSwitch Transmitter button - `SCENE EXE` - QwikSwitch Scene Transmitter buttons - `LEVEL` - QwikSwitch OFF Transmitter buttons -The list of recognized commands can be extended for Keyfobs, door sensors, and PIR transmitters with the **button_events** configuration option. **button_events** contain a comma separated list of commands that will fire Home Assistant events. By default it is: TOGGLE,SCENE EXE,LEVEL. +The list of recognized commands can be extended for Keyfobs, door sensors, and PIR transmitters with the **button_events** configuration option. **button_events** can be a list or comma separated list of additional commands that will fire Home Assistant events. By default, it is: TOGGLE,SCENE EXE,LEVEL. On some QS Mobile servers button events are only generated for switches added to the QS Mobile application, so it might be best to test button presses through the `/&listen` API + +### {% linkable_title Qwikswitch Sensors %} + +The sensor configuration is a list of sensors. Depending on the type, it will be a sensor or binary_sensor. Each sensor is configured with the following parameters: + +- **name** (*Required*): The sensor name from which the entity_id will be derived. +- **id** (*Required*): A QS_Id +- **type** (*Required*): The Qwikswitch sensor type. These could include: + - imod (binary_sensor, up to 6 channels) + - door (binary_sensor, single channel) + - qwikcord (Channel 1 = CTavg, Channel 2 = CTsum) +- **channel** (*Optional, default=1*): The channel of interest. Refer to type above. + +The following parameters are only applicabe to binary_sensors (i.e. door/imod). +- **invert** (*Optional, default=False): Invert the open/close state. +- **class** (*Optional, default=door): The [class](https://www.home-assistant.io/components/binary_sensor) or binary_sensor. + +Example sensor configuration: + +```yaml +qwikswitch: + ... + sensors: + - name: door sensor + id: "@id03" + type: door + - name: Imod 1 sensor + id: "@id02" + channel: 1 + type: imod + - name: Imod 2 sensor + id: "@id02" + channel: 2 + type: imod +``` diff --git a/source/_components/rainbird.markdown b/source/_components/rainbird.markdown index 4257826b7d..95c7b9b0d9 100644 --- a/source/_components/rainbird.markdown +++ b/source/_components/rainbird.markdown @@ -18,15 +18,22 @@ This `rainbird` component allows interacting with [LNK WiFi](http://www.rainbird To enable it, add the following to your `configuration.yaml` file: ```yaml +# Example configuration.yaml entry rainbird: - host: '1.1.1.1' - password: 'XXXXXXX' + host: IP_ADDRESS_OF_MODULE + password: YOUR_PASSWORD ``` -Configuration variables: - -- **host** (*Required*): The IP address of your LNK WiFi Module. -- **password** (*Required*): The password for accessing the module. +{% configuration %} +host: + description: v + required: true + type: string +password: + description: The password for accessing the module. + required: true + type: string +{% endconfiguration %} Finish its configuration by visiting the [Rain Bird sensor](/components/sensor.rainbird/) and [Rain Bird switch](/components/switch.rainbird/) documentation. diff --git a/source/_components/raincloud.markdown b/source/_components/raincloud.markdown index 6e4e3919a0..3eb377e046 100644 --- a/source/_components/raincloud.markdown +++ b/source/_components/raincloud.markdown @@ -18,16 +18,20 @@ To enable it, add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry - raincloud: - username: you@example.com - password: secret + username: YOUR_USERNAME + password: YOUR_PASSWORD ``` -Configuration variables: - -- **username** (*Required*): The username for accessing your Melnor RainCloud account. -- **password** (*Required*): The password for accessing your Melnor RainCloud account. -- **scan_interval** (*Optional*): Defines the update interval of the sensor in seconds. Defaults to 20seconds. +{% configuration %} +username: + description: The username for accessing your Melnor RainCloud account. + required: true + type: string +password: + description: The password for accessing your Melnor RainCloud account. + required: true + type: string +{% endconfiguration %} Finish its configuration by visiting the [Raincloud binary sensor](/components/binary_sensor.raincloud/), [Raincloud sensor](/components/sensor.raincloud/) and [Raincloud switch](/components/switch.raincloud/) documentation. diff --git a/source/_components/rainmachine.markdown b/source/_components/rainmachine.markdown new file mode 100644 index 0000000000..e416c7f626 --- /dev/null +++ b/source/_components/rainmachine.markdown @@ -0,0 +1,71 @@ +--- +layout: page +title: "RainMachine" +description: "Instructions on how to integrate RainMachine units within Home Assistant." +date: 2018-04-25 20:32 +sidebar: true +comments: false +sharing: true +footer: true +logo: rainmachine.png +ha_category: Hub +ha_release: 0.69 +ha_iot_class: "Cloud Polling" +--- + +The `rainmachine` component is the main component to integrate all platforms +related to [RainMachine smart Wi-Fi sprinkler controllers](http://www.rainmachine.com/). + +## {% linkable_title Base Configuration %} + +To connect to your RainMachine device, add the following to your +`configuration.yaml` file: + +```yaml +rainmachine: + ip_address: 192.168.1.100 + password: YOUR_PASSWORD +``` + +To configure switch-related functionality, add configuration options beneath +a `switches` key within the `rainmachine` sections of `configuration.yaml` +as below: + +```yaml +rainmachine: + ip_address: 192.168.1.100 + password: YOUR_PASSWORD + switches: + # switch configuration options... +``` + +{% configuration %} +ip_address: + description: the IP address or hostname of your RainMachine unit + required: optional + type: string +password: + description: your RainMachine password. + required: true + type: string +port: + description: the TCP port used by your unit for the REST API + required: false + type: int + default: 8080 +ssl: + description: whether communication with the local device should occur over HTTPS + required: false + type: boolean + default: true +switches: + description: switch-related configuration options + required: false + type: map + keys: + zone_run_time: + description: the default number of seconds that a zone should run when turned on + required: false + type: int + default: 600 +{% endconfiguration %} diff --git a/source/_components/raspihats.markdown b/source/_components/raspihats.markdown index b20878e648..fbe53d3d90 100644 --- a/source/_components/raspihats.markdown +++ b/source/_components/raspihats.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Raspihats" -description: "Instructions how to integrate Raspihats add-on boards for Raspberry Pi into Home Assistant." +description: "Instructions on how to integrate Raspihats add-on boards for Raspberry Pi into Home Assistant." date: 2017-05-01 04:06 sidebar: true comments: false diff --git a/source/_components/recorder.markdown b/source/_components/recorder.markdown index 6e51c65382..b7410f68ea 100644 --- a/source/_components/recorder.markdown +++ b/source/_components/recorder.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Recorder" -description: "Instructions how to configure the data recorder for Home Assistant." +description: "Instructions on how to configure the data recorder for Home Assistant." date: 2017-09-24 09:00 sidebar: true comments: false @@ -119,7 +119,7 @@ recorder: - sensor.date ``` -If you only want to hide events from e.g. your history, take a look at the [`history` component](/components/history/). Same goes for logbook. But if you have privacy concerns about certain events or neither want them in history or logbook, you should use the `exclude`/`include` options of the `recorder` component, that they aren't even in your database. That way you can save storage and keep the database small by excluding certain often-logged events (like `sensor.last_boot`). +If you only want to hide events from e.g., your history, take a look at the [`history` component](/components/history/). Same goes for logbook. But if you have privacy concerns about certain events or neither want them in history or logbook, you should use the `exclude`/`include` options of the `recorder` component, that they aren't even in your database. That way you can save storage and keep the database small by excluding certain often-logged events (like `sensor.last_boot`). ### {% linkable_title Service `purge` %} diff --git a/source/_components/remember_the_milk.markdown b/source/_components/remember_the_milk.markdown index c7244b2f0b..70abbed77e 100644 --- a/source/_components/remember_the_milk.markdown +++ b/source/_components/remember_the_milk.markdown @@ -12,7 +12,7 @@ ha_category: Calendar ha_release: 0.57 --- -The `Remember The Milk` (RTM) component allows you to create tasks in [remember_the_milk](https://www.rememberthemilk.com) from Home Assistant. You can use this if you want Home Assistant to send you a task that you should not forget, e.g. water the plants. The component allows you to have several RTM accounts in parallel. +The `Remember The Milk` (RTM) component allows you to create tasks in [remember_the_milk](https://www.rememberthemilk.com) from Home Assistant. You can use this if you want Home Assistant to send you a task that you should not forget, e.g., water the plants. The component allows you to have several RTM accounts in parallel. ## {% linkable_title Setup %} @@ -51,7 +51,7 @@ Configuration variables: ### {% linkable_title Step 2: registering your account %} -After saving the configuration, you need to (re-)start Home Assistant. On the first start you will notice a new "Configuration" panel appearing on the Home Assistant page. After opening the configuration page, follow the link "Remember The Milk login". This will take you to a login page where you have to log in with your normal Rember The Milk credentials. This will authorize Home Assistant to access your Remember The Milk account. +After saving the configuration, you need to (re-)start Home Assistant. On the first start you will notice a new "Configuration" panel appearing on the Home Assistant page. After opening the configuration page, follow the link "Remember The Milk login". This will take you to a login page where you have to log in with your normal Remember The Milk credentials. This will authorize Home Assistant to access your Remember The Milk account. After that click on the "login completed" button. This will tell Home Assistant that you have completed the login process on the Remember The Milk page and Home Assistant should try to register with this account. diff --git a/source/_components/remote.apple_tv.markdown b/source/_components/remote.apple_tv.markdown index 692de767fc..7fe3bc7f9a 100644 --- a/source/_components/remote.apple_tv.markdown +++ b/source/_components/remote.apple_tv.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Apple TV Remote" -description: "Instructions how to integrate Apple TV remote into Home Assistant." +description: "Instructions on how to integrate Apple TV remote into Home Assistant." date: 2017-06-26 20:50 sidebar: true comments: false diff --git a/source/_components/remote.harmony.markdown b/source/_components/remote.harmony.markdown index cc2eba65cc..c6178d048c 100755 --- a/source/_components/remote.harmony.markdown +++ b/source/_components/remote.harmony.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Harmony Hub Remote" -description: "Instructions how to integrate Harmony Hub remotes into Home Assistant." +description: "Instructions on how to integrate Harmony Hub remotes into Home Assistant." date: 2016-11-05 17:00 sidebar: true comments: false @@ -35,7 +35,7 @@ remote: host: 10.168.1.13 ``` -You can override some default configuration values on a discovered hub (e.g. the `port` or `activity`) by adding a `configuration.yaml` setting. In this case leave the `host` setting empty so the platform will discover the host IP automatically, but set the `name` in the config to match exactly the name you have set for your Hub so the platform knows what Hub you are trying to configure. +You can override some default configuration values on a discovered hub (e.g., the `port` or `activity`) by adding a `configuration.yaml` setting. In this case leave the `host` setting empty so the platform will discover the host IP automatically, but set the `name` in the config to match exactly the name you have set for your Hub so the platform knows what Hub you are trying to configure. ```yaml # Example configuration.yaml entry with discovery diff --git a/source/_components/remote.itach.markdown b/source/_components/remote.itach.markdown index 35e14d1852..5dd51679a2 100755 --- a/source/_components/remote.itach.markdown +++ b/source/_components/remote.itach.markdown @@ -16,7 +16,7 @@ ha_release: 0.39 The `itach` remote platform allows you to control IR devices with a [Global Caché iTach Device](https://www.globalcache.com/products/itach/ip2irspecs) and GC-100 devices. The Global Cache IR API are similar across their product line. See API documentation links at the end of this page. -In order to utilize the digital input (binary sensor) and relay (switch) features of your Global Cache device you will need to use the [gc100 component](https://home-assistant.io/components/gc100) and associated platforms. +In order to utilize the digital input (binary sensor) and relay (switch) features of your Global Cache device you will need to use the [gc100 component](/components/gc100) and associated platforms. To use your iTach remote in your installation, you will need to know the IR commands for your devices in Pronto hex format and add the following to your `configuration.yaml` file: diff --git a/source/_components/remote.kira.markdown b/source/_components/remote.kira.markdown index 7924da8fe7..376d29837a 100644 --- a/source/_components/remote.kira.markdown +++ b/source/_components/remote.kira.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Kira Remote" -description: "Instructions how to integrate Kira modules into Home Assistant." +description: "Instructions on how to integrate Kira modules into Home Assistant." date: 2017-05-07 17:00 sidebar: true comments: false diff --git a/source/_components/remote.markdown b/source/_components/remote.markdown index fada23fde3..7359fae9d2 100755 --- a/source/_components/remote.markdown +++ b/source/_components/remote.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Remotes" -description: "Instructions how to setup your remotes with Home Assistant." +description: "Instructions on how to setup your remotes with Home Assistant." date: 2016-11-05 19:39 sidebar: true comments: false diff --git a/source/_components/rest_command.markdown b/source/_components/rest_command.markdown index e42610fef5..4475396730 100644 --- a/source/_components/rest_command.markdown +++ b/source/_components/rest_command.markdown @@ -1,7 +1,7 @@ --- layout: page title: "RESTful Command" -description: "Instructions how to integrate REST commands into Home Assistant." +description: "Instructions on how to integrate REST commands into Home Assistant." date: 2018-02-24 00:00 sidebar: true comments: false diff --git a/source/_components/rflink.markdown b/source/_components/rflink.markdown index 33e2113215..a8f340c48f 100644 --- a/source/_components/rflink.markdown +++ b/source/_components/rflink.markdown @@ -1,7 +1,7 @@ --- layout: page title: "RFLink" -description: "Instructions how to integrate RFLink gateway into Home Assistant." +description: "Instructions on how to integrate RFLink gateway into Home Assistant." date: 2016-01-04 sidebar: true comments: false @@ -68,7 +68,7 @@ $ socat /dev/ttyACM0,b57600 TCP-LISTEN:1234,reuseaddr Other methods of exposing the serial interface over TCP are possible (eg: ESP8266 or using Arduino Wifi shield). Essentially the serial stream should be directly mapped to the TCP stream. -Tested with Wifi serial bridge [esp-link V2.2.3](https://github.com/jeelabs/esp-link/releases/tag/v2.2.3) running on a NodeMCU (ESP8266 Wifi module) with ESP8266 TXD0 (pin D10) and RXD0 (pin D9) connected to Arduino MEGA 2560 RX (Pin 2) and TX (Pin 3) respectively. +Tested with Wifi serial bridge [esp-link V2.2.3](https://github.com/jeelabs/esp-link/releases/tag/v2.2.3) running on a NodeMCU (ESP8266 Wifi module) with ESP8266 TXD0 (pin D10) and RXD0 (pin D9) connected to Arduino MEGA 2560 RX (Pin 2) and TX (Pin 3) respectively.

Due to different logic levels, a voltage level shifter is required between the 3.3V NodeMCU and 5V Arduino MEGA 2560 pins. The BSS138 bidirectional logic level converter has been tested for serial pins and the [link](https://www.aliexpress.com/item/8CH-IIC-I2C-Logic-Level-Converter-Bi-Directional-Module-DC-DC-5V-to-3-3V-Setp/32238089139.html) is recommended for the CC2500 transceiver (used for Ikea Ansluta and Philips Living Colors) @@ -136,7 +136,7 @@ If you find a device is recognized differently, with different protocols or the ### {% linkable_title Technical Overview %} - The`rflink` Python module is an asyncio transport/protocol which is setup to fire a callback for every (valid/supported) packet received by the RFLink gateway. -- This component uses this callback to distribute 'rflink packet events' over [Home Assistant's event bus](https://home-assistant.io/docs/configuration/events/) which can be subscribed to by entities/platform implementations. +- This component uses this callback to distribute 'rflink packet events' over [Home Assistant's event bus](/docs/configuration/events/) which can be subscribed to by entities/platform implementations. - The platform implementation takes care of creating new devices (if enabled) for unseen incoming packet ID's. - Device entities take care of matching to the packet ID, interpreting and performing actions based on the packet contents. Common entity logic is maintained in this main component. diff --git a/source/_components/rfxtrx.markdown b/source/_components/rfxtrx.markdown index 64c0e1dee4..046e27ac02 100644 --- a/source/_components/rfxtrx.markdown +++ b/source/_components/rfxtrx.markdown @@ -1,7 +1,7 @@ --- layout: page title: "RFXtrx" -description: "Instructions how to integrate RFXtrx into Home Assistant." +description: "Instructions on how to integrate RFXtrx into Home Assistant." date: 2015-10-08 10:15 sidebar: true comments: false @@ -24,7 +24,7 @@ rfxtrx: Configuration variables: -- **device** (*Required*): The path to your device, e.g. `/dev/serial/by-id/usb-RFXCOM_RFXtrx433_A1Y0NJGR-if00-port0` +- **device** (*Required*): The path to your device, e.g., `/dev/serial/by-id/usb-RFXCOM_RFXtrx433_A1Y0NJGR-if00-port0` - **debug** (*Optional*): If you want to receive debug output. - **dummy** (*Optional*): Then you have need a connected drive to test your settings. Can be useful for debugging and testing. diff --git a/source/_components/ring.markdown b/source/_components/ring.markdown index 762810d6a7..4daf012653 100644 --- a/source/_components/ring.markdown +++ b/source/_components/ring.markdown @@ -21,13 +21,19 @@ To enable device linked in your [Ring.com](https://ring.com/) account, add the f ```yaml # Example configuration.yaml entry ring: - username: you@example.com - password: secret + username: YOUR_USERNAME + password: YOUR_PASSWORD ``` -Configuration variables: - -- **username** (*Required*): The username for accessing your Ring account. -- **password** (*Required*): The password for accessing your Ring account. +{% configuration %} +username: + description: The username for accessing your Ring account. + required: true + type: string +password: + description: The password for accessing your Ring account. + required: true + type: string +{% endconfiguration %} Finish its configuration by visiting the [Ring binary sensor](/components/binary_sensor.ring/) or [Ring sensor](/components/sensor.ring/) documentation. diff --git a/source/_components/rpi_gpio.markdown b/source/_components/rpi_gpio.markdown index 642804ffff..31a1befde2 100644 --- a/source/_components/rpi_gpio.markdown +++ b/source/_components/rpi_gpio.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Raspberry Pi GPIO" -description: "Instructions how to integrate the GPIO capability of a Raspberry Pi into Home Assistant." +description: "Instructions on how to integrate the GPIO capability of a Raspberry Pi into Home Assistant." date: 2016-08-30 19:00 sidebar: true comments: false diff --git a/source/_components/rpi_pfio.markdown b/source/_components/rpi_pfio.markdown index 51feb22b70..1b3c4785e5 100644 --- a/source/_components/rpi_pfio.markdown +++ b/source/_components/rpi_pfio.markdown @@ -1,7 +1,7 @@ --- layout: page title: "PiFace Digital I/O" -description: "Instructions how to integrate the PiFace Digital I/O module into Home Assistant." +description: "Instructions on how to integrate the PiFace Digital I/O module into Home Assistant." date: 2016-05-08 15:00 sidebar: true comments: false diff --git a/source/_components/scene.hunterdouglas_powerview.markdown b/source/_components/scene.hunterdouglas_powerview.markdown index 2f63ba6264..2ef810a113 100644 --- a/source/_components/scene.hunterdouglas_powerview.markdown +++ b/source/_components/scene.hunterdouglas_powerview.markdown @@ -1,7 +1,7 @@ --- layout: page title: "PowerView Scenes" -description: "Instructions how to setup Hunter Douglas PowerView scenes within Home Assistant." +description: "Instructions on how to setup Hunter Douglas PowerView scenes within Home Assistant." date: 2016-03-11 16:00 sidebar: true comments: false diff --git a/source/_components/scene.litejet.markdown b/source/_components/scene.litejet.markdown index fca7954e1b..511c1cb6fa 100644 --- a/source/_components/scene.litejet.markdown +++ b/source/_components/scene.litejet.markdown @@ -1,7 +1,7 @@ --- layout: page title: "LiteJet Scenes" -description: "Instructions how to setup LiteJet scenes within Home Assistant." +description: "Instructions on how to setup LiteJet scenes within Home Assistant." date: 2016-10-26 16:00 sidebar: true comments: false diff --git a/source/_components/scene.lutron_caseta.markdown b/source/_components/scene.lutron_caseta.markdown index 2d10556edf..7e07ed485e 100644 --- a/source/_components/scene.lutron_caseta.markdown +++ b/source/_components/scene.lutron_caseta.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Lutron Caseta Scene" -description: "Instructions how to setup Lutron Caseta Scenes within Home Assistant." +description: "Instructions on how to setup Lutron Caseta Scenes within Home Assistant." date: 2017-07-28 16:00 sidebar: true comments: false diff --git a/source/_components/scene.markdown b/source/_components/scene.markdown index 90c816cb1c..4bf9f168f7 100644 --- a/source/_components/scene.markdown +++ b/source/_components/scene.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Scenes" -description: "Instructions how to setup scenes within Home Assistant." +description: "Instructions on how to setup scenes within Home Assistant." date: 2015-03-23 19:59 sidebar: true comments: false diff --git a/source/_components/scene.tahoma.markdown b/source/_components/scene.tahoma.markdown index 1cb708486c..b5cd1c4294 100644 --- a/source/_components/scene.tahoma.markdown +++ b/source/_components/scene.tahoma.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Tahoma Scene" -description: "Instructions how to integrate Tahoma scenes into Home Assistant." +description: "Instructions on how to integrate Tahoma scenes into Home Assistant." date: 2018-02-18 12:00 sidebar: true comments: false diff --git a/source/_components/scene.wink.markdown b/source/_components/scene.wink.markdown index 50ef56848f..cf8e79cf4c 100644 --- a/source/_components/scene.wink.markdown +++ b/source/_components/scene.wink.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Wink Scene" -description: "Instructions how to setup the Wink scenes(shortcuts) within Home Assistant." +description: "Instructions on how to setup the Wink scenes(shortcuts) within Home Assistant." date: 2017-04-01 16:45 sidebar: true comments: false diff --git a/source/_components/script.markdown b/source/_components/script.markdown index 52dd111053..856b758aab 100644 --- a/source/_components/script.markdown +++ b/source/_components/script.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Scripts" -description: "Instructions how to setup scripts within Home Assistant." +description: "Instructions on how to setup scripts within Home Assistant." date: 2015-03-23 19:59 sidebar: true comments: false @@ -26,7 +26,7 @@ script:          message: Current temperature is {% raw %}{{ states.sensor.temperature.state }}{% endraw %} ```

-Script names (e.g. `message_temperature` in the example above) are not allowed to contain dash (minus) characters, i.e. `-`. +Script names (e.g., `message_temperature` in the example above) are not allowed to contain dash (minus) characters, i.e. `-`. The preferred way to separate words for better readability is to use underscore (`_`) characters.

diff --git a/source/_components/scsgate.markdown b/source/_components/scsgate.markdown index c70238554c..30fa3c975f 100644 --- a/source/_components/scsgate.markdown +++ b/source/_components/scsgate.markdown @@ -1,7 +1,7 @@ --- layout: page title: "SCSGate" -description: "Instructions how to integrate SCSGate into Home Assistant." +description: "Instructions on how to integrate SCSGate into Home Assistant." date: 2016-01-31 19:20 sidebar: true comments: false @@ -25,7 +25,7 @@ scsgate: Configuration variables: -- **device** (*Required*): The path to your device, e.g. `/dev/ttyACM0` +- **device** (*Required*): The path to your device, e.g., `/dev/ttyACM0` ### {% linkable_title How to find the scs_id for your devices %} diff --git a/source/_components/sensor.abode.markdown b/source/_components/sensor.abode.markdown index b886d385ab..f2076b85f9 100644 --- a/source/_components/sensor.abode.markdown +++ b/source/_components/sensor.abode.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Abode Sensor" -description: "Instructions how to integrate Abode sensors into Home Assistant." +description: "Instructions on how to integrate Abode sensors into Home Assistant." date: 2017-10-05 14:00 sidebar: true comments: false diff --git a/source/_components/sensor.ads.markdown b/source/_components/sensor.ads.markdown index 0e65a67bb6..2360ac70c3 100644 --- a/source/_components/sensor.ads.markdown +++ b/source/_components/sensor.ads.markdown @@ -1,7 +1,7 @@ --- layout: page title: "ADS Sensor" -description: "Instructions how to integrate ADS numeric values into Home Assistant." +description: "Instructions on how to integrate ADS numeric values into Home Assistant." date: 2017-10-25 10:00 sidebar: true comments: false diff --git a/source/_components/sensor.alarmdecoder.markdown b/source/_components/sensor.alarmdecoder.markdown index d7b0483f9a..770e94f1b7 100644 --- a/source/_components/sensor.alarmdecoder.markdown +++ b/source/_components/sensor.alarmdecoder.markdown @@ -1,7 +1,7 @@ --- layout: page title: "AlarmDecoder Sensor" -description: "Instructions how to integrate AlarmDecoder sensors into Home Assistant." +description: "Instructions on how to integrate AlarmDecoder sensors into Home Assistant." date: 2017-04-02 13:28 sidebar: true comments: false diff --git a/source/_components/sensor.alpha_vantage.markdown b/source/_components/sensor.alpha_vantage.markdown index f984e74354..25714dd5cc 100644 --- a/source/_components/sensor.alpha_vantage.markdown +++ b/source/_components/sensor.alpha_vantage.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Alpha Vantage" -description: "Instructions how to setup Alpha Vantage within Home Assistant." +description: "Instructions on how to setup Alpha Vantage within Home Assistant." date: 2017-12-02 12:00 sidebar: true comments: false diff --git a/source/_components/sensor.amcrest.markdown b/source/_components/sensor.amcrest.markdown index 538369de5a..127021a1e2 100644 --- a/source/_components/sensor.amcrest.markdown +++ b/source/_components/sensor.amcrest.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Amcrest IP Camera" -description: "Instructions how to integrate Amcrest IP cameras sensors within Home Assistant." +description: "Instructions on how to integrate Amcrest IP cameras sensors within Home Assistant." date: 2017-01-13 10:00 sidebar: true comments: false diff --git a/source/_components/sensor.android_ip_webcam.markdown b/source/_components/sensor.android_ip_webcam.markdown index 87f6f0d783..35d4eefb7a 100644 --- a/source/_components/sensor.android_ip_webcam.markdown +++ b/source/_components/sensor.android_ip_webcam.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Android IP Webcam Sensor" -description: "Instructions how to integrate sensors for Android IP webcam within Home Assistant." +description: "Instructions on how to integrate sensors for Android IP webcam within Home Assistant." date: 2017-03-10 00:00 sidebar: true comments: false diff --git a/source/_components/sensor.api_stream.markdown b/source/_components/sensor.api_stream.markdown index 4b2c2a26ec..c363e88533 100644 --- a/source/_components/sensor.api_stream.markdown +++ b/source/_components/sensor.api_stream.markdown @@ -1,7 +1,7 @@ --- layout: page title: "API Stream Sensor" -description: "Instructions how to count clients using the API stream within Home Assistant." +description: "Instructions on how to count clients using the API stream within Home Assistant." date: 2016-11-19 10:00 sidebar: true comments: false diff --git a/source/_components/sensor.arduino.markdown b/source/_components/sensor.arduino.markdown index b7e4c1c6d7..f7f686370a 100644 --- a/source/_components/sensor.arduino.markdown +++ b/source/_components/sensor.arduino.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Arduino Sensor" -description: "Instructions how to integrate Arduino boards pins as sensors within Home Assistant." +description: "Instructions on how to integrate Arduino boards pins as sensors within Home Assistant." date: 2015-09-14 18:28 sidebar: true comments: false diff --git a/source/_components/sensor.arest.markdown b/source/_components/sensor.arest.markdown index bf5c31651c..4f7c68732f 100644 --- a/source/_components/sensor.arest.markdown +++ b/source/_components/sensor.arest.markdown @@ -1,7 +1,7 @@ --- layout: page title: "aREST Sensor" -description: "Instructions how to integrate aREST sensors within Home Assistant." +description: "Instructions on how to integrate aREST sensors within Home Assistant." date: 2015-09-07 18:15 sidebar: true comments: false @@ -33,7 +33,7 @@ sensor: Configuration variables: -- **resource** (*Required*): IP address and schema of the device that is exposing an aREST API, e.g. http://192.168.1.10. +- **resource** (*Required*): IP address and schema of the device that is exposing an aREST API, e.g., http://192.168.1.10. - **name** (*Optional*): Let you overwrite the name of the device. By default *name* from the device is used. - **monitored_variables** array (*Optional*): List of exposed variables. - **[variable]** (*Required*): Name of the variable to monitor. diff --git a/source/_components/sensor.arlo.markdown b/source/_components/sensor.arlo.markdown index 309795f795..e5184d2ed0 100644 --- a/source/_components/sensor.arlo.markdown +++ b/source/_components/sensor.arlo.markdown @@ -15,6 +15,10 @@ ha_iot_class: "Cloud Polling" 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 %} + Once you have enabled the [Arlo component](/components/arlo), add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/sensor.arwn.markdown b/source/_components/sensor.arwn.markdown index fb66cc50bd..8a9eea544a 100644 --- a/source/_components/sensor.arwn.markdown +++ b/source/_components/sensor.arwn.markdown @@ -1,7 +1,7 @@ --- layout: page title: "ARWN Sensor" -description: "Instructions how to integrate ARWN within Home Assistant." +description: "Instructions on how to integrate ARWN within Home Assistant." date: 2016-10-20 15:15 sidebar: true comments: false diff --git a/source/_components/sensor.bh1750.markdown b/source/_components/sensor.bh1750.markdown index 8b07a84482..4910cdfba0 100644 --- a/source/_components/sensor.bh1750.markdown +++ b/source/_components/sensor.bh1750.markdown @@ -1,7 +1,7 @@ --- layout: page title: "BH1750 Light sensor" -description: "Instructions how to integrate a BH1750 light sensor into Home Assistant." +description: "Instructions on how to integrate a BH1750 light sensor into Home Assistant." date: 2017-06-10 00:00 sidebar: true comments: false diff --git a/source/_components/sensor.bitcoin.markdown b/source/_components/sensor.bitcoin.markdown index 85173adc72..ba47bf8d9e 100644 --- a/source/_components/sensor.bitcoin.markdown +++ b/source/_components/sensor.bitcoin.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Bitcoin" -description: "Instructions how to integrate Bitcoin data within Home Assistant." +description: "Instructions on how to integrate Bitcoin data within Home Assistant." date: 2015-05-08 17:15 sidebar: true comments: false diff --git a/source/_components/sensor.blockchain.markdown b/source/_components/sensor.blockchain.markdown index 21da288337..8c441ff88b 100644 --- a/source/_components/sensor.blockchain.markdown +++ b/source/_components/sensor.blockchain.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Blockchain.info" -description: "Instructions how to integrate Blockchain.info data within Home Assistant." +description: "Instructions on how to integrate Blockchain.info data within Home Assistant." date: 2017-06-01 16:20 sidebar: true comments: false diff --git a/source/_components/sensor.bloomsky.markdown b/source/_components/sensor.bloomsky.markdown index a975a0300c..61b850de1e 100644 --- a/source/_components/sensor.bloomsky.markdown +++ b/source/_components/sensor.bloomsky.markdown @@ -1,7 +1,7 @@ --- layout: page title: "BloomSky Sensor" -description: "Instructions how to integrate the BloomSky sensors within Home Assistant." +description: "Instructions on how to integrate the BloomSky sensors within Home Assistant." date: 2016-02-03 20:00 sidebar: true comments: false diff --git a/source/_components/sensor.bme280.markdown b/source/_components/sensor.bme280.markdown index 8da831b067..7dd524405a 100644 --- a/source/_components/sensor.bme280.markdown +++ b/source/_components/sensor.bme280.markdown @@ -1,7 +1,7 @@ --- layout: page title: "BME280 Sensor" -description: "Instructions how to integrate a BME280 sensor into Home Assistant." +description: "Instructions on how to integrate a BME280 sensor into Home Assistant." date: 2017-06-10 00:00 sidebar: true comments: false diff --git a/source/_components/sensor.bme680.markdown b/source/_components/sensor.bme680.markdown index e6978a3f0f..05d42769c1 100644 --- a/source/_components/sensor.bme680.markdown +++ b/source/_components/sensor.bme680.markdown @@ -105,7 +105,7 @@ aq_humidity_baseline: default: 40 type: int aq_humidity_bias: - description: The bias for humidity to the gas resistance measurement in the air quality calculations expressed as a percentage of the total calculation e.g. 25% hudidtity to 75% gas. + description: The bias for humidity to the gas resistance measurement in the air quality calculations expressed as a percentage of the total calculation e.g., 25% hudidtity to 75% gas. required: false default: 25 type: int diff --git a/source/_components/sensor.bmw_connected_drive.markdown b/source/_components/sensor.bmw_connected_drive.markdown index 394fd2c31e..083e5124a6 100644 --- a/source/_components/sensor.bmw_connected_drive.markdown +++ b/source/_components/sensor.bmw_connected_drive.markdown @@ -1,7 +1,7 @@ --- layout: page -title: "BMW connected drive" -description: "Instructions on how to setup your BMW connected drive account with Home Assistant." +title: "BMW Connected Drive Sensor" +description: "Instructions on how to setup your BMW Connected Drive account with Home Assistant." date: 2018-01-10 23:00 sidebar: true comments: false diff --git a/source/_components/sensor.broadlink.markdown b/source/_components/sensor.broadlink.markdown index 70e82936ad..4688cf2aa0 100644 --- a/source/_components/sensor.broadlink.markdown +++ b/source/_components/sensor.broadlink.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Broadlink RM2 and A1 sensor" -description: "Instructions how to integrate Broadlink RM2 and/or A1 E-air sensors within Home Assistant." +description: "Instructions on how to integrate Broadlink RM2 and/or A1 E-air sensors within Home Assistant." date: 2016-12-03 21:59 sidebar: true comments: false @@ -78,7 +78,7 @@ sensor: The pycrypto library needs to be available on your platform. On a typical windows sysytem `pip install pycrypto` will fail, as a compiler needs to be installed first.

-The quickest way around this is to use a pre-built binary, e.g. from [https://github.com/sfbahr/PyCrypto-Wheels](https://github.com/sfbahr/PyCrypto-Wheels) +The quickest way around this is to use a pre-built binary, e.g., from [https://github.com/sfbahr/PyCrypto-Wheels](https://github.com/sfbahr/PyCrypto-Wheels) Be sure to get the correct 64 or 32-bit binary for your system, the full command line will look something like the sample below for a 64-bit system: diff --git a/source/_components/sensor.buienradar.markdown b/source/_components/sensor.buienradar.markdown index 2ddce39ce7..63e1f88b46 100644 --- a/source/_components/sensor.buienradar.markdown +++ b/source/_components/sensor.buienradar.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Buienradar Sensor" -description: "Instructions how to integrate buienradar.nl sensor within Home Assistant." +description: "Instructions on how to integrate buienradar.nl sensor within Home Assistant." date: 2017-05-15 14:00 sidebar: true comments: false diff --git a/source/_components/sensor.coinbase.markdown b/source/_components/sensor.coinbase.markdown index 89c06fc6f3..c506d82341 100644 --- a/source/_components/sensor.coinbase.markdown +++ b/source/_components/sensor.coinbase.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Coinbase Sensor" -description: "Instructions how to setup Coinbase sensors within Home Assistant." +description: "Instructions on how to setup Coinbase sensors within Home Assistant." date: 2017-12-08 18:00 sidebar: true comments: false diff --git a/source/_components/sensor.coinmarketcap.markdown b/source/_components/sensor.coinmarketcap.markdown index 63fde6b5ea..1fc1300ab5 100644 --- a/source/_components/sensor.coinmarketcap.markdown +++ b/source/_components/sensor.coinmarketcap.markdown @@ -1,7 +1,7 @@ --- layout: page title: "CoinMarketCap" -description: "Instructions how to integrate CoinMarketCap data within Home Assistant." +description: "Instructions on how to integrate CoinMarketCap data within Home Assistant." date: 2016-08-31 08:15 sidebar: true comments: false diff --git a/source/_components/sensor.comed_hourly_pricing.markdown b/source/_components/sensor.comed_hourly_pricing.markdown index d278c8a713..b371c8c197 100644 --- a/source/_components/sensor.comed_hourly_pricing.markdown +++ b/source/_components/sensor.comed_hourly_pricing.markdown @@ -1,7 +1,7 @@ --- layout: page title: "ComEd Hourly Pricing" -description: "Instructions how to set up the ComEd Hourly Pricing sensor in Home Assistant." +description: "Instructions on how to set up the ComEd Hourly Pricing sensor in Home Assistant." date: 2017-03-02 0:15 sidebar: true comments: false diff --git a/source/_components/sensor.comfoconnect.markdown b/source/_components/sensor.comfoconnect.markdown index 78d22454b9..0d9400f5ce 100644 --- a/source/_components/sensor.comfoconnect.markdown +++ b/source/_components/sensor.comfoconnect.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Zehnder ComfoAir Q Ventilation sensors" -description: "Instructions how to integrate Zehnder ComfoAir Q350/450/600 sensors into Home Assistant." +description: "Instructions on how to integrate Zehnder ComfoAir Q350/450/600 sensors into Home Assistant." date: 2017-06-28 18:00 sidebar: true comments: false diff --git a/source/_components/sensor.command_line.markdown b/source/_components/sensor.command_line.markdown index e27656e9a5..5cc0b4d9ea 100644 --- a/source/_components/sensor.command_line.markdown +++ b/source/_components/sensor.command_line.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Command line Sensor" -description: "Instructions how to integrate command line sensors into Home Assistant." +description: "Instructions on how to integrate command line sensors into Home Assistant." date: 2015-09-13 10:10 sidebar: true comments: false @@ -31,7 +31,7 @@ Configuration variables: - **name** (*Optional*): Name of the command sensor. - **unit_of_measurement** (*Optional*): Defines the unit of measurement of the sensor, if any. - **value_template** (*Optional*): Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract a value from the payload. -- **scan_interval** (*Optional*): Defines number of seconds for polling interval (defaults to 60 seconds). +- **scan_interval** (*Optional*): Defines number of seconds for polling interval (defaults to 60 seconds). ## {% linkable_title Examples %} @@ -61,6 +61,7 @@ sensor: Thanks to the [`proc`](https://en.wikipedia.org/wiki/Procfs) file system, various details about a system can be retrieved. Here the CPU temperature is of interest. Add something similar to your `configuration.yaml` file: +{% raw %} ```yaml # Example configuration.yaml entry sensor: @@ -69,8 +70,9 @@ sensor: command: "cat /sys/class/thermal/thermal_zone0/temp" # If errors occur, remove degree symbol below unit_of_measurement: "°C" - value_template: '{% raw %}{{ value | multiply(0.001) }}{% endraw %}' + value_template: '{{ value | multiply(0.001) | round(1) }}' ``` +{% endraw %} ### {% linkable_title Monitoring failed login attempts on Home Assistant %} @@ -84,7 +86,7 @@ sensor: command: "grep -c 'Login attempt' /home/hass/.homeassistant/home-assistant.log" ``` -Make sure to configure the [logger component](/components/logger) to monitor the [http component](https://home-assistant.io/components/http/) at least the `warning` level. +Make sure to configure the [logger component](/components/logger) to monitor the [http component](/components/http/) at least the `warning` level. ```yaml # Example working logger settings that works @@ -149,11 +151,13 @@ sensor: [Templates](/docs/configuration/templating/) are supported in the `command:` configuration variable. This could be used if you want to include the state of a specific sensor as an argument to your external script. +{% raw %} ```yaml # Example configuration.yaml entry sensor: - platform: command_line name: wind direction - command: 'sh /home/pi/.homeassistant/scripts/wind_direction.sh {% raw %}{{ states.sensor.wind_direction.state }}{% endraw %}' + command: 'sh /home/pi/.homeassistant/scripts/wind_direction.sh {{ states.sensor.wind_direction.state }}' unit_of_measurement: "Direction" ``` +{% endraw %} diff --git a/source/_components/sensor.cpuspeed.markdown b/source/_components/sensor.cpuspeed.markdown index c997ae5a2f..f69f014967 100644 --- a/source/_components/sensor.cpuspeed.markdown +++ b/source/_components/sensor.cpuspeed.markdown @@ -1,7 +1,7 @@ --- layout: page title: "CPU speed" -description: "Instructions how to integrate CPU speed within Home Assistant." +description: "Instructions on how to integrate CPU speed within Home Assistant." date: 2015-10-15 11:00 sidebar: true comments: false diff --git a/source/_components/sensor.cups.markdown b/source/_components/sensor.cups.markdown index eb9f43e9dd..2e32f5aa0f 100644 --- a/source/_components/sensor.cups.markdown +++ b/source/_components/sensor.cups.markdown @@ -1,7 +1,7 @@ --- layout: page title: "CUPS Sensor" -description: "Instructions how to integrate CUPS sensors into Home Assistant." +description: "Instructions on how to integrate CUPS sensors into Home Assistant." date: 2016-10-30 12:10 sidebar: true comments: false diff --git a/source/_components/sensor.darksky.markdown b/source/_components/sensor.darksky.markdown index aebe2326e4..6b110a6c72 100644 --- a/source/_components/sensor.darksky.markdown +++ b/source/_components/sensor.darksky.markdown @@ -41,6 +41,46 @@ Configuration variables: - **api_key** (*Required*): Your API key. - **name** (*Optional*): Additional name for the sensors. Default to platform name. - **forecast** array (*Optional*): List of days in the 7 day forecast you would like to receive data on, starting with tomorrow as day 1. Any `monitored_condition` with a daily forecast by DarkSky will generate a sensor tagged with `_`. +- **language** (*Optional*): The desired language of the summary properties. Valid options are + - `ar`: Arabic + - `az`: Azerbaijani + - `be`: Belarusian + - `bg`: Bulgarian + - `bs`: Bosnian + - `ca`: Catalan + - `cs`: Czech + - `da`: Danish + - `de`: German + - `el`: Greek + - `en`: English (which is the default) + - `es`: Spanish + - `et`: Estonian + - `fi`: Finnish + - `fr`: French + - `hr`: Croatian + - `hu`: Hungarian + - `id`: Indonesian + - `is`: Icelandic + - `it`: Italian + - `ja`: Japanese + - `ka`: Georgian + - `kw`: Cornish + - `nb`: Norwegian Bokmål + - `nl`: Dutch + - `pl`: Polish + - `pt`: Portuguese + - `ro`: Romanian + - `ru`: Russian + - `sk`: Slovak + - `sl`: Slovenian + - `sr`: Serbian + - `sv`: Swedish + - `tet`: Tetum + - `tr`: Turkish + - `uk`: Ukrainian + - `x-pig-latin`: Igpay Atinlay + - `zh`: simplified Chinese + - `zh-tw`: traditional Chinese - **latitude** (*Optional*): Latitude coordinate to monitor weather of (required if **longitude** is specified), defaults to coordinates defined in your `configuration.yaml` - **longitude** (*Optional*): Longitude coordinate to monitor weather of (required if **latitude** is specified), defaults to coordinates defined in your `configuration.yaml` - **monitored_conditions** array (*Required*): Conditions to display in the frontend. diff --git a/source/_components/sensor.deconz.markdown b/source/_components/sensor.deconz.markdown index 6844c88d83..46dad20c0e 100644 --- a/source/_components/sensor.deconz.markdown +++ b/source/_components/sensor.deconz.markdown @@ -43,3 +43,28 @@ Entity ids will be sensor.device_name, where device_name is defined in deCONZ. S - Xiaomi Smart Home Wireless Switch - Temperature Sensor - Xiaomi Temperature/Humidity Sensor + +#### {% linkable_title deCONZ Daylight Sensor %} + +The deCONZ Daylight sensor is a special sensor built into the deCONZ software since version 2.05.12. It is represented in Home Assistant as a sensor called sensor.daylight. The sensor's state value is a string corresponding to the phase of daylight (descriptions below taken from https://github.com/mourner/suncalc, on which the deCONZ implementation is based): + +| Sensor State | Description | +|--------------|-------------| +| sunrise_start | sunrise (top edge of the sun appears on the horizon) | +| sunrise_end | sunrise ends (bottom edge of the sun touches the horizon) | +| golden_hour_1 | morning golden hour (soft light, the best time for photography) | +| solar_noon | solar noon (sun is in the highest position) | +| golden_hour_2 | evening golden hour | +| sunset_start | sunset starts (bottom edge of the sun touches the horizon) | +| sunset_end | sunset (sun disappears below the horizon, evening civil twilight starts) | +| dusk | dusk (evening nautical twilight starts) | +| nautical_dusk | nautical dusk (evening astronomical twilight starts) | +| night_start | night starts (dark enough for astronomical observations) | +| nadir | nadir (darkest moment of the night, the sun is in the lowest position) | +| night_end | night ends (morning astronomical twilight starts) | +| nautical_dawn | nautical dawn (morning nautical twilight starts) | +| dawn | dawn (morning nautical twilight ends, morning civil twilight starts) | + +The sensor also has an attribute called "daylight" that has the value `true` when the sensor's state is `golden_hour_1`, `solar_noon`, or `golden_hour_2`, and `false` otherwise. + +These states can be used in automations as a trigger (e.g., trigger when a certain phase of daylight starts or ends) or condition (e.g., trigger only if in a certain phase of daylight). diff --git a/source/_components/sensor.deluge.markdown b/source/_components/sensor.deluge.markdown index 2f495a8d04..d80cedf2f8 100644 --- a/source/_components/sensor.deluge.markdown +++ b/source/_components/sensor.deluge.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Deluge Sensor" -description: "Instructions how to integrate Deluge sensors within Home Assistant." +description: "Instructions on how to integrate Deluge sensors within Home Assistant." date: 2017-10-24 17:06 sidebar: true comments: false diff --git a/source/_components/sensor.deutsche_bahn.markdown b/source/_components/sensor.deutsche_bahn.markdown index a2003e4c7d..6586e49452 100644 --- a/source/_components/sensor.deutsche_bahn.markdown +++ b/source/_components/sensor.deutsche_bahn.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Deutsche Bahn" -description: "Instructions how to integrate timetable data for traveling in Germany within Home Assistant." +description: "Instructions on how to integrate timetable data for traveling in Germany within Home Assistant." date: 2015-06-02 21:45 sidebar: true comments: false diff --git a/source/_components/sensor.dht.markdown b/source/_components/sensor.dht.markdown index fd187c6794..1898ab35d4 100644 --- a/source/_components/sensor.dht.markdown +++ b/source/_components/sensor.dht.markdown @@ -1,7 +1,7 @@ --- layout: page title: "DHT Sensor" -description: "Instructions how to integrate DHTxx sensors within Home Assistant." +description: "Instructions on how to integrate DHTxx sensors within Home Assistant." date: 2015-08-30 19:15 sidebar: true comments: false diff --git a/source/_components/sensor.domain_expiry.markdown b/source/_components/sensor.domain_expiry.markdown new file mode 100644 index 0000000000..a70306909a --- /dev/null +++ b/source/_components/sensor.domain_expiry.markdown @@ -0,0 +1,37 @@ +--- +layout: page +title: "Domain Expiry" +description: "Instructions on how to set up Domain expiry sensors within Home Assistant." +date: 2018-04-24 14:14 +sidebar: true +comments: false +sharing: true +footer: true +logo: home-assistant.png +ha_category: System Monitor +ha_release: 0.69 +ha_iot_class: "depends" +--- + +The `domain_expiry` sensor gets whois information about domain and displays the expiry in days. + +To add the Domain Expiry sensor to your installation, add these options to `configuration.yaml` file: + +```yaml +# Example configuration.yaml entry +sensor: + - platform: domain_expiry + domain: home-assistant.io +``` + +{% configuration %} +domain: + description: Domain name to track + required: true + type: string +name: + description: The friendly name for the certificate. + required: false + type: string + default: Domain Expiry +{% endconfiguration %} \ No newline at end of file diff --git a/source/_components/sensor.dovado.markdown b/source/_components/sensor.dovado.markdown index f300a90fcb..bbbd0bae3c 100644 --- a/source/_components/sensor.dovado.markdown +++ b/source/_components/sensor.dovado.markdown @@ -33,8 +33,8 @@ Configuration variables: - **username** (*Required*): Your username. - **password** (*Required*): Your password. -- **host** (*Optional*): The IP address of your router, e.g. `192.168.1.1`. If no host is provided, the gateway for the same network as Home Assistant will automatically be used. -- **port** (*Optional*): The port number of your router, e.g. `999`. If no port is provided, the default API port (6435) will be used. +- **host** (*Optional*): The IP address of your router, e.g., `192.168.1.1`. If no host is provided, the gateway for the same network as Home Assistant will automatically be used. +- **port** (*Optional*): The port number of your router, e.g., `999`. If no port is provided, the default API port (6435) will be used. - **sensors** array (*Required*): Conditions to display in the frontend. - **network**: Network state (3G, 4G, etc). - **signal**: The signal strength (%). diff --git a/source/_components/sensor.dsmr.markdown b/source/_components/sensor.dsmr.markdown index b073aae82f..9980021de1 100644 --- a/source/_components/sensor.dsmr.markdown +++ b/source/_components/sensor.dsmr.markdown @@ -1,7 +1,7 @@ --- layout: page title: "DSMR or Slimme meter" -description: "Instructions how to integrate DSMR Smartmeter within Home Assistant." +description: "Instructions on how to integrate DSMR Smartmeter within Home Assistant." date: 2016-11-12 12:00 sidebar: true comments: false diff --git a/source/_components/sensor.dte_energy_bridge.markdown b/source/_components/sensor.dte_energy_bridge.markdown index c79c4b73a0..80028de606 100644 --- a/source/_components/sensor.dte_energy_bridge.markdown +++ b/source/_components/sensor.dte_energy_bridge.markdown @@ -1,7 +1,7 @@ --- layout: page title: "DTE Energy Bridge" -description: "Instructions how to setup DTE Energy Bridge with Home Assistant." +description: "Instructions on how to setup DTE Energy Bridge with Home Assistant." date: 2016-06-07 08:10 sidebar: true comments: false diff --git a/source/_components/sensor.dublin_bus_transport.markdown b/source/_components/sensor.dublin_bus_transport.markdown index 4a25dc5990..6c32206895 100644 --- a/source/_components/sensor.dublin_bus_transport.markdown +++ b/source/_components/sensor.dublin_bus_transport.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Dublin Bus Transport" -description: "Instructions how to integrate timetable data for traveling on Dublin Bus within Home Assistant." +description: "Instructions on how to integrate timetable data for traveling on Dublin Bus within Home Assistant." date: 2017-01-09 21:45 sidebar: true comments: false @@ -32,7 +32,7 @@ sensor: Configuration variables: - **stopid** (*Required*): The ID of the bus stop to get the information for. -- **route** (*Optional*): Only show a single bus route at the stop. This is the same as the bus number, e.g. `83`. +- **route** (*Optional*): Only show a single bus route at the stop. This is the same as the bus number, e.g., `83`. - **name** (*Optional*): A friendly name for this sensor. The public RTPI information is coming from [Dub Linked](https://data.dublinked.ie/). diff --git a/source/_components/sensor.dweet.markdown b/source/_components/sensor.dweet.markdown index bc3c710f53..1bc81d27e6 100644 --- a/source/_components/sensor.dweet.markdown +++ b/source/_components/sensor.dweet.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Dweet.io" -description: "Instructions how to integrate Dweet.io sensors within Home Assistant." +description: "Instructions on how to integrate Dweet.io sensors within Home Assistant." date: 2015-12-10 10:15 sidebar: true comments: false diff --git a/source/_components/sensor.dyson.markdown b/source/_components/sensor.dyson.markdown index 39ac3c5510..022d778ceb 100644 --- a/source/_components/sensor.dyson.markdown +++ b/source/_components/sensor.dyson.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Dyson Purifier Sensor" -description: "Instructions how to setup the Dyson Purifier fans within Home Assistant." +description: "Instructions on how to setup the Dyson Purifier fans within Home Assistant." date: 2017-05-27 10:00 sidebar: true comments: false diff --git a/source/_components/sensor.ebox.markdown b/source/_components/sensor.ebox.markdown index a76f9feacc..d2ad1a9cb5 100644 --- a/source/_components/sensor.ebox.markdown +++ b/source/_components/sensor.ebox.markdown @@ -1,7 +1,7 @@ --- layout: page title: "EBox" -description: "Instructions how to integrate EBox data usage within Home Assistant." +description: "Instructions on how to integrate EBox data usage within Home Assistant." date: 2017-02-15 17:17 sidebar: true comments: false diff --git a/source/_components/sensor.ecobee.markdown b/source/_components/sensor.ecobee.markdown index 0ae2be049b..19491a566e 100644 --- a/source/_components/sensor.ecobee.markdown +++ b/source/_components/sensor.ecobee.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Ecobee Sensor" -description: "Instructions how to setup the Ecobee sensors within Home Assistant." +description: "Instructions on how to setup the Ecobee sensors within Home Assistant." date: 2015-11-30 18:00 sidebar: true comments: false diff --git a/source/_components/sensor.efergy.markdown b/source/_components/sensor.efergy.markdown index b1bde92188..3fed31f58d 100644 --- a/source/_components/sensor.efergy.markdown +++ b/source/_components/sensor.efergy.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Efergy" -description: "Instructions how to integrate Efergy devices within Home Assistant." +description: "Instructions on how to integrate Efergy devices within Home Assistant." date: 2015-07-11 0:15 sidebar: true comments: false diff --git a/source/_components/sensor.eight_sleep.markdown b/source/_components/sensor.eight_sleep.markdown index 635587b25a..2d78d94f70 100644 --- a/source/_components/sensor.eight_sleep.markdown +++ b/source/_components/sensor.eight_sleep.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Eight Sleep Sensor" -description: "Instructions how to integrate sensors for Eight Sleep within Home Assistant." +description: "Instructions on how to integrate sensors for Eight Sleep within Home Assistant." date: 2017-04-24 00:00 sidebar: true comments: false diff --git a/source/_components/sensor.eliqonline.markdown b/source/_components/sensor.eliqonline.markdown index 87dd5ac8fd..b87f019f0e 100644 --- a/source/_components/sensor.eliqonline.markdown +++ b/source/_components/sensor.eliqonline.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Eliqonline" -description: "Instructions how to integrate Eliqonline devices within Home Assistant." +description: "Instructions on how to integrate Eliqonline devices within Home Assistant." date: 2015-07-11 0:15 sidebar: true comments: false diff --git a/source/_components/sensor.emoncms.markdown b/source/_components/sensor.emoncms.markdown index 3fb5f1aeab..a15c508199 100644 --- a/source/_components/sensor.emoncms.markdown +++ b/source/_components/sensor.emoncms.markdown @@ -42,8 +42,8 @@ sensor: ## {% linkable_title Default naming scheme %} The names of the sensors created by this component will use the feed names defined in EmonCMS if available, -or the feed ID otherwise, and will be prefixed with "EmonCMS", e.g. "EmonCMS Total Power" or "EmonCMS Feed 5". -If the `id` property is anything but `1`, the ID will be shown as well, e.g. "EmonCMS 2 Feed 5". +or the feed ID otherwise, and will be prefixed with "EmonCMS", e.g., "EmonCMS Total Power" or "EmonCMS Feed 5". +If the `id` property is anything but `1`, the ID will be shown as well, e.g., "EmonCMS 2 Feed 5". If `sensor_names` is used, any feeds with defined names will get those names exactly, with no prefix. diff --git a/source/_components/sensor.enocean.markdown b/source/_components/sensor.enocean.markdown index 6b627361f1..669c07825a 100644 --- a/source/_components/sensor.enocean.markdown +++ b/source/_components/sensor.enocean.markdown @@ -1,7 +1,7 @@ --- layout: page title: "EnOcean Sensor" -description: "Instructions how to integrate TellStick sensors into Home Assistant." +description: "Instructions on how to integrate TellStick sensors into Home Assistant." date: 2016-05-26 01:00 sidebar: true comments: false diff --git a/source/_components/sensor.envirophat.markdown b/source/_components/sensor.envirophat.markdown index 84d87d55c1..9863a4ab3b 100644 --- a/source/_components/sensor.envirophat.markdown +++ b/source/_components/sensor.envirophat.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Enviro pHAT" -description: "Instructions how to integrate the Enviro pHAT within Home Assistant." +description: "Instructions on how to integrate the Enviro pHAT within Home Assistant." date: 2017-05-03 17:00 sidebar: true comments: false diff --git a/source/_components/sensor.envisalink.markdown b/source/_components/sensor.envisalink.markdown index 24f6474f14..94235f48b8 100644 --- a/source/_components/sensor.envisalink.markdown +++ b/source/_components/sensor.envisalink.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Envisalink Sensor" -description: "Instructions how to integrate Envisalink sensors into Home Assistant." +description: "Instructions on how to integrate Envisalink sensors into Home Assistant." date: 2016-07-01 10:00 sidebar: true comments: false diff --git a/source/_components/sensor.etherscan.markdown b/source/_components/sensor.etherscan.markdown index a94f0689a2..785ed42492 100644 --- a/source/_components/sensor.etherscan.markdown +++ b/source/_components/sensor.etherscan.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Etherscan" -description: "Instructions how to integrate Etherscan.io data within Home Assistant." +description: "Instructions on how to integrate Etherscan.io data within Home Assistant." date: 2017-06-01 16:20 sidebar: true comments: false diff --git a/source/_components/sensor.fail2ban.markdown b/source/_components/sensor.fail2ban.markdown index 5fb8c141f4..ca1467cf1b 100644 --- a/source/_components/sensor.fail2ban.markdown +++ b/source/_components/sensor.fail2ban.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Fail2Ban Sensor" -description: "Instructions how to integrate a fail2ban sensor into Home Assistant." +description: "Instructions on how to integrate a fail2ban sensor into Home Assistant." date: 2017-10-19 10:30 sidebar: true comments: false @@ -14,7 +14,7 @@ ha_release: 0.57 --- -The `fail2ban` sensor allows for IPs banned by [fail2ban](https://www.fail2ban.org/wiki/index.php/Main_Page) to be displayed in the Home Assistant frontend. +The `fail2ban` sensor allows for IPs banned by [fail2ban](https://www.fail2ban.org/wiki/index.php/Main_Page) to be displayed in the Home Assistant frontend.

Your system must have `fail2ban` installed and correctly configured for this sensor to work. In addition, Home Assistant must be able to read the `fail2ban` log file. @@ -72,7 +72,7 @@ logger: #### {% linkable_title Edit the `jail.local` file %} -Next, we need to edit the `jail.local` file that is included with the Let's Encrypt docker linked above. Note, for this tutorial, we'll only be implementing the `[hass-iptables]` jail from the [previously linked tutorial](https://home-assistant.io/cookbook/fail2ban/). +Next, we need to edit the `jail.local` file that is included with the Let's Encrypt docker linked above. Note, for this tutorial, we'll only be implementing the `[hass-iptables]` jail from the [previously linked tutorial](/cookbook/fail2ban/). Edit `/mnt/user/appdata/letsencrypt/fail2ban/jail.local` and append the following to the end of the file: @@ -123,7 +123,7 @@ Now do the same for the Home Assistant docker, but this time we'll be mapping th By default, the IP address that Home Assistant sees will be that of the container (something like `172.17.0.16`). What this means is that for any failed login attempt, assuming you have correctly configured `fail2ban`, the Docker IP will be logged as banned, but the originating IP is still allowed to make attempts. We need `fail2ban` to recognize the originating IP to properly ban it. -First, we have to add the following to the nginx configuration file located in `/mnt/user/appdata/letsencrypt/nginx/site-confs/default`. +First, we have to add the following to the nginx configuration file located in `/mnt/user/appdata/letsencrypt/nginx/site-confs/default`. ```bash proxy_set_header X-Real-IP $remote_addr; @@ -136,7 +136,7 @@ This snippet should be added within your Home Assistant server config, so you ha server { ... location / { - proxy_pass http://192.168.0.100:8123; + proxy_pass http://192.168.0.100:8123; proxy_set_header Host $host; proxy_http_version 1.1; proxy_set_header Upgrade $http_upgrade; @@ -153,7 +153,7 @@ server { proxy_set_header Connection "upgrade"; proxy_set_header X-Real-IP $remote_addr; proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; - } + } ... } ``` diff --git a/source/_components/sensor.fido.markdown b/source/_components/sensor.fido.markdown index 165f52bbf0..edb59195a3 100644 --- a/source/_components/sensor.fido.markdown +++ b/source/_components/sensor.fido.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Fido" -description: "Instructions how to integrate Fido data usage within Home Assistant." +description: "Instructions on how to integrate Fido data usage within Home Assistant." date: 2017-01-01 17:17 sidebar: true comments: false diff --git a/source/_components/sensor.file.markdown b/source/_components/sensor.file.markdown index 741d297c41..8ae7216a7d 100644 --- a/source/_components/sensor.file.markdown +++ b/source/_components/sensor.file.markdown @@ -1,7 +1,7 @@ --- layout: page title: "File Sensor" -description: "Instructions how to integrate sensors which read from files into Home Assistant." +description: "Instructions on how to integrate sensors which read from files into Home Assistant." date: 2017-05-13 12:10 sidebar: true comments: false @@ -14,7 +14,7 @@ ha_release: 0.45 --- -The `file` sensor platform reads the entries from a plain-text file and shows the found value. Only the last line of the file is used. This is similar to do `$ tail -n 1 sensor.txt` on the command-line. +The `file` sensor platform reads the entries from a plain-text file and shows the found value. Only the last line of the file is used. This is similar to do `$ tail -n 1 sensor.txt` on the command-line. Note that file paths must be added to [whitelist_external_dirs](/docs/configuration/basic/). To enable the `file` sensor, add the following lines to your `configuration.yaml`: diff --git a/source/_components/sensor.filesize.markdown b/source/_components/sensor.filesize.markdown index 8c46e8c1b2..3178fa6e3c 100644 --- a/source/_components/sensor.filesize.markdown +++ b/source/_components/sensor.filesize.markdown @@ -13,7 +13,7 @@ ha_iot_class: "Local Polling" ha_release: 0.64 --- -Component for displaying the size in MB of a file. Note that paths must be added to [whitelist_external_dirs](https://home-assistant.io/docs/configuration/basic/). +Component for displaying the size in MB of a file. Note that paths must be added to [whitelist_external_dirs](/docs/configuration/basic/). Add to your config: ```yaml diff --git a/source/_components/sensor.filter.markdown b/source/_components/sensor.filter.markdown index 07f5b33e3a..30661e8d1f 100644 --- a/source/_components/sensor.filter.markdown +++ b/source/_components/sensor.filter.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Filter Sensor" -description: "Instructions how to integrate Data Filter Sensors into Home Assistant." +description: "Instructions on how to integrate Data Filter Sensors into Home Assistant." date: 2018-02-20 sidebar: true comments: false @@ -15,7 +15,7 @@ logo: home-assistant.png The `filter` platform enables sensors that process the states of other entities. -`filter` applies a signal processing algorithm to a sensor, previous and current states, and generates a `new state` given the chosen algorithm. +`filter` applies a signal processing algorithm to a sensor, previous and current states, and generates a `new state` given the chosen algorithm. The next image depicts an original sensor and the filter sensor of that same sensor using the [History Graph]({{site_roor}}/components/history_graph/) component.

@@ -37,6 +37,18 @@ sensor: - filter: lowpass time_constant: 10 precision: 2 + - platform: filter + name: "filtered realistic temperature" + entity_id: sensor.realistic_temperature + filters: + - filter: outlier + window_size: 4 + radius: 2.0 + - filter: lowpass + time_constant: 10 + - filter: time_simple_moving_average + window_size: 00:05 + precision: 2 ``` Filters can be chained and are applied according to the order present in the configuration file. @@ -53,17 +65,17 @@ name: filters: description: Filters to be used. required: true - type: map + type: list keys: filter: - description: Algorithm to be used to filter data. Available filters are `lowpass`, `outlier` and `throttle`. + description: Algorithm to be used to filter data. Available filters are `lowpass`, `outlier`, `throttle` and `time_simple_moving_average`. required: true type: string window_size: - description: Size of the window of previous states. + description: Size of the window of previous states. Time based filters such as `time_simple_moving_average` will require a time period (size in time), while other filters such as `outlier` will require an integer (size in number of states) required: false - type: int - default: 5 + type: [int, time] + default: 1 precision: description: See [_lowpass_](#low-pass) filter. Defines the precision of the filtered state, through the argument of round(). required: false @@ -78,16 +90,21 @@ filters: description: See [_outlier_](#outlier) filter. Band radius from median of previous states. required: false type: float - default: 2.0 + default: 2.0 + type: + description: See [_time_simple_moving_average_](#time-simple-moving-average) filter. Defines the type of Simple Moving Average. + required: false + type: string + default: last {% endconfiguration %} ## {% linkable_title Filters %} ### {% linkable_title Low-pass %} -The Low-pass filter (`lowpass`) is one of signal processing most common filters, as it smooths data by shortcuting peaks and valleys. +The Low-pass filter (`lowpass`) is one of signal processing most common filters, as it smooths data by shortcutting peaks and valleys. -The included Low-pass filter is very basic and is based on a moving average, in which the previous data point is weighted with the new data point. +The included Low-pass filter is very basic and is based on [exponential smoothing](https://en.wikipedia.org/wiki/Exponential_smoothing), in which the previous data point is weighted with the new data point. ```python B = 1.0 / time_constant @@ -99,7 +116,7 @@ The returned value is rounded to the number of decimals defined in (`precision`) ### {% linkable_title Outlier %} -The Outlier filter (`outlier`) is a basic Band-stop filter, as it cuts out any value outside a specific range. +The Outlier filter (`outlier`) is a basic Band-pass filter, as it cuts out any value outside a specific range. The included Outlier filter will discard any value beyond a band centered on the median of the previous values, replacing it with the median value of the previous values. If inside the band, the @@ -120,3 +137,10 @@ To adjust the rate you need to set the window_size. To throttle a sensor down to This filter is relevant when you have a sensor which produces states at a very high-rate, which you might want to throttle down for storing or visualization purposes. +### {% linkable_title Time Simple Moving Average %} + +The Time SMA filter (`time_simple_moving_average`) is based on the paper [Algorithms for Unevenly Spaced Time Series: Moving Averages and Other Rolling Operators](http://www.eckner.com/papers/Algorithms%20for%20Unevenly%20Spaced%20Time%20Series.pdf) by Andreas Eckner. + +The paper defines three types/versions of the Simple Moving Average (SMA): *last*, *next* and *linear*. Currently only *last* is implemented. + +Theta, as described in the paper, is the `window_size` parameter, and can be expressed using time notation (e.g., 00:05 for a five minutes time window). diff --git a/source/_components/sensor.fitbit.markdown b/source/_components/sensor.fitbit.markdown index 4ea3e71cd4..a273f3d8af 100644 --- a/source/_components/sensor.fitbit.markdown +++ b/source/_components/sensor.fitbit.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Fitbit" -description: "Instructions how to integrate Fitbit devices within Home Assistant." +description: "Instructions on how to integrate Fitbit devices within Home Assistant." date: 2016-05-09 15:01 sidebar: true comments: false diff --git a/source/_components/sensor.fixer.markdown b/source/_components/sensor.fixer.markdown index 220619cf30..397d3b5b71 100644 --- a/source/_components/sensor.fixer.markdown +++ b/source/_components/sensor.fixer.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Fixer.io" -description: "Instructions how to integrate exchange rates from Fixer.io within Home Assistant." +description: "Instructions on how to integrate exchange rates from Fixer.io within Home Assistant." date: 2016-06-20 10:00 sidebar: true comments: false diff --git a/source/_components/sensor.folder.markdown b/source/_components/sensor.folder.markdown index 2555b7a0ad..292e7366ea 100644 --- a/source/_components/sensor.folder.markdown +++ b/source/_components/sensor.folder.markdown @@ -13,7 +13,7 @@ ha_iot_class: "Local Polling" ha_release: 0.64 --- -Sensor for monitoring the contents of a folder. Note that folder paths must be added to [whitelist_external_dirs](https://home-assistant.io/docs/configuration/basic/). Optionally a [wildcard filter](https://docs.python.org/3.6/library/fnmatch.html) can be applied to the files considered within the folder. The state of the sensor is the size in MB of files within the folder that meet the filter criteria. The number of filtered files in the folder and total size in bytes of those files are exposed as attributes. +Sensor for monitoring the contents of a folder. Note that folder paths must be added to [whitelist_external_dirs](/docs/configuration/basic/). Optionally a [wildcard filter](https://docs.python.org/3.6/library/fnmatch.html) can be applied to the files considered within the folder. The state of the sensor is the size in MB of files within the folder that meet the filter criteria. The number of filtered files in the folder and total size in bytes of those files are exposed as attributes. To enable the `folder` sensor in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/sensor.foobot.markdown b/source/_components/sensor.foobot.markdown new file mode 100644 index 0000000000..cf300fa7ac --- /dev/null +++ b/source/_components/sensor.foobot.markdown @@ -0,0 +1,51 @@ +--- +layout: page +title: "Foobot Air Quality Monitor" +description: "Instructions on how to setup Foobot Air Quality sensor in Home Assistant." +date: 2018-02-14 06:00 +sidebar: true +comments: false +sharing: true +footer: true +logo: foobot.png +ha_category: Health +ha_release: 0.66 +ha_iot_class: "Cloud Polling" +--- + +The `foobot` sensor platform will fetch air quality data from your or yours [Foobot device(s)](https://foobot.io/features/). + +This sensor requires an API token. Please obtain one at [Foobot API site](https://api.foobot.io/apidoc/index.html). + +## {% linkable_title Configuring the Platform %} + +To enable this sensor, add the following lines to your `configuration.yaml` file: + +```yaml +sensor: + - platform: foobot + token: FOOBOT_SECRET_KEY + username: FOOBOT_USERNAME +``` + +{% configuration %} + token: + description: The token for the Foobot API. + required: true + type: string + username: + description: Your Foobot username, used to fetch devices associated with an account. + required: true + type: string +{% endconfiguration %} + +## {% linkable_title Available Metrics %} + +Every ten minutes, it'll fetch the last ten minutes average of the following measurements: + + * Temperature + * Humidity + * Co2 + * VOC + * PM2.5 + * [Index](https://help.foobot.io/hc/en-us/articles/204814371-What-does-central-number-mean-) diff --git a/source/_components/sensor.fritzbox_callmonitor.markdown b/source/_components/sensor.fritzbox_callmonitor.markdown index 157e338e43..dd57677a9c 100644 --- a/source/_components/sensor.fritzbox_callmonitor.markdown +++ b/source/_components/sensor.fritzbox_callmonitor.markdown @@ -1,7 +1,7 @@ --- layout: page title: "FRITZ!Box Call Monitor" -description: "Instructions how to integrate a phone call monitor for AVM FRITZ!Box routers into Home Assistant." +description: "Instructions on how to integrate a phone call monitor for AVM FRITZ!Box routers into Home Assistant." date: 2016-08-13 15:00 sidebar: true comments: false @@ -14,10 +14,11 @@ ha_iot_class: "Local Polling" --- -The `fritzbox_callmonitor` sensor monitors the call monitor exposed by [AVM Fritz!Box](http://avm.de/produkte/fritzbox/) routers -on TCP port 1012. It will assume the values `idle`, `ringing`, `dialing`, or `talking` with the phone numbers involved contained in the state attributes. +The `fritzbox_callmonitor` sensor monitors the call monitor exposed by [AVM Fritz!Box](http://avm.de/produkte/fritzbox/) routers on TCP port 1012. It will assume the values `idle`, `ringing`, `dialing` or `talking` with the phone numbers involved contained in the state attributes. It can also access the internal phone book of the router to look up the names corresponding to the phone numbers and store them in the state attributes. +## {% linkable_title Configuration %} + To activate the call monitor on your Fritz!Box, dial #96\*5\* from any phone connected to it. To use the Fritz!Box call monitor in your installation, add the following to your `configuration.yaml` file: @@ -44,7 +45,7 @@ Configuration variables: The example below shows a full configuration for a call monitor with phone book support. ```yaml -# Example configuration.yml entry +# Example configuration.yaml entry sensor: - platform: fritzbox_callmonitor name: Phone @@ -61,8 +62,9 @@ sensor: This example shows how to send notifications whenever the sensor's state changes. You will get notified both when you receive a call and also when a call is placed. +{% raw %} ```yaml -# Example configuration.yml entry. +# Example configuration.yaml entry. automation: - alias: "Notify about phone state" trigger: @@ -73,7 +75,7 @@ automation: data: title: "Phone" message: >- - {% raw %}{% if is_state("sensor.phone", "idle") %} + {% if is_state("sensor.phone", "idle") %} Phone is idle {% elif is_state("sensor.phone", "dialing") %} Calling {{ states.sensor.phone.attributes.to_name }} ({{ states.sensor.phone.attributes.to }}) @@ -81,5 +83,6 @@ automation: Incoming call from {{ states.sensor.phone.attributes.from_name }} ({{ states.sensor.phone.attributes.from }}) {% else %} Talking to {{ states.sensor.phone.attributes.with_name }} ({{ states.sensor.phone.attributes.with }}) - {% endif %}{% endraw %} + {% endif %} ``` +{% endraw %} diff --git a/source/_components/sensor.fritzbox_netmonitor.markdown b/source/_components/sensor.fritzbox_netmonitor.markdown index 9842499a1a..58eea96a16 100644 --- a/source/_components/sensor.fritzbox_netmonitor.markdown +++ b/source/_components/sensor.fritzbox_netmonitor.markdown @@ -1,7 +1,7 @@ --- layout: page title: "FRITZ!Box Net Monitor" -description: "Instructions how to integrate an AVM FRITZ!Box monitor into Home Assistant." +description: "Instructions on how to integrate an AVM FRITZ!Box monitor into Home Assistant." date: 2017-01-17 22:00 sidebar: true comments: false diff --git a/source/_components/sensor.geizhals.markdown b/source/_components/sensor.geizhals.markdown index 13f02fc7a1..c978074056 100644 --- a/source/_components/sensor.geizhals.markdown +++ b/source/_components/sensor.geizhals.markdown @@ -14,7 +14,7 @@ ha_release: "0.51" --- -The `geizhals` sensor will give you the best price of a product from [Geizhals](https://geizhals.de) or related site. With this information can be used in e.g. automations to notify you when a price drops. +The `geizhals` sensor will give you the best price of a product from [Geizhals](https://geizhals.de) or related site. With this information can be used in e.g., automations to notify you when a price drops. To enable this sensor, add the following lines to your `configuration.yaml` file: @@ -29,7 +29,7 @@ sensor: Configuration variables: - **name** (*Required*): The internal name of the product in Home Assistant. -- **product_id** (*Required*): ID of the product. Get the ID from the geizhals website of your chosen product by clicking on the *Price History* tab, e.g. [here](https://geizhals.de/?phist=1453021). The URL of this site reveals the ID, e.g. with `product_id: 1453021`. +- **product_id** (*Required*): ID of the product. Get the ID from the geizhals website of your chosen product by clicking on the *Price History* tab, e.g., [here](https://geizhals.de/?phist=1453021). The URL of this site reveals the ID, e.g., with `product_id: 1453021`. - **description** (*Optional*): The name of the product in the front end. - **domain** (*Optional*): Domain which should be used for the request. Set this to `geizhals.at`, `geizhals.eu`, `geizhals.de`, `skinflint.co.uk` or `cenowarka.pl`. Defaults to `geizhals.de`. - **regex** (*Optional*): Regular expression to parse the price. Default: `\D\s(\d*)[\,|\.](\d*)`. diff --git a/source/_components/sensor.gitter.markdown b/source/_components/sensor.gitter.markdown index 55b8d29fe4..72f3c4b7dc 100644 --- a/source/_components/sensor.gitter.markdown +++ b/source/_components/sensor.gitter.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Gitter Sensor" -description: "Instructions how to integrate a Gitter room sensor with Home Assistant" +description: "Instructions on how to integrate a Gitter room sensor with Home Assistant" date: 2017-06-11 09:00 sidebar: true comments: false @@ -15,19 +15,27 @@ ha_release: 0.47 This `gitter` sensor allows one to monitor a [Gitter.im](https://gitter.im) chatroom for unread messages. +## {% linkable_title Configuration %} + Visit [Gitter Developer Apps](https://developer.gitter.im/apps) to retrieve your "Personal Access Token". To use a Gitter sensor in your installation, add the following to your `configuration.yaml` file: ```yaml -# Example configuration.yml entry +# Example configuration.yaml entry sensor: - platform: gitter api_key: YOUR_API_TOKEN ``` -Configuration variables: - -- **api_key** (*Required*): Your Gitter.im API token. -- **room** (*Optional*): Gitter room to monitor. Defaults to `home-assistant/home-assistant` - +{% configuration %} +api_key: + description: Your Gitter.im API token. + required: true + type: string +room: + description: Gitter room to monitor. + required: false + type: string + default: home-assistant/home-assistant +{% endconfiguration %} diff --git a/source/_components/sensor.glances.markdown b/source/_components/sensor.glances.markdown index 03b25369a7..f455945493 100644 --- a/source/_components/sensor.glances.markdown +++ b/source/_components/sensor.glances.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Glances" -description: "Instructions how to integrate Glances sensors into Home Assistant." +description: "Instructions on how to integrate Glances sensors into Home Assistant." date: 2015-09-14 19:10 sidebar: true comments: false @@ -58,6 +58,9 @@ sensor: - 'process_thread' - 'process_sleeping' - 'cpu_temp' + - 'docker_active' + - 'docker_cpu_use' + - 'docker_memory_use' ``` Configuration variables: @@ -81,5 +84,8 @@ Configuration variables: - **process_thread**: Number of threads - **process_sleeping**: Number of sleeping processes - **cpu_temp**: CPU Temperature (may not available on all platforms) + - **docker_active**: Count of active Docker containers + - **docker_cpu_use**: Total CPU usage in percent of Docker containers + - **docker_memory_use**: Total memory used of Docker containers Not all platforms are able to provide all metrics. For instance `cpu_temp` is requires installing and configuring `lmsensors` in Ubuntu, and may not be available at all in other platforms. diff --git a/source/_components/sensor.google_wifi.markdown b/source/_components/sensor.google_wifi.markdown index 76bb37400a..303c89ed0a 100644 --- a/source/_components/sensor.google_wifi.markdown +++ b/source/_components/sensor.google_wifi.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Google Wifi" -description: "Instructions how to integrate Google Wifi/OnHub routers into Home Assistant." +description: "Instructions on how to integrate Google Wifi/OnHub routers into Home Assistant." date: 2017-07-15 21:22 sidebar: true comments: false diff --git a/source/_components/sensor.gpsd.markdown b/source/_components/sensor.gpsd.markdown index 0436c5f3d1..82448cd970 100644 --- a/source/_components/sensor.gpsd.markdown +++ b/source/_components/sensor.gpsd.markdown @@ -1,7 +1,7 @@ --- layout: page title: "GPSD" -description: "Instructions how to integrate GPSD into Home Assistant." +description: "Instructions on how to integrate GPSD into Home Assistant." date: 2016-07-18 07:00 sidebar: true comments: false diff --git a/source/_components/sensor.haveibeenpwned.markdown b/source/_components/sensor.haveibeenpwned.markdown index d58401931b..7a6b7bc1b3 100644 --- a/source/_components/sensor.haveibeenpwned.markdown +++ b/source/_components/sensor.haveibeenpwned.markdown @@ -1,7 +1,7 @@ --- layout: page title: "HaveIBeenPwned Sensor" -description: "Instructions how to integrate HaveIBeenPwned sensor into Home Assistant." +description: "Instructions on how to integrate HaveIBeenPwned sensor into Home Assistant." date: 2016-09-29 18:00 sidebar: true comments: false diff --git a/source/_components/sensor.hddtemp.markdown b/source/_components/sensor.hddtemp.markdown index 73c84fd8a1..0116bedde1 100644 --- a/source/_components/sensor.hddtemp.markdown +++ b/source/_components/sensor.hddtemp.markdown @@ -1,7 +1,7 @@ --- layout: page title: "HDDTemp" -description: "Instructions how to integrate hard drive temperature information into Home Assistant." +description: "Instructions on how to integrate hard drive temperature information into Home Assistant." date: 2016-10-28 07:00 sidebar: true comments: false diff --git a/source/_components/sensor.hive.markdown b/source/_components/sensor.hive.markdown index 3e7350e147..0d4d087516 100644 --- a/source/_components/sensor.hive.markdown +++ b/source/_components/sensor.hive.markdown @@ -14,8 +14,12 @@ ha_iot_class: "Cloud Polling" --- -The 'hive' sensor component can expose as a sensor the current online status of your Hive Hub. +The `hive` sensor component exposes Hive data as a sensor. +The platform exposes the following sensors: + +- Hive Hub Online Status +- Hive Outside Temperature

Full configuration details can be found on the main [Hive component](/components/hive/) page. diff --git a/source/_components/sensor.homematic.markdown b/source/_components/sensor.homematic.markdown index aea1b6d5ef..005011cea6 100644 --- a/source/_components/sensor.homematic.markdown +++ b/source/_components/sensor.homematic.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Homematic Sensor" -description: "Instructions how to integrate Homematic sensors within Home Assistant." +description: "Instructions on how to integrate Homematic sensors within Home Assistant." date: 2016-06-28 08:30 sidebar: true comments: false diff --git a/source/_components/sensor.homematicip_cloud.markdown b/source/_components/sensor.homematicip_cloud.markdown new file mode 100644 index 0000000000..bfb8449890 --- /dev/null +++ b/source/_components/sensor.homematicip_cloud.markdown @@ -0,0 +1,21 @@ +--- +layout: page +title: "HomematicIP Cloud Sensor" +description: "Instructions on how to integrate HomematIP sensors within Home Assistant." +date: 2018-04-02 13:40 +sidebar: true +comments: false +sharing: true +footer: true +logo: homematic.png +ha_category: Sensor +ha_release: 0.66 +ha_iot_class: "Local Push" +--- + +The `homematicip_cloud` sensor platform allows you to control +[HomematicIP](http://www.homematicip.de) sensors through Home Assistant. + +Devices will be configured automatically. Please refer to the +[component](/components/homematicip_cloud/) configuration on how to setup +HomematicIP Cloud. diff --git a/source/_components/sensor.hp_ilo.markdown b/source/_components/sensor.hp_ilo.markdown index 1f51f2052c..f242584b9d 100644 --- a/source/_components/sensor.hp_ilo.markdown +++ b/source/_components/sensor.hp_ilo.markdown @@ -15,7 +15,7 @@ ha_iot_class: "Local Polling" The `hp_ilo` platform allows you to do an API call to the HP ILO (Integrated Lights-Out) sensor of your server, and use this data in Home Assistant sensors. -If the ILO or specified jsonpath query returns only a single value (e.g. a temperature or state), it will be put in the state field. If a data structure is returned, it will be placed in the `ilo_data` attribute. +If the ILO or specified jsonpath query returns only a single value (e.g., a temperature or state), it will be put in the state field. If a data structure is returned, it will be placed in the `ilo_data` attribute. Some more details about what can be retrieved from these sensors is available in the [python-hpilo documentation](http://pythonhosted.org/python-hpilo/). @@ -23,6 +23,7 @@ Some more details about what can be retrieved from these sensors is available in

+## {% linkable_title Configuration %} To use this component in your installation, add the following to your `configuration.yaml` file: @@ -31,8 +32,8 @@ To use this component in your installation, add the following to your `configura sensor: - platform: hp_ilo host: IP_ADDRESS or HOSTNAME - username: USERNAME - password: PASSWORD + username: YOUR_USERNAME + password: YOUR_PASSWORD monitored_variables: - name: SENSOR NAME sensor_type: SENSOR TYPE @@ -63,7 +64,7 @@ Valid sensor_types: - **server_health**: Get server health information. - **network_settings**: Get the iLO network settings. -### Example +## {% linkable_title Example %} In order to get two sensors reporting CPU fan speed and Ambient Inlet Temperature, as well as a dump of `server_health` on a HP Microserver Gen8, you could use the following in your `configuration.yaml` file @@ -71,8 +72,8 @@ In order to get two sensors reporting CPU fan speed and Ambient Inlet Temperatur sensor: - platform: hp_ilo host: IP_ADDRESS or HOSTNAME - username: USERNAME - password: PASSWORD + username: YOUR_USERNAME + password: YOUR_PASSWORD monitored_variables: - name: CPU fanspeed sensor_type: server_health diff --git a/source/_components/sensor.http.markdown b/source/_components/sensor.http.markdown index c119330eb4..9b0ec80fe1 100644 --- a/source/_components/sensor.http.markdown +++ b/source/_components/sensor.http.markdown @@ -1,7 +1,7 @@ --- layout: page title: "HTTP Sensor" -description: "Instructions how to integrate HTTP sensors within Home Assistant." +description: "Instructions on how to integrate HTTP sensors within Home Assistant." date: 2016-02-05 12:15 sidebar: true comments: false diff --git a/source/_components/sensor.htu21d.markdown b/source/_components/sensor.htu21d.markdown index f81b0f6c71..a485fb0c38 100644 --- a/source/_components/sensor.htu21d.markdown +++ b/source/_components/sensor.htu21d.markdown @@ -1,7 +1,7 @@ --- layout: page title: "HTU21D Temperature and humidity sensor" -description: "Instructions how to integrate a HTU21D Temperature and humidity sensor into Home Assistant." +description: "Instructions on how to integrate a HTU21D Temperature and humidity sensor into Home Assistant." date: 2017-06-10 00:00 sidebar: true comments: false diff --git a/source/_components/sensor.hydroquebec.markdown b/source/_components/sensor.hydroquebec.markdown index 18de06c9c7..891f74ae21 100644 --- a/source/_components/sensor.hydroquebec.markdown +++ b/source/_components/sensor.hydroquebec.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Hydro-Québec" -description: "Instructions how to integrate Hydro-Québec consumption profile within Home Assistant." +description: "Instructions on how to integrate Hydro-Québec consumption profile within Home Assistant." date: 2016-12-10 0:15 sidebar: true comments: false diff --git a/source/_components/sensor.ihc.markdown b/source/_components/sensor.ihc.markdown index 70ec6c11e2..b3e91ed982 100644 --- a/source/_components/sensor.ihc.markdown +++ b/source/_components/sensor.ihc.markdown @@ -1,7 +1,7 @@ --- layout: page title: "IHC Sensor" -description: "Instructions how to integrate IHC Sensors within Home Assistant." +description: "Instructions on how to integrate IHC Sensors within Home Assistant." date: 2017-11-27 13:35 sidebar: true comments: false diff --git a/source/_components/sensor.imap.markdown b/source/_components/sensor.imap.markdown index 34fd3df923..a3b9af23b2 100644 --- a/source/_components/sensor.imap.markdown +++ b/source/_components/sensor.imap.markdown @@ -1,7 +1,7 @@ --- layout: page title: "IMAP Unread E-mail" -description: "Instructions how to integrate IMAP unread email into Home Assistant." +description: "Instructions on how to integrate IMAP unread email into Home Assistant." date: 2016-07-11 06:00 sidebar: true comments: false @@ -24,8 +24,8 @@ sensor: - platform: imap server: imap.gmail.com port: 993 - username: USERNAME - password: PASSWORD + username: YOUR_USERNAME + password: YOUR_PASSWORD ``` Configuration variables: diff --git a/source/_components/sensor.imap_email_content.markdown b/source/_components/sensor.imap_email_content.markdown index 35f9d2d694..22212426f6 100644 --- a/source/_components/sensor.imap_email_content.markdown +++ b/source/_components/sensor.imap_email_content.markdown @@ -1,7 +1,7 @@ --- layout: page title: "IMAP Email Content" -description: "Instructions how to integrate IMAP email content sensor into Home Assistant." +description: "Instructions on how to integrate IMAP email content sensor into Home Assistant." date: 2016-09-09 12:30 sidebar: true comments: false diff --git a/source/_components/sensor.influxdb.markdown b/source/_components/sensor.influxdb.markdown index 32f18814a2..66680379f7 100644 --- a/source/_components/sensor.influxdb.markdown +++ b/source/_components/sensor.influxdb.markdown @@ -1,7 +1,7 @@ --- layout: page title: "InfluxDB Sensor" -description: "Instructions how to integrate InfluxDB sensors within Home Assistant." +description: "Instructions on how to integrate InfluxDB sensors within Home Assistant." date: 2016-10-26 23:15 sidebar: true comments: false diff --git a/source/_components/sensor.insteon_plm.markdown b/source/_components/sensor.insteon_plm.markdown index db9125f33a..1974ea9540 100644 --- a/source/_components/sensor.insteon_plm.markdown +++ b/source/_components/sensor.insteon_plm.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Insteon PLM Sensor" -description: "Instructions how to setup the Insteon PLM sensors locally within Home Assistant." +description: "Instructions on how to setup the Insteon PLM sensors locally within Home Assistant." date: 2017-02-19 17:00 sidebar: true comments: false diff --git a/source/_components/sensor.isy994.markdown b/source/_components/sensor.isy994.markdown index 60913660ef..0be49fb0e1 100644 --- a/source/_components/sensor.isy994.markdown +++ b/source/_components/sensor.isy994.markdown @@ -1,7 +1,7 @@ --- layout: page title: "ISY994 Sensor" -description: "Instructions how to integrate ISY994 sensors into Home Assistant." +description: "Instructions on how to integrate ISY994 sensors into Home Assistant." date: 2016-09-03 23:00 sidebar: true comments: false diff --git a/source/_components/sensor.juicenet.markdown b/source/_components/sensor.juicenet.markdown index b65740d15e..03bad7fccc 100644 --- a/source/_components/sensor.juicenet.markdown +++ b/source/_components/sensor.juicenet.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Juicenet Sensor" -description: "Instructions how to setup WiFi-equipped Juicenet charging stations with Home Assistant." +description: "Instructions on how to setup WiFi-equipped Juicenet charging stations with Home Assistant." date: 2015-01-20 22:36 sidebar: true comments: false diff --git a/source/_components/sensor.kira.markdown b/source/_components/sensor.kira.markdown index 3f4d30443b..1306cf161b 100644 --- a/source/_components/sensor.kira.markdown +++ b/source/_components/sensor.kira.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Kira Sensor" -description: "Instructions how to integrate Kira modules into Home Assistant." +description: "Instructions on how to integrate Kira modules into Home Assistant." date: 2017-05-07 17:00 sidebar: true comments: false diff --git a/source/_components/sensor.kwb.markdown b/source/_components/sensor.kwb.markdown index 7148e016f2..8c93feb4dd 100644 --- a/source/_components/sensor.kwb.markdown +++ b/source/_components/sensor.kwb.markdown @@ -1,7 +1,7 @@ --- layout: page title: "KWB Easyfire Sensor" -description: "Instructions how to integrate the KWB Easyfire sensor into Home Assistant." +description: "Instructions on how to integrate the KWB Easyfire sensor into Home Assistant." date: 2017-03-06 14:10 sidebar: true comments: false diff --git a/source/_components/sensor.lacrosse.markdown b/source/_components/sensor.lacrosse.markdown index f5abbb4a05..5218a2b710 100644 --- a/source/_components/sensor.lacrosse.markdown +++ b/source/_components/sensor.lacrosse.markdown @@ -1,7 +1,7 @@ --- layout: page title: "LaCrosse Sensor" -description: "Instructions how to integrate LaCrosse sensor data received from Jeelink into Home Assistant." +description: "Instructions on how to integrate LaCrosse sensor data received from Jeelink into Home Assistant." date: 2017-10-29 15:00 sidebar: true comments: false diff --git a/source/_components/sensor.lastfm.markdown b/source/_components/sensor.lastfm.markdown index 218e2f2a8e..8a78726e38 100644 --- a/source/_components/sensor.lastfm.markdown +++ b/source/_components/sensor.lastfm.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Last.fm" -description: "Instructions how to integrate Last.fm sensors into Home Assistant." +description: "Instructions on how to integrate Last.fm sensors into Home Assistant." date: 2016-05-18 09:00 sidebar: true comments: false diff --git a/source/_components/sensor.linux_battery.markdown b/source/_components/sensor.linux_battery.markdown index 13fc3d3e2f..4bc3ea6b7c 100644 --- a/source/_components/sensor.linux_battery.markdown +++ b/source/_components/sensor.linux_battery.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Linux Battery" -description: "Instructions how to integrate Linux Battery information into Home Assistant." +description: "Instructions on how to integrate Linux Battery information into Home Assistant." date: 2016-09-06 07:00 sidebar: true comments: false diff --git a/source/_components/sensor.london_air.markdown b/source/_components/sensor.london_air.markdown index d5c9bad344..b6713b73dc 100644 --- a/source/_components/sensor.london_air.markdown +++ b/source/_components/sensor.london_air.markdown @@ -59,7 +59,7 @@ Configuration variables: - **locations** array (*Required*): At least one entry required. -To explore the data available within the `data` attribute of a sensor use the `dev-template` tool on the Home-assistant frontend. `data` contains a list of monitored sites, where the number of monitored sites are given by the `sites` attribute. If a sensor has four sites, access the fourth site by indexing the list of sites using data[3]. Each site is a dictionary with multiple fields, with entries for the `latitude` and `longitude` of that site, a `pollution_status`, `site_code`, `site_name` and `site_type`. The field `number_of_pollutants` states how many pollutants are monitored (of the possible six) and the field `pollutants` returns a list with data for each pollutant. To access the first pollutant in the list for site zero use `attributes.data[0].pollutants[0]`. Each entry in `pollutants` is a dictionary with fields for the pollutant `code`, `description`, `index`, `quality` and a `summary`. [Template sensors](https://home-assistant.io/components/sensor.template/) can then be added to display these attributes, for example: +To explore the data available within the `data` attribute of a sensor use the `dev-template` tool on the Home-assistant frontend. `data` contains a list of monitored sites, where the number of monitored sites are given by the `sites` attribute. If a sensor has four sites, access the fourth site by indexing the list of sites using data[3]. Each site is a dictionary with multiple fields, with entries for the `latitude` and `longitude` of that site, a `pollution_status`, `site_code`, `site_name` and `site_type`. The field `number_of_pollutants` states how many pollutants are monitored (of the possible six) and the field `pollutants` returns a list with data for each pollutant. To access the first pollutant in the list for site zero use `attributes.data[0].pollutants[0]`. Each entry in `pollutants` is a dictionary with fields for the pollutant `code`, `description`, `index`, `quality` and a `summary`. [Template sensors](/components/sensor.template/) can then be added to display these attributes, for example: ```yaml # Example template sensors diff --git a/source/_components/sensor.loop_energy.markdown b/source/_components/sensor.loop_energy.markdown index 55f8770b82..fc38aed98e 100644 --- a/source/_components/sensor.loop_energy.markdown +++ b/source/_components/sensor.loop_energy.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Loop Energy" -description: "Instructions how to integrate Loop Energy devices within Home Assistant." +description: "Instructions on how to integrate Loop Energy devices within Home Assistant." date: 2016-04-02 22:00 sidebar: true comments: false diff --git a/source/_components/sensor.luftdaten.markdown b/source/_components/sensor.luftdaten.markdown index a5d701feb5..8e4a41cdef 100644 --- a/source/_components/sensor.luftdaten.markdown +++ b/source/_components/sensor.luftdaten.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Luftdaten Sensor" -description: "Instructions how to setup Luftdaten sensor in Home Assistant." +description: "Instructions on how to setup Luftdaten sensor in Home Assistant." date: 2017-11-01 00:00 sidebar: true comments: false diff --git a/source/_components/sensor.markdown b/source/_components/sensor.markdown index 9f446e5266..647f0e7ab0 100644 --- a/source/_components/sensor.markdown +++ b/source/_components/sensor.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Sensor" -description: "Instructions how to setup your sensors with Home Assistant." +description: "Instructions on how to setup your sensors with Home Assistant." date: 2015-01-24 14:39 sidebar: true comments: false @@ -9,8 +9,21 @@ sharing: true footer: true --- -Sensors are gathering information about states and conditions. +Sensors are gathering information about states and conditions. -Home Assistant currently supports a wide range of sensors. They are able to display information which are provides by Home assistant directly, are gathered from web services, and, of course, physical devices. Please check the sidebar for a full list of supported sensor platforms. +Home Assistant currently supports a wide range of sensors. They are able to display information which are provides by Home Assistant directly, are gathered from web services, and, of course, physical devices. Please check the sidebar for a full list of supported sensor platforms. +### {% linkable_title Device Class %} +The way these sensors are displayed in the frontend can be modified in the [customize section](/docs/configuration/customizing-devices/). The following device classes are supported for sensors: + +- **None**: Generic sensor. This is the default and doesn't need to be set. +- **battery**: Percentage of battery that is left. +- **humidity**: Percentage of humidity in the air. +- **illuminance**: The current light level in lx or lm. +- **temperature**: Temperature in °C or °F. + +

+ +Example of various device class icons for sensors. +

diff --git a/source/_components/sensor.mfi.markdown b/source/_components/sensor.mfi.markdown index bcf44344df..4498c4d328 100644 --- a/source/_components/sensor.mfi.markdown +++ b/source/_components/sensor.mfi.markdown @@ -1,7 +1,7 @@ --- layout: page title: "mFi Sensor" -description: "Instructions how to integrate mFi sensors within Home Assistant." +description: "Instructions on how to integrate mFi sensors within Home Assistant." date: 2016-02-07 10:00 sidebar: true comments: false @@ -16,15 +16,17 @@ ha_release: 0.32 The `mfi` sensor platform to allow you to monitor [mFi mPort interface and sensors](https://www.ubnt.com/mfi/mport/). +## {% linkable_title Configuration %} + To add this platform to your installation, add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry sensor: - platform: mfi - host: IP_ADDRESS - username: USERNAME - password: PASSWORD + host: IP_ADDRESS_OF_SENSOR + username: YOUR_USERNAME + password: YOUR_PASSWORD ``` Configuration variables: diff --git a/source/_components/sensor.miflora.markdown b/source/_components/sensor.miflora.markdown index 8fcfca3d09..1034b4a5b3 100644 --- a/source/_components/sensor.miflora.markdown +++ b/source/_components/sensor.miflora.markdown @@ -18,8 +18,8 @@ The `miflora` sensor platform allows one to monitor plants. The [Mi Flora plant # Installation Depending on the operating system you're running, you have to configure the proper Bluetooth backend on your system: -- On [Hass.io](https://home-assistant.io/hassio/installation/): Miflora will work out of the box. -- On other Linux systems: +- On [Hass.io](/hassio/installation/): Miflora will work out of the box. +- On other Linux systems: - Preferred solution: Install the `bluepy` library (via pip). When using a virtual environment, make sure to use install the library in the right one.    - Fallback solution: Install `gatttool` via your package manager. Depending on the distribution, the package name might be: `bluez`, `bluetooth`, `bluez-deprecated` - Windows and MacOS are currently not supported by the [miflora library](https://github.com/open-homeautomation/miflora/). @@ -38,7 +38,7 @@ C4:D3:8C:12:4C:57 Flower mate Or if your distribution is using bluetoothctl: ```bash -$ bluetoothctl +$ bluetoothctl [bluetooth]# scan on [NEW] Controller [default] [NEW] F8:04:33:AF:AB:A2 [TV] UE48JU6580 @@ -68,13 +68,13 @@ sensor: - **battery**: Battery details. - **name** (*Optional*): The name displayed in the frontend. - **force_update** (*Optional*): Sends update events even if the value hasn't changed. -- **median** (*Optional*): Sometimes the sensor measurements show spikes. Using this parameter, the poller will report the median of the last 3 (you can also use larger values) measurements. This filters out single spikes. Median: 5 will also filter double spikes. If you never have problems with spikes, `median: 1` will work fine. +- **median** (*Optional*): Sometimes the sensor measurements show spikes. Using this parameter, the poller will report the median of the last 3 (you can also use larger values) measurements. This filters out single spikes. Median: 5 will also filter double spikes. If you never have problems with spikes, `median: 1` will work fine. - **timeout** (*Optional*): Define the timeout value in seconds when polling (defaults to 10 if not defined) - **retries** (*Optional*): Define the number of retries when polling (defaults to 2 if not defined) - **cache_value** (*Optional*): Define cache expiration value in seconds (defaults to 1200 if not defined) - **adapter** (*Optional*): Define the Bluetooth adapter to use (defaults to hci0). Run `hciconfig` to get a list of available adapters. -Note that by default the sensor is only polled once every 15 minutes. This means with the `median: 3` setting will take as least 30 minutes before the sensor will report a value after a Home Assistant restart. As the values usually change very slowly, this isn't a big problem. +Note that by default the sensor is only polled once every 20 minutes. This means with the `median: 3` setting will take as least 40 minutes before the sensor will report a value after a Home Assistant restart. As the values usually change very slowly, this isn't a big problem. Reducing polling intervals will have a negative effect on the battery life. A full configuration example could look like the one below: diff --git a/source/_components/sensor.min_max.markdown b/source/_components/sensor.min_max.markdown index a71e0650e2..428e848566 100644 --- a/source/_components/sensor.min_max.markdown +++ b/source/_components/sensor.min_max.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Min/max Sensor" -description: "Instructions how to integrate min/max sensors into Home Assistant." +description: "Instructions on how to integrate min/max sensors into Home Assistant." date: 2016-10-13 12:00 sidebar: true comments: false diff --git a/source/_components/sensor.mitemp_bt.markdown b/source/_components/sensor.mitemp_bt.markdown new file mode 100644 index 0000000000..0cfaa72542 --- /dev/null +++ b/source/_components/sensor.mitemp_bt.markdown @@ -0,0 +1,93 @@ +--- +layout: page +title: "Xiaomi BLE Temperature and Humidity sensor" +description: "Instructions on how to integrate MiTemp BLE temperature and humidity sensor with Home Assistant." +date: 2018-04-22 12:00 +sidebar: true +comments: false +sharing: true +footer: true +logo: xiaomi.png +ha_category: DIY +ha_release: 0.69 +ha_iot_class: "Local Polling" +--- + +The `mitemp_bt` sensor platform allows one to monitor room temperature and humidity. The [Xiaomi Mijia BLE Temperature and Humidity sensor with LCD](https://www.amazon.com/Temperature-Humidity-Xiaomi-Bluetooth-Screen-Remote/dp/B079L6N6PC) is a small Bluetooth Low Energy device that monitors the room temperature and humidity. As only a single BLE device can be polled at the same time, the library employs locking to make sure this is the case. + +# Installation +Depending on the operating system you're running, you have to configure the proper Bluetooth backend on your system: + +- On [Hass.io](/hassio/installation/): Not yet supported. +- On other Linux systems: + - Preferred solution: Install the `bluepy` and `btlewrap` library (via pip). When using a virtual environment, make sure to use install the library in the right one. +    - Fallback solution: Install `btlewrap` library (via pip) and `gatttool` via your package manager. Depending on the distribution, the package name might be: `bluez`, `bluetooth`, `bluez-deprecated` +- Windows and MacOS are currently not supported by the btlewrap library. + +# Configuration +Start a scan to determine the MAC addresses of the sensor: + +```bash +$ sudo hcitool lescan +LE Scan ... +4C:65:A8:D2:31:7F MJ_HT_V1 +[...] +``` + +Or if your distribution is using bluetoothctl: + +```bash +$ bluetoothctl +[bluetooth]# scan on +Discovery started +[CHG] Controller XX:XX:XX:XX:XX:XX Discovering: yes +[NEW] Device 4C:65:A8:D2:31:7F MJ_HT_V1 + +``` + + +Check for `MJ_HT_V1` or similar entries, those are your sensor. + +To use your Mi Temperature and Humidity sensor in your installation, add the following to your `configuration.yaml` file: + +```yaml +# Example configuration.yaml entry +sensor: + - platform: mitemp_bt + mac: 'xx:xx:xx:xx:xx:xx' + monitored_conditions: + - temperature +``` + +- **mac** (*Required*): The MAC address of your sensor. +- **monitored_conditions** array (*Optional*): The parameters that should be monitored (defaults to monitoring all parameters). + - **temperature**: Temperature in C at the sensor's location. + - **humidity**: Humidity level in % at the sensor's location. + - **battery**: Battery details (in %). +- **name** (*Optional*): The name displayed in the frontend. +- **force_update** (*Optional*): Sends update events even if the value hasn't changed. +- **median** (*Optional*): Sometimes the sensor measurements show spikes. Using this parameter, the poller will report the median of the last 3 (you can also use larger values) measurements. This filters out single spikes. Median: 5 will also filter double spikes. If you never have problems with spikes, `median: 1` will work fine. +- **timeout** (*Optional*): Define the timeout value in seconds when polling (defaults to 10 if not defined) +- **retries** (*Optional*): Define the number of retries when polling (defaults to 2 if not defined) +- **cache_value** (*Optional*): Define cache expiration value in seconds (defaults to 1200 if not defined) +- **adapter** (*Optional*): Define the Bluetooth adapter to use (defaults to hci0). Run `hciconfig` to get a list of available adapters. + +Note that by default the sensor is only polled once every 5 minutes. This means with the `median: 3` setting will take as least 15 minutes before the sensor will report a value after a Home Assistant restart. Even though the hardware is able to provide new values every second, room temperaturs don't change that quickly. +Reducing polling intervals will have a negative effect on the battery life. + +A full configuration example could look like the one below: + +```yaml +# Example configuration.yaml entry +sensor: + - platform: mitemp_bt + mac: 'xx:xx:xx:xx:xx:xx' + name: Kids Room Temp + force_update: false + median: 3 + monitored_conditions: + - temperature + - humidity + - battery +``` + diff --git a/source/_components/sensor.modbus.markdown b/source/_components/sensor.modbus.markdown index 70cbfb494c..5868888488 100644 --- a/source/_components/sensor.modbus.markdown +++ b/source/_components/sensor.modbus.markdown @@ -1,7 +1,7 @@ --- layout: page title: Modbus Sensor -description: "Instructions how to integrate Modbus sensors into Home Assistant." +description: "Instructions on how to integrate Modbus sensors into Home Assistant." date: 2015-08-30 23:38 sidebar: true comments: false @@ -16,10 +16,12 @@ ha_iot_class: "Local Push" The `modbus` sensor allows you to gather data from [Modbus](http://www.modbus.org/) registers. +## {% linkable_title Configuration %} + To use your Modbus sensors in your installation, add the following to your `configuration.yaml` file: ```yaml -# Example configuration.yml entry +# Example configuration.yaml entry sensor: platform: modbus registers: diff --git a/source/_components/sensor.modem_callerid.markdown b/source/_components/sensor.modem_callerid.markdown index d2d0340bb3..6fa1ed1919 100644 --- a/source/_components/sensor.modem_callerid.markdown +++ b/source/_components/sensor.modem_callerid.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Caller ID Sensor" -description: "Instructions how to integrate the Caller ID sensor into Home Assistant." +description: "Instructions on how to integrate the Caller ID sensor into Home Assistant." date: 2017-02-20 22:10 sidebar: true comments: false @@ -31,7 +31,7 @@ To find the path of your USB modem, run: `$ ls /dev/ttyACM*` -If Home Assistant (`hass`) runs with another user (e.g. `homeassistant` on Hassbian) give access to the stick with: +If Home Assistant (`hass`) runs with another user (e.g., `homeassistant` on Hassbian) give access to the stick with: `$ sudo usermod -a -G dialout homeassistant` diff --git a/source/_components/sensor.mold_indicator.markdown b/source/_components/sensor.mold_indicator.markdown index 74d91d671d..b14f077a19 100644 --- a/source/_components/sensor.mold_indicator.markdown +++ b/source/_components/sensor.mold_indicator.markdown @@ -15,7 +15,7 @@ ha_iot_class: "Local Polling" The Mold Indicator sensor component consumes information of two temperature sensors and a humidity sensor to give an indication for possible mold growth in your home. In case of bad ventilation and insulation, the indoor humidity may lead to condensation on cold surfaces as the windows or even walls. Condensation or a high relative humidity near those cold surfaces leads to a higher risk for mold growth. This sensor component estimates the temperature at a pre-calibrated critical point in the room (the coldest surface) and calculates the relative humidity of the air at that point. If the sensor value rises above approximately 70 percent, mold growth might occur and the room should be ventilated. At 100%, the air humidity condensates at the critical point. -The sensor data may be used e.g. to signal bad air quality (too high air humidity) or to automate operation of indoor air humidifiers to keep the indoor humidity at an optimum. To use the Mold Indicator sensor in your installation, add the following to your `configuration.yaml` file: +The sensor data may be used e.g., to signal bad air quality (too high air humidity) or to automate operation of indoor air humidifiers to keep the indoor humidity at an optimum. To use the Mold Indicator sensor in your installation, add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry diff --git a/source/_components/sensor.moon.markdown b/source/_components/sensor.moon.markdown index 327d221431..8b90dc0a44 100644 --- a/source/_components/sensor.moon.markdown +++ b/source/_components/sensor.moon.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Moon Sensor" -description: "Instructions how to integrate the moon sensor into Home Assistant." +description: "Instructions on how to integrate the moon sensor into Home Assistant." date: 2017-02-03 07:10 sidebar: true comments: false diff --git a/source/_components/sensor.mopar.markdown b/source/_components/sensor.mopar.markdown index 3357ae9193..6514684183 100644 --- a/source/_components/sensor.mopar.markdown +++ b/source/_components/sensor.mopar.markdown @@ -24,18 +24,28 @@ Be sure you have a [mopar.com](http://mopar.com) account with your vehicle(s) re To enable this sensor, add the following lines to your `configuration.yaml`. ```yaml +# Example configuration.yaml entry sensor: - platform: mopar - username: - password: - pin: + username: YOUR_USERNAME + password: YOUR_PASSWORD + pin: YOUR_UCONNECT_PIN ``` -Configuration options for the Mopar sensor: - -- **username** (*Required*): Your mopar.com username. -- **password** (*Required*): Your mopar.com password. -- **pin** (*Required*): Your uConnect pin. +{% configuration %} +username: + description: Your mopar.com username. + required: true + type: string +password: + description: Your mopar.com password. + required: true + type: string +pin: + description: v + required: true + type: string +{% endconfiguration %} ## {% linkable_title Service %} diff --git a/source/_components/sensor.mqtt.markdown b/source/_components/sensor.mqtt.markdown index aebe44beb9..0b44200064 100644 --- a/source/_components/sensor.mqtt.markdown +++ b/source/_components/sensor.mqtt.markdown @@ -1,7 +1,7 @@ --- layout: page title: "MQTT Sensor" -description: "Instructions how to integrate MQTT sensors within Home Assistant." +description: "Instructions on how to integrate MQTT sensors within Home Assistant." date: 2015-05-30 23:21 sidebar: true comments: false @@ -16,10 +16,12 @@ ha_iot_class: depends This `mqtt` sensor platform uses the MQTT message payload as the sensor value. If messages in this `state_topic` are published with *RETAIN* flag, the sensor will receive an instant update with last known value. Otherwise, the initial state will be undefined. +## {% linkable_title Configuration %} + To use your MQTT sensor in your installation, add the following to your `configuration.yaml` file: ```yaml -# Example configuration.yml entry +# Example configuration.yaml entry sensor: - platform: mqtt state_topic: "home/bedroom/temperature" @@ -44,6 +46,10 @@ unit_of_measurement: description: Defines the units of measurement of the sensor, if any. required: false type: string +icon: + description: Icon for the sensor (e.g. `mdi:gauge`). + required: false + type: string expire_after: description: Defines the number of seconds after the value expires if it's not updated. required: false @@ -76,6 +82,15 @@ json_attributes: description: A list of keys to extract values from a JSON dictionary payload and then set as sensor attributes. reqired: false type: list, string +unique_id: + description: "An ID that uniquely identifies this sensor. If two sensors have the same unique ID, Home Assistant will raise an exception." + required: false + type: string +device_class: + description: The type/class of the sensor to set the icon in the frontend. + required: false + type: device_class + default: None {% endconfiguration %} ## {% linkable_title Examples %} @@ -84,17 +99,17 @@ In this section you find some real life examples of how to use this sensor. ### {% linkable_title JSON attributes configuration %} -The example sensor below shows a configuration example which uses JSON in the state topic to add extra attributes. It also makes use of the availability topic. Attributes can then be extracted in [Templates](configuration/templating/#attributes); Example to extract data from the sensor below {% raw %}'{{ states.sensor.bs_client_name.attributes.ClientName }}'{% endraw %}. +The example sensor below shows a configuration example which uses JSON in the state topic to add extra attributes. It also makes use of the availability topic. Attributes can then be extracted in [Templates](/docs/configuration/templating/#attributes). For example, to extract the `ClientName` attribute from the sensor below, use a template similar to: {% raw %}`{{ state_attr('sensor.bs_rssi', 'ClientName') }}`{% endraw %}. {% raw %} ```yaml -# Example configuration.yml entry +# Example configuration.yaml entry sensor: - platform: mqtt - state_topic: "HUISHS/BunnyShed/NodeHealthJSON" name: "BS RSSI" - unit_of_measurement: "dBm" - value_template: '{{ value_json.RSSI }}' + state_topic: "HUISHS/BunnyShed/NodeHealthJSON" + unit_of_measurement: 'dBm' + value_template: "{{ value_json.RSSI }}" availability_topic: "HUISHS/BunnyShed/status" payload_available: "online" payload_not_available: "offline" @@ -110,7 +125,7 @@ sensor: ### {% linkable_title Get battery level %} -If you are using the [Owntracks](/components/device_tracker.owntracks/) and enable the reporting of the battery level then you can use a MQTT sensor to keep track of your battery. A regular MQTT message from Owntracks looks like this: +If you are using the [OwnTracks](/components/device_tracker.owntracks/) and enable the reporting of the battery level then you can use a MQTT sensor to keep track of your battery. A regular MQTT message from OwnTracks looks like this: ```bash owntracks/tablet/tablet {"_type":"location","lon":7.21,"t":"u","batt":92,"tst":144995643,"tid":"ta","acc":27,"lat":46.12} @@ -120,13 +135,13 @@ Thus the trick is extracting the battery level from the payload. {% raw %} ```yaml -# Example configuration.yml entry +# Example configuration.yaml entry sensor: - platform: mqtt - state_topic: "owntracks/tablet/tablet" name: "Battery Tablet" - unit_of_measurement: "%" - value_template: '{{ value_json.batt }}' + state_topic: "owntracks/tablet/tablet" + unit_of_measurement: '%' + value_template: "{{ value_json.batt }}" ``` {% endraw %} @@ -146,24 +161,29 @@ Then use this configuration example to extract the data from the payload: {% raw %} ```yaml -# Example configuration.yml entry +# Example configuration.yaml entry sensor: - platform: mqtt - state_topic: 'office/sensor1' - name: 'Temperature' + name: "Temperature" + state_topic: "office/sensor1" unit_of_measurement: '°C' - value_template: '{{ value_json.temperature }}' + value_template: "{{ value_json.temperature }}" - platform: mqtt - state_topic: 'office/sensor1' - name: 'Humidity' + name: "Humidity" + state_topic: "office/sensor1" unit_of_measurement: '%' - value_template: '{{ value_json.humidity }}' + value_template: "{{ value_json.humidity }}" ``` {% endraw %} ### {% linkable_title Get sensor value from a device with ESPEasy %} -Assuming that you have flashed your ESP8266 unit with [ESPEasy](https://github.com/letscontrolit/ESPEasy). Under "Config" set a name ("Unit Name:") for your device (here it's "bathroom"). 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 sensor in the "Devices" tap with the name "analog" and "brightness" as value. +Assuming that you have flashed your ESP8266 unit with [ESPEasy](https://github.com/letscontrolit/ESPEasy). Under "Config" set a name ("Unit Name:") for your device (here it's "bathroom"). 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". Please keep in mind that the ESPEasy default topics start with a `/` and only contain the name when writing your entry for the `configuration.yaml` file. + +- **Controller Subscribe**: `home/%sysname%/#` (instead of `/%sysname%/#`) +- **Controller Publish**: `home/%sysname%/%tskname%/%valname%` (instead of `/%sysname%/%tskname%/%valname%`) + +Also, add a sensor in the "Devices" tap with the name "analog" and "brightness" as value. As soon as the unit is online, you will get the state of the sensor. @@ -177,12 +197,10 @@ The configuration will look like the example below: {% raw %} ```yaml -# Example configuration.yml entry +# Example configuration.yaml entry sensor: - platform: mqtt - state_topic: 'home/bathroom/analog/brightness' - name: Brightness + name: "Brightness" + state_topic: "home/bathroom/analog/brightness" ``` {% endraw %} - - diff --git a/source/_components/sensor.mqtt_room.markdown b/source/_components/sensor.mqtt_room.markdown index 598dafefb1..96aaa9dc7d 100644 --- a/source/_components/sensor.mqtt_room.markdown +++ b/source/_components/sensor.mqtt_room.markdown @@ -16,6 +16,8 @@ ha_iot_class: depends The `mqtt_room` sensor platform allows you to detect the indoor location of devices using MQTT clients. +## {% linkable_title Configuration %} + To use this device tracker in your installation, add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/sensor.mvglive.markdown b/source/_components/sensor.mvglive.markdown index d3b10f1882..7d613d8598 100644 --- a/source/_components/sensor.mvglive.markdown +++ b/source/_components/sensor.mvglive.markdown @@ -1,7 +1,7 @@ --- layout: page title: "MVG" -description: "Instructions how to integrate Munich public transport departure times into Home Assistant." +description: "Instructions on how to integrate Munich public transport departure times into Home Assistant." date: 2017-03-21 20:00 sidebar: true comments: false @@ -16,6 +16,8 @@ ha_iot_class: "Cloud Polling" The `mvglive` sensor will give you the departure time of the next bus, tram, subway, or train at the next station or stop in the Munich public transport network. Additional details such as the line number and destination are present in the attributes. +## {% linkable_title Configuration %} + To enable this sensor, add the following lines to your `configuration.yaml` file: ```yaml @@ -29,9 +31,9 @@ sensor: Configuration variables: - **station** (*Required*): Name of the stop or station. Visit [the MVG live web site](http://www.mvg-live.de) to find valid names. - - **destinations** (*Optional*): One or multiple final stop names, e.g. 'Feldmoching' or ['Feldmoching','Harthof']. This can be used to only consider a particular direction of travel + - **destinations** (*Optional*): One or multiple final stop names, e.g., 'Feldmoching' or ['Feldmoching','Harthof']. This can be used to only consider a particular direction of travel - **directions** (*Optional*): Filter by direction of the departure. For Tram, Bus, SEV, and S-Bahn, direction = direction. For U-Bahn trains, directions are more general. For U1, U2, U3 and U6, direction='1' indicates south-bound trains, direction='2' indicates northbound trains. For U4 and U5, direction='1' indicates east-bound trains, direction='2' indicates west-bound trains. For example, setting directions: '1' can be used to get all south-bound trains at Scheidplatz. - - **lines** (*Optional*): One or more line numbers, e.g. 'U2' or ['U2','U8','N41'] + - **lines** (*Optional*): One or more line numbers, e.g., 'U2' or ['U2','U8','N41'] - **products** (*Optional*): One or more modes of transport, defaults to all 4 modes ['U-Bahn', 'Tram', 'Bus', 'S-Bahn']. - **timeoffset** (*Optional*): Do not display departures leaving sooner than this number of minutes (defaults to 0). Useful if you are a couple of minutes away from the stop. - **name** (*Optional*): You can customize the name of the sensor, which defaults to the station name. @@ -42,7 +44,7 @@ Configuration variables: The example below shows a full configuration with three sensors that showcase the various configuration options. ```yaml -# Example configuration.yml entry +# Example configuration.yaml entry sensor: - platform: mvglive nextdeparture: diff --git a/source/_components/sensor.mysensors.markdown b/source/_components/sensor.mysensors.markdown index 06d90e74f8..a6e8657014 100644 --- a/source/_components/sensor.mysensors.markdown +++ b/source/_components/sensor.mysensors.markdown @@ -1,7 +1,7 @@ --- layout: page title: "MySensors Sensor" -description: "Instructions how to integrate MySensors sensors into Home Assistant." +description: "Instructions on how to integrate MySensors sensors into Home Assistant." date: 2016-10-01 15:00 +0200 sidebar: true comments: false diff --git a/source/_components/sensor.nederlandse_spoorwegen.markdown b/source/_components/sensor.nederlandse_spoorwegen.markdown index b9a14e6605..bbdee43f63 100644 --- a/source/_components/sensor.nederlandse_spoorwegen.markdown +++ b/source/_components/sensor.nederlandse_spoorwegen.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Nederlandse Spoorwegen" -description: "Instructions how to integrate timetable data for traveling by train in the Netherlands within Home Assistant." +description: "Instructions on how to integrate timetable data for traveling by train in the Netherlands within Home Assistant." date: 2017-10-25 13:35 sidebar: true comments: false @@ -24,16 +24,16 @@ Add the data to your `configuration.yaml` file as shown in the example: # Example configuration.yaml entry sensor: - platform: nederlandse_spoorwegen - email: you@example.com - password: !secret ns_password - routes: - - name: Rotterdam-Amsterdam - from: Rtd - to: Asd - - name: Groningen-Zwolle-Maastricht - from: Gn - to: Mt - via: Zl + email: you@example.com + password: !secret ns_password + routes: + - name: Rotterdam-Amsterdam + from: Rtd + to: Asd + - name: Groningen-Zwolle-Maastricht + from: Gn + to: Mt + via: Zl ``` Configuration variables: diff --git a/source/_components/sensor.nest.markdown b/source/_components/sensor.nest.markdown index 37e5d83d5a..73c15de3d2 100644 --- a/source/_components/sensor.nest.markdown +++ b/source/_components/sensor.nest.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Nest Sensor" -description: "Instructions how to integrate Nest sensors within Home Assistant." +description: "Instructions on how to integrate Nest sensors within Home Assistant." date: 2016-01-13 19:59 sidebar: true comments: false diff --git a/source/_components/sensor.nest_weather.markdown b/source/_components/sensor.nest_weather.markdown index f2d7823055..971e72cb16 100644 --- a/source/_components/sensor.nest_weather.markdown +++ b/source/_components/sensor.nest_weather.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Nest Weather Sensor" -description: "Instructions how to integrate Nest sensors within Home Assistant." +description: "Instructions on how to integrate Nest sensors within Home Assistant." date: 2016-01-13 19:59 sidebar: true comments: false diff --git a/source/_components/sensor.netatmo.markdown b/source/_components/sensor.netatmo.markdown index 14e71e985f..856ccc0ec4 100644 --- a/source/_components/sensor.netatmo.markdown +++ b/source/_components/sensor.netatmo.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Netatmo Sensor" -description: "Instructions how to integrate Netatmo sensors into Home Assistant." +description: "Instructions on how to integrate Netatmo sensors into Home Assistant." date: 2016-06-23 11:10 sidebar: true comments: false diff --git a/source/_components/sensor.netdata.markdown b/source/_components/sensor.netdata.markdown index 70df53e9c5..4cd3157c19 100644 --- a/source/_components/sensor.netdata.markdown +++ b/source/_components/sensor.netdata.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Netdata" -description: "Instructions how to integrate Netdata within Home Assistant." +description: "Instructions on how to integrate Netdata within Home Assistant." date: 2016-12-05 07:00 sidebar: true comments: false diff --git a/source/_components/sensor.neurio_energy.markdown b/source/_components/sensor.neurio_energy.markdown index dd6cac4ca7..03f9c22b58 100644 --- a/source/_components/sensor.neurio_energy.markdown +++ b/source/_components/sensor.neurio_energy.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Neurio" -description: "Instructions how to integrate Neurio within Home Assistant." +description: "Instructions on how to integrate Neurio within Home Assistant." date: 2016-02-15 21:50 sidebar: true comments: false diff --git a/source/_components/sensor.nzbget.markdown b/source/_components/sensor.nzbget.markdown index ad05e14fd0..cb3b45fc5a 100644 --- a/source/_components/sensor.nzbget.markdown +++ b/source/_components/sensor.nzbget.markdown @@ -1,7 +1,7 @@ --- layout: page title: "NZBGet" -description: "Instructions how to integrate NZBGet within Home Assistant." +description: "Instructions on how to integrate NZBGet within Home Assistant." date: 2016-04-08 19:59 sidebar: true comments: false diff --git a/source/_components/sensor.octoprint.markdown b/source/_components/sensor.octoprint.markdown index 129660a2f8..f16fc83ffb 100644 --- a/source/_components/sensor.octoprint.markdown +++ b/source/_components/sensor.octoprint.markdown @@ -1,7 +1,7 @@ --- layout: page title: "OctoPrint Sensor" -description: "Instructions how to integrate OctoPrint sensors within Home Assistant." +description: "Instructions on how to integrate OctoPrint sensors within Home Assistant." date: 2016-05-05 08:00 sidebar: true comments: false diff --git a/source/_components/sensor.onewire.markdown b/source/_components/sensor.onewire.markdown index 045c7e2280..d8d9076f8c 100644 --- a/source/_components/sensor.onewire.markdown +++ b/source/_components/sensor.onewire.markdown @@ -1,7 +1,7 @@ --- layout: page title: "One wire Sensor" -description: "Instructions how to integrate One wire (1-wire) sensors into Home Assistant." +description: "Instructions on how to integrate One wire (1-wire) sensors into Home Assistant." date: 2017-09-15 10:10 sidebar: true comments: false @@ -25,7 +25,7 @@ Supported devices: - [DS2406/TAI-8570](https://datasheets.maximintegrated.com/en/ds/DS2406.pdf) Temperature and pressure sensor made by AAG - [DS2438/B1-R1-A](https://datasheets.maximintegrated.com/en/ds/DS2438.pdf) Temperature, pressure and humidity sensor by AAG -The 1-Wire bus can be connected directly to the IO pins of Raspberry Pi or using dedicated interface adapter (e.g [DS9490R](https://datasheets.maximintegrated.com/en/ds/DS9490-DS9490R.pdf)). +The 1-Wire bus can be connected directly to the IO pins of Raspberry Pi or using dedicated interface adapter (e.g [DS9490R](https://datasheets.maximintegrated.com/en/ds/DS9490-DS9490R.pdf)). #### Raspberry Pi setup In order to setup 1-Wire support on Raspberry Pi, you'll need to edit `/boot/config.txt` following [this documentation](https://www.waveshare.com/wiki/Raspberry_Pi_Tutorial_Series:_1-Wire_DS18B20_Sensor#Enable_1-Wire). Don't use the `mount_dir` option. @@ -37,12 +37,12 @@ When an interface adapter is used, sensors can be accessed on Linux hosts via [o This component has been modified to work with devices with multiple sensors which will cause a discontinuity in recorded values. Existing devices will receive a new ID and therefore show up as new devices. If you wish to maintain continuity it can be resolved in the database by renaming the old devices to the new names. -Connect to your database using the instructions from [home-assistant.io/docs/backend/database/](https://home-assistant.io/docs/backend/database/). Check the names of sensors: +Connect to your database using the instructions from [home-assistant.io/docs/backend/database/](/docs/backend/database/). Check the names of sensors: ```sql SELECT entity_id, COUNT(*) as count FROM states GROUP BY entity_id ORDER BY count DESC LIMIT 10; ``` -Alter the names of sensors using the following examples: +Alter the names of sensors using the following examples: ```sql UPDATE states SET entity_id='sensor._temperature' WHERE entity_id LIKE 'sensor.%' AND attributes LIKE '%\u00b0C%'; diff --git a/source/_components/sensor.openevse.markdown b/source/_components/sensor.openevse.markdown index a117ef20f4..e9df04e8da 100644 --- a/source/_components/sensor.openevse.markdown +++ b/source/_components/sensor.openevse.markdown @@ -1,7 +1,7 @@ --- layout: page title: "OpenEVSE Sensor" -description: "Instructions how to integrate a WiFi-equipped OpenEVSE Charging station with Home Assistant" +description: "Instructions on how to integrate a WiFi-equipped OpenEVSE Charging station with Home Assistant" date: 2017-02-02 22:09 sidebar: true comments: false @@ -16,10 +16,12 @@ ha_iot_class: "Local Polling" This `openevse` sensor platform pulls data from an [OpenEVSE](https://www.openevse.com/) Charging station equipped with an ESP8266-based wifi connection. +## {% linkable_title Configuration %} + To enable this sensor in your installation, add the following to your `configuration.yaml` file: ```yaml -# Example configuration.yml entry +# Example configuration.yaml entry sensor: - platform: openevse host: IP_ADDRESS diff --git a/source/_components/sensor.openhardwaremonitor.markdown b/source/_components/sensor.openhardwaremonitor.markdown index 680a5f20d6..6479aa9c9d 100644 --- a/source/_components/sensor.openhardwaremonitor.markdown +++ b/source/_components/sensor.openhardwaremonitor.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Open Hardware Monitor Sensor" -description: "Instructions how to integrate Open Hardware Monitor within Home Assistant." +description: "Instructions on how to integrate Open Hardware Monitor within Home Assistant." date: 2017-06-16 00:00:00 sidebar: true comments: false diff --git a/source/_components/sensor.openweathermap.markdown b/source/_components/sensor.openweathermap.markdown index 6f9186a6f6..48d141ddfe 100644 --- a/source/_components/sensor.openweathermap.markdown +++ b/source/_components/sensor.openweathermap.markdown @@ -1,7 +1,7 @@ --- layout: page title: "OpenWeatherMap Sensor" -description: "Instructions how to integrate OpenWeatherMap within Home Assistant." +description: "Instructions on how to integrate OpenWeatherMap within Home Assistant." date: 2015-04-25 9:06 sidebar: true comments: false diff --git a/source/_components/sensor.otp.markdown b/source/_components/sensor.otp.markdown index 2381fa180d..849f216718 100644 --- a/source/_components/sensor.otp.markdown +++ b/source/_components/sensor.otp.markdown @@ -1,7 +1,7 @@ --- layout: page title: "OTP Sensor" -description: "Instructions how to add One-Time Password (OTP) sensors into Home Assistant." +description: "Instructions on how to add One-Time Password (OTP) sensors into Home Assistant." date: 2017-07-04 07:00:00 sidebar: true comments: false @@ -27,7 +27,7 @@ sensor: Configuration variables: - **name** (*Optional*): Name of the sensor to use in the frontend. Defaults to `OTP Sensor`. -- **token** (*Required*): The shared secret you use in your OTP generator (e.g. Google Authenticator on your phone) +- **token** (*Required*): The shared secret you use in your OTP generator (e.g., Google Authenticator on your phone) ## Generating a token @@ -48,5 +48,5 @@ Token: IHEDPEBEVA2WVHB7 Copy and paste the token into your Home Assistant configuration and add it to your OTP generator. Verify that they generate the same code.

-It is vital that your system clock is correct both on your Home Assistant server and on your OTP generator device (e.g. your phone). If not, the generated codes will not match! Make sure NTP is running and syncing your time correctly before creating an issue. +It is vital that your system clock is correct both on your Home Assistant server and on your OTP generator device (e.g., your phone). If not, the generated codes will not match! Make sure NTP is running and syncing your time correctly before creating an issue.

diff --git a/source/_components/sensor.pi_hole.markdown b/source/_components/sensor.pi_hole.markdown index 809cee76ca..f0b5dedbdb 100644 --- a/source/_components/sensor.pi_hole.markdown +++ b/source/_components/sensor.pi_hole.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Pi-Hole Sensor" -description: "Instructions how to integrate REST sensors into Home Assistant." +description: "Instructions on how to integrate REST sensors into Home Assistant." date: 2016-09-03 16:30 sidebar: true comments: false diff --git a/source/_components/sensor.pilight.markdown b/source/_components/sensor.pilight.markdown index 276586c98c..2a33cc2a1d 100644 --- a/source/_components/sensor.pilight.markdown +++ b/source/_components/sensor.pilight.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Pilight Sensor" -description: "Instructions how to integrate pilight sensors within Home Assistant." +description: "Instructions on how to integrate pilight sensors within Home Assistant." date: 2016-10-08 23:21 sidebar: true comments: false @@ -14,12 +14,14 @@ ha_iot_class: depends --- -This `pilight` sensor platform for 433 MHz devices uses a value in the message payload as the sensor value. Unique identifiers (e.g. _uuid_) can be set to distinguish between multiple pilight devices. To use a pilight sensor the pilight Home Assistant hub has to be set up. +This `pilight` sensor platform for 433 MHz devices uses a value in the message payload as the sensor value. Unique identifiers (e.g., _uuid_) can be set to distinguish between multiple pilight devices. To use a pilight sensor the pilight Home Assistant hub has to be set up. + +## {% linkable_title Configuration %} To use your sensor via pilight, make sure it is [supported](https://wiki.pilight.org/doku.php/protocols) and add the following to your `configuration.yaml` file: ```yaml -# Example configuration.yml entry +# Example configuration.yaml entry sensor: - platform: pilight variable: temperature diff --git a/source/_components/sensor.postnl.markdown b/source/_components/sensor.postnl.markdown new file mode 100644 index 0000000000..3087ce4b01 --- /dev/null +++ b/source/_components/sensor.postnl.markdown @@ -0,0 +1,47 @@ +--- +layout: page +title: PostNL Sensor +description: "Instructions on how to set up PostNL sensors within Home Assistant." +date: 2017-04-22 08:00 +sidebar: true +comments: false +sharing: true +footer: true +logo: postnl.png +ha_category: Sensor +ha_release: 0.69 +ha_iot_class: "Cloud Polling" +--- + +The `postnl` platform allows one to track deliveries by [PostNL](https://www.postnl.nl) (Dutch Postal Services). To use this sensor, you need a [PostNL Account](https://jouw.postnl.nl). It is possible to add multiple accounts to your Home Assistant configuration. + +## {% linkable_title Configuration %} + +To enable this sensor, add the following lines to your `configuration.yaml`: + +```yaml +sensors: + - platform: postnl + username: POSTNL_USERNAME + password: POSTNL_PASSWORD +``` + +{% configuration %} +name: + description: Sensor name + required: false + default: "postnl" + type: string +username: + description: Account username of jouw.postnl.nl + required: true + type: string +password: + description: Account password of jouw.postnl.nl + required: true + type: string +{% endconfiguration %} + +

+This component is not affiliated with PostNL and retrieves date from the endpoints of the mobile application. Use at your own risk. +

diff --git a/source/_components/sensor.pushbullet.markdown b/source/_components/sensor.pushbullet.markdown index df04990f68..bd8ee0eda5 100644 --- a/source/_components/sensor.pushbullet.markdown +++ b/source/_components/sensor.pushbullet.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Pushbullet Mirrors" -description: "Instructions how to read user pushes in Home Assistant" +description: "Instructions on how to read user pushes in Home Assistant" date: 2017-04-20 16:44 sidebar: true comments: false diff --git a/source/_components/sensor.pvoutput.markdown b/source/_components/sensor.pvoutput.markdown index b36ded0c28..a61f661459 100644 --- a/source/_components/sensor.pvoutput.markdown +++ b/source/_components/sensor.pvoutput.markdown @@ -1,7 +1,7 @@ --- layout: page title: "PVOutput Sensor" -description: "Instructions how to use PVOutput within Home Assistant." +description: "Instructions on how to use PVOutput within Home Assistant." date: 2016-11-06 10:00 sidebar: true comments: false diff --git a/source/_components/sensor.pyload.markdown b/source/_components/sensor.pyload.markdown index c4d7611edb..0c5886b637 100644 --- a/source/_components/sensor.pyload.markdown +++ b/source/_components/sensor.pyload.markdown @@ -1,7 +1,7 @@ --- layout: page title: "pyLoad Sensor" -description: "Instructions how to integrate pyLoad download sensor within Home Assistant." +description: "Instructions on how to integrate pyLoad download sensor within Home Assistant." date: 2017-10-23 09:00 sidebar: true comments: false diff --git a/source/_components/sensor.qnap.markdown b/source/_components/sensor.qnap.markdown index 38dd16ca98..3814f37bd0 100644 --- a/source/_components/sensor.qnap.markdown +++ b/source/_components/sensor.qnap.markdown @@ -1,7 +1,7 @@ --- layout: page title: "QNAP Sensor" -description: "Instructions how to integrate the QNAP sensor within Home Assistant." +description: "Instructions on how to integrate the QNAP sensor within Home Assistant." date: 2017-02-02 06:39 sidebar: true comments: false @@ -16,10 +16,12 @@ ha_iot_class: "Local Polling" This `qnap` sensor allows getting various statistics from your [QNAP NAS](https://www.qnap.com/en-us/). +## {% linkable_title Configuration %} + To use the `qnap` sensor in your installation, add the following to your `configuration.yaml` file: ```yaml -# Example configuration.yml entry +# Example configuration.yaml entry sensor: - platform: qnap host: IP_ADDRESS_OF_QNAP_NAS diff --git a/source/_components/sensor.qwikswitch.markdown b/source/_components/sensor.qwikswitch.markdown new file mode 100644 index 0000000000..afc4fc6cb4 --- /dev/null +++ b/source/_components/sensor.qwikswitch.markdown @@ -0,0 +1,18 @@ +--- +layout: page +title: "QwikSwitch Sensor" +description: "Instructions on how to integrate Qwikswitch dimmers and relays as sensors into Home Assistant." +date: 2016-05-04 00:00 +sidebar: true +comments: false +sharing: true +footer: true +logo: qwikswitch.png +ha_category: Sensor +ha_iot_class: "Local Push" +ha_release: "0.67" +--- + +The `qwikswitch` sensor platform allows you to use your [QwikSwitch](http://www.qwikswitch.co.za/) sensors in Home Assistant. + +The platform is configured through the [QwikSwitch component](/components/qwikswitch/). diff --git a/source/_components/sensor.radarr.markdown b/source/_components/sensor.radarr.markdown index 78ca33d041..94a4665548 100644 --- a/source/_components/sensor.radarr.markdown +++ b/source/_components/sensor.radarr.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Radarr Sensor" -description: "Instructions how to integrate Radarr sensors with Home Assistant" +description: "Instructions on how to integrate Radarr sensors with Home Assistant" date: 2017-05-04 00:00 sidebar: true comments: false @@ -15,10 +15,12 @@ ha_release: 0.47 This `radarr` sensor platform pulls data from a given [Radarr](https://radarr.video/) instance. +## {% linkable_title Configuration %} + To use your Radarr sensor in your installation, add the following to your `configuration.yaml` file: ```yaml -# Example configuration.yml entry +# Example configuration.yaml entry sensor: - platform: radarr api_key: YOUR_API_KEY diff --git a/source/_components/sensor.random.markdown b/source/_components/sensor.random.markdown index c7f2bf07b1..cbe6049cf3 100644 --- a/source/_components/sensor.random.markdown +++ b/source/_components/sensor.random.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Random Sensor" -description: "Instructions how to integrate random number sensors into Home Assistant." +description: "Instructions on how to integrate random number sensors into Home Assistant." date: 2016-10-30 12:10 sidebar: true comments: false @@ -16,6 +16,8 @@ ha_release: 0.32 The `random` sensor platform is creating random sensor values (integers) out of a given range. Returned values form a [discrete uniform distribution](https://en.wikipedia.org/wiki/Discrete_uniform_distribution), meaning that each integer value in the range configured is equally likely to be drawn. This can be useful if you want to test automation rules. It generates a new value every time it is polled. +## {% linkable_title Configuration %} + To enable the random sensor, add the following lines to your `configuration.yaml`: ```yaml @@ -48,4 +50,4 @@ unit_of_measurement: See the [entity component options][entity-docs] to control how often the main component polls the random sensor. The default is 30 seconds. -[entity-docs]: https://home-assistant.io/docs/configuration/platform_options/ +[entity-docs]: /docs/configuration/platform_options/ diff --git a/source/_components/sensor.rest.markdown b/source/_components/sensor.rest.markdown index 7d8c751313..0c0cc9a7ab 100644 --- a/source/_components/sensor.rest.markdown +++ b/source/_components/sensor.rest.markdown @@ -1,7 +1,7 @@ --- layout: page title: "RESTful Sensor" -description: "Instructions how to integrate REST sensors into Home Assistant." +description: "Instructions on how to integrate REST sensors into Home Assistant." date: 2015-09-14 19:10 sidebar: true comments: false @@ -151,7 +151,7 @@ sensor: unit_of_measurement: "°C" ``` -### {% linkable_title Accessing a HTTP authentication protected endpoint %} +### {% linkable_title Accessing an HTTP authentication protected endpoint %} The REST sensor supports HTTP authentication and customized headers. diff --git a/source/_components/sensor.rflink.markdown b/source/_components/sensor.rflink.markdown index 38b529af80..7efee12d68 100644 --- a/source/_components/sensor.rflink.markdown +++ b/source/_components/sensor.rflink.markdown @@ -1,7 +1,7 @@ --- layout: page title: "RFLink Sensor" -description: "Instructions how to integrate RFLink sensors into Home Assistant." +description: "Instructions on how to integrate RFLink sensors into Home Assistant." date: 2016-01-04 sidebar: true comments: false diff --git a/source/_components/sensor.rfxtrx.markdown b/source/_components/sensor.rfxtrx.markdown index 9df49ee684..91a2dd5cf1 100644 --- a/source/_components/sensor.rfxtrx.markdown +++ b/source/_components/sensor.rfxtrx.markdown @@ -1,7 +1,7 @@ --- layout: page title: "RFXtrx Sensor" -description: "Instructions how to integrate RFXtrx sensors into Home Assistant." +description: "Instructions on how to integrate RFXtrx sensors into Home Assistant." date: 2015-08-06 17:15 sidebar: true comments: false diff --git a/source/_components/sensor.ripple.markdown b/source/_components/sensor.ripple.markdown index ad960c30e5..2eda541505 100644 --- a/source/_components/sensor.ripple.markdown +++ b/source/_components/sensor.ripple.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Ripple" -description: "Instructions how to integrate ripple.com data within Home Assistant." +description: "Instructions on how to integrate ripple.com data within Home Assistant." date: 2017-06-06 16:20 sidebar: true comments: false diff --git a/source/_components/sensor.sabnzbd.markdown b/source/_components/sensor.sabnzbd.markdown index 47680c4e1a..27766435fd 100644 --- a/source/_components/sensor.sabnzbd.markdown +++ b/source/_components/sensor.sabnzbd.markdown @@ -1,7 +1,7 @@ --- layout: page title: "SABnzbd" -description: "Instructions how to integrate SABnzbd within Home Assistant." +description: "Instructions on how to integrate SABnzbd within Home Assistant." date: 2015-03-23 19:59 sidebar: true comments: false @@ -68,7 +68,7 @@ Note that this will create the following sensors: - sensor.sabnzbd_left - sensor.sabnzbd_disk - sensor.sabnzbd_disk_free - - sensor.sabnzdb_queue_count + - sensor.sabnzbd_queue_count ``` As always, you can determine the names of sensors by looking at the dev-state page `< >` in the web interface. diff --git a/source/_components/sensor.scrape.markdown b/source/_components/sensor.scrape.markdown index cbbaf5553e..047dd0e956 100644 --- a/source/_components/sensor.scrape.markdown +++ b/source/_components/sensor.scrape.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Scrape Sensor" -description: "Instructions how to integrate Web scrape sensors into Home Assistant." +description: "Instructions on how to integrate Web scrape sensors into Home Assistant." date: 2016-10-12 09:10 sidebar: true comments: false @@ -22,7 +22,7 @@ To enable this sensor, add the following lines to your `configuration.yaml` file # Example configuration.yaml entry sensor: - platform: scrape - resource: https://home-assistant.io + resource: https://www.home-assistant.io select: ".current-version h1" ``` @@ -43,14 +43,14 @@ In this section you find some real life examples of how to use this sensor. Ther ### {% linkable_title Home Assistant %} -The current release Home Assistant is published on [https://home-assistant.io/](https://home-assistant.io/) +The current release Home Assistant is published on [https://www.home-assistant.io/](/) {% raw %} ```yaml sensor: # Example configuration.yaml entry - platform: scrape - resource: https://home-assistant.io + resource: https://www.home-assistant.io name: Release select: ".current-version h1" value_template: '{{ value.split(":")[1] }}' @@ -66,7 +66,7 @@ Get the counter for all our implementations from the [Component overview](/compo # Example configuration.yaml entry sensor: - platform: scrape - resource: https://home-assistant.io/components/ + resource: https://www.home-assistant.io/components/ name: Home Assistant impl. select: 'a[href="#all"]' value_template: '{{ value.split("(")[1].split(")")[0] }}' diff --git a/source/_components/sensor.season.markdown b/source/_components/sensor.season.markdown index 6297420cd1..875636fb7c 100644 --- a/source/_components/sensor.season.markdown +++ b/source/_components/sensor.season.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Season Sensor" -description: "Instructions how to add season sensors into Home Assistant." +description: "Instructions on how to add season sensors into Home Assistant." date: 2017-07-04 07:00:00 sidebar: true comments: false diff --git a/source/_components/sensor.sense.markdown b/source/_components/sensor.sense.markdown index cefa2adcbb..e13e45dd93 100644 --- a/source/_components/sensor.sense.markdown +++ b/source/_components/sensor.sense.markdown @@ -1,7 +1,7 @@ --- layout: page title: Sense -description: "Instructions how to integrate Sense within Home Assistant." +description: "Instructions on how to integrate Sense within Home Assistant." date: 2018-01-11 13:50 sidebar: true comments: false diff --git a/source/_components/sensor.sensehat.markdown b/source/_components/sensor.sensehat.markdown index ae270f052f..fb3447acd5 100644 --- a/source/_components/sensor.sensehat.markdown +++ b/source/_components/sensor.sensehat.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Sense HAT" -description: "Instructions how to integrate Sense HAT within Home Assistant." +description: "Instructions on how to integrate Sense HAT within Home Assistant." date: 2017-06-03 04:00 sidebar: true comments: false @@ -35,7 +35,7 @@ Configuration variables: - 'humidity' - 'pressure' is_hat_attached (Optional): True|False boolean; Default value is True declaring that the SenseHAT _is_ physically on the Raspberry Pi - + #### Customizing the Sense HAT data @@ -145,10 +145,10 @@ These issues have been discussed in the repository issue (#5093)[https://github. This fix has been tested with a clean install of: -* [Raspbian Jessie - version January 2017](https://downloads.raspberrypi.org/raspbian/images/raspbian-2017-01-10/) - +* [Raspbian Jessie - version January 2017](https://downloads.raspberrypi.org/raspbian/images/raspbian-2017-01-10/) + and - -* [Home-Assistant 0.37.1](https://home-assistant.io/getting-started/installation-raspberry-pi-all-in-one/) + +* [Home-Assistant 0.37.1](/getting-started/installation-raspberry-pi-all-in-one/) For setting up the Sense HAT's RGB LED matrix as lights within Home Assistant, please see the [Sense HAT light component](/components/light.sensehat/). diff --git a/source/_components/sensor.serial.markdown b/source/_components/sensor.serial.markdown index ea1ad91a0b..356ced350f 100644 --- a/source/_components/sensor.serial.markdown +++ b/source/_components/sensor.serial.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Serial Sensor" -description: "Instructions how to integrate data from serial connected sensors into Home Assistant." +description: "Instructions on how to integrate data from serial connected sensors into Home Assistant." date: 2017-10-13 07:00 sidebar: true comments: false diff --git a/source/_components/sensor.shodan.markdown b/source/_components/sensor.shodan.markdown index e4ca7947a2..6a98ad3042 100644 --- a/source/_components/sensor.shodan.markdown +++ b/source/_components/sensor.shodan.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Shodan Sensor" -description: "Instructions how to integrate Shodan sensors into Home Assistant." +description: "Instructions on how to integrate Shodan sensors into Home Assistant." date: 2017-08-09 10:30 sidebar: true comments: false diff --git a/source/_components/sensor.sht31.markdown b/source/_components/sensor.sht31.markdown new file mode 100644 index 0000000000..7adbfc2cee --- /dev/null +++ b/source/_components/sensor.sht31.markdown @@ -0,0 +1,54 @@ +--- +layout: page +title: "Sensirion SHT31 Sensor" +description: "Instructions on how to integrate SHT31 sensors within Home Assistant." +date: 2018-03-06 19:15 +sidebar: true +comments: false +sharing: true +footer: true +ha_category: DIY +ha_release: 0.68 +logo: sensirion.png +ha_iot_class: "Local Polling" +--- + +The `sht31` sensor platform allows you to get the current temperature and humidity from a Sensirion SHT31 device. + +## {% linkable_title Configuration %} + +To use your SHT31 sensor in your installation, add the following to your `configuration.yaml` file: + +```yaml +# Example configuration.yaml entry +sensor: + platform: sht31 + name: Bedroom + i2c_address: 0x44 + monitored_conditions: + - temperature + - humidity +``` + +{% configuration %} + name: + description: The name of the sensor. Temperature and Humidity will be added to the name for the sensor name. + required: false + default: SHT31 + type: string + i2c_address: + description: I2C address of the sensor. + required: false + default: "`0x44`" + type: int + monitored_conditions: + description: Conditions to monitor. + required: false + default: All conditions + type: list + keys: + temperature: + description: The current temperature of the SHT31. + humidity: + description: The current humidity of the SHT31. +{% endconfiguration %} diff --git a/source/_components/sensor.sigfox.markdown b/source/_components/sensor.sigfox.markdown new file mode 100644 index 0000000000..f3f0bbb0ea --- /dev/null +++ b/source/_components/sensor.sigfox.markdown @@ -0,0 +1,47 @@ +--- +layout: page +title: "Sigfox Sensor" +description: "Display messages from Sigfox devices in Home Assistant." +date: 2018-04-07 12:10 +sidebar: true +comments: false +sharing: true +footer: true +logo: sigfox.png +ha_category: Sensor +ha_iot_class: "Local Polling" +ha_release: 0.68 +--- + +[SigFox](https://www.sigfox.com/en) component adding a sensor for each Sigfox device registered with your account. The default name of sensors is `sigfox_{DEVICE_ID}` where `DEVICE_ID` is the devices Sigfox ID. The state of an added Sigfox sensor is the payload of the last message published by that device. Additionally, there are attributes for the latitude and longitude coordinates of the device, as well as the signal-to-noise ratio ( [snr](https://en.wikipedia.org/wiki/Signal-to-noise_ratio)). + +```yaml +# Example configuration.yaml entry +sensor: + - platform: sigfox + api_login: your_api_login + api_password: your_api_password +``` + +{% configuration %} +api_login: + description: Your Sigfox API login. + required: true + type: string +api_password: + description: Your Sigfox API password. + required: true + type: string +name: + description: The name to prepend to the device ID. + required: false + default: "sigfox" + type: string +{% endconfiguration %} + +Note that `your_api_login` and `your_api_password` are your **API access credentials** which can be accessed by following: + +1. Log into [Sigfox backend](https://backend.sigfox.com) +1. Select `GROUP` +1. Select `API ACCESS` +1. Click on `new` and create new access entry diff --git a/source/_components/sensor.sma.markdown b/source/_components/sensor.sma.markdown index b2c9bfdcd1..f3eb166564 100644 --- a/source/_components/sensor.sma.markdown +++ b/source/_components/sensor.sma.markdown @@ -16,14 +16,16 @@ ha_release: 0.36 The `sma` sensor will poll a [SMA](http://www.sma-solar.com/) [(US)](http://www.sma-america.com/) solar inverter and present the values as sensors (or attributes of sensors) in Home Assistant. +## {% linkable_title Configuration %} + To enable this sensor, add the following lines to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry sensor sma: - platform: sma - host: 192.168.88.199 - password: !secret sma_password + host: IP_ADDRESS_OF_DEVICE + password: YOUR_SMA_PASSWORD sensors: current_consumption: [total_consumption] current_power: diff --git a/source/_components/sensor.smappee.markdown b/source/_components/sensor.smappee.markdown index 6a34cfb5c5..2886f2b434 100644 --- a/source/_components/sensor.smappee.markdown +++ b/source/_components/sensor.smappee.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Smappee Sensor" -description: "Instructions how to integrate Smappee energy monitor into Home Assistant." +description: "Instructions on how to integrate Smappee energy monitor into Home Assistant." date: 2018-02-26 08:37 sidebar: true comments: false diff --git a/source/_components/sensor.snmp.markdown b/source/_components/sensor.snmp.markdown index 95429545db..f492d5ef3a 100644 --- a/source/_components/sensor.snmp.markdown +++ b/source/_components/sensor.snmp.markdown @@ -1,7 +1,7 @@ --- layout: page title: "SNMP" -description: "Instructions how to integrate SNMP sensors within Home Assistant." +description: "Instructions on how to integrate SNMP sensors within Home Assistant." date: 2016-06-05 20:00 sidebar: true comments: false diff --git a/source/_components/sensor.sochain.markdown b/source/_components/sensor.sochain.markdown index 77bf1c7836..26ff8d5fd1 100644 --- a/source/_components/sensor.sochain.markdown +++ b/source/_components/sensor.sochain.markdown @@ -1,7 +1,7 @@ --- layout: page title: "SoChain" -description: "Instructions how to integrate chain.so data within Home Assistant." +description: "Instructions on how to integrate chain.so data within Home Assistant." date: 2017-06-01 16:20 sidebar: true comments: false diff --git a/source/_components/sensor.socialblade.markdown b/source/_components/sensor.socialblade.markdown new file mode 100644 index 0000000000..cf106c9133 --- /dev/null +++ b/source/_components/sensor.socialblade.markdown @@ -0,0 +1,37 @@ +--- +layout: page +title: Social Blade Sensor +description: "Instructions on how to set up Social Blade Sensor within Home Assistant." +date: 2018-04-23 08:00 +sidebar: false +comments: false +sharing: true +footer: true +logo: socialblade.png +ha_category: Sensor +ha_release: 0.69 +ha_iot_class: "Cloud Polling" +--- + +The `socialblade` sensor component allows you get updates on a youtube channel using your social blade channel id. The sensor gets the subscribers and total views count from [Social Blade Website]( https://socialblade.com/) + +to get the channel id you can go to [Social Blade Website]( https://socialblade.com/) and search for youtube channel by username, then select the channel and grab the id from the url. +The channel id will be the last part of the url : +https://socialblade.com/youtube/channel/{channel_id} + +## Example for `configuration.yaml` : + +```yaml +sensor: + - platform: socialblade + channel_id: YOUR_CHANNEL_NUMBER +``` + +{% configuration %} +channel_id: + description: channel id number optained from the URL when you access Social Blade web client. + required: true + type: string +{% endconfiguration %} + +All the data will be fetch from [Social Blade]( https://socialblade.com/). diff --git a/source/_components/sensor.sonarr.markdown b/source/_components/sensor.sonarr.markdown index 5f4d437c02..13a4944fea 100644 --- a/source/_components/sensor.sonarr.markdown +++ b/source/_components/sensor.sonarr.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Sonarr Sensor" -description: "Instructions how to integrate Sonarr sensors with Home Assistant" +description: "Instructions on how to integrate Sonarr sensors with Home Assistant" date: 2016-11-19 13:35 sidebar: true comments: false @@ -16,10 +16,12 @@ ha_iot_class: "Local Polling" This `sonarr` sensor platform pulls data from a given [Sonarr](https://sonarr.tv/) instance. +## {% linkable_title Configuration %} + To use your Sonarr sensor in your installation, add the following to your `configuration.yaml` file: ```yaml -# Example configuration.yml entry +# Example configuration.yaml entry sensor: - platform: sonarr api_key: YOUR_API_KEY diff --git a/source/_components/sensor.speedtest.markdown b/source/_components/sensor.speedtest.markdown index f3fe80903d..fb95a0cdff 100644 --- a/source/_components/sensor.speedtest.markdown +++ b/source/_components/sensor.speedtest.markdown @@ -16,13 +16,14 @@ ha_iot_class: "Cloud Polling" The `speedtest` sensor component uses the [Speedtest.net](https://speedtest.net/) web service to measure network bandwidth performance. +## {% linkable_title Configuration %} + By default, it will run every hour. The user can change the update frequency in the configuration by defining the minute, hour, and day for a speed test to run. For the `server_id` check the list of [available servers](https://www.speedtest.net/speedtest-servers.php). To add a Speedtest.net sensor to your installation, add the following to your `configuration.yaml` file: Once per hour, on the hour (default): -{% raw %} ```yaml # Example configuration.yaml entry sensor: @@ -32,7 +33,6 @@ sensor: - download - upload ``` -{% endraw %} {% configuration %} monitored_conditions: @@ -79,7 +79,6 @@ This component uses [speedtest-cli](https://github.com/sivel/speedtest-cli) to g When Home Assistant first starts up, the values of the speed test will show as `Unknown`. You can use the service `sensor.update_speedtest` to run a manual speed test and populate the data or just wait for the next regularly scheduled test. You can turn on manual mode to disable the scheduled speed tests. - ## {% linkable_title Examples %} In this section, you find some real-life examples of how to use this sensor. @@ -88,7 +87,6 @@ In this section, you find some real-life examples of how to use this sensor. Every half hour of every day: -{% raw %} ```yaml # Example configuration.yaml entry sensor: @@ -101,13 +99,11 @@ sensor: - download - upload ``` -{% endraw %} ### {% linkable_title Run at a specific time %} Everyday at 12:30AM, 6:30AM, 12:30PM, 6:30PM: -{% raw %} ```yaml # Example configuration.yaml entry sensor: @@ -123,7 +119,6 @@ sensor: - download - upload ``` -{% endraw %} ### {% linkable_title Using as a trigger in an automation %} @@ -150,6 +145,7 @@ automation: ## {% linkable_title Notes %} - When running on Raspberry Pi, just note that the maximum speed is limited by its 100 Mbit/s LAN adapter. +- Running this platform can have negative effects on the system's performance as it requires a fair amount of memory. - Entries under `monitored_conditions` only control what entities are available in Home Assistant, it does not disable the condition from running. - If ran frequently, this component has the ability to use a considerable amount of data. Frequent updates should be avoided on bandwidth-capped connections. - While running, your network capacity is fully utilized. This may have a negative effect on other devices in use the network such as gaming consoles or streaming boxes. diff --git a/source/_components/sensor.spotcrime.markdown b/source/_components/sensor.spotcrime.markdown index 98e2b7ee40..b36d01b4b4 100644 --- a/source/_components/sensor.spotcrime.markdown +++ b/source/_components/sensor.spotcrime.markdown @@ -8,13 +8,13 @@ comments: false sharing: true footer: true ha_category: Sensor -ha_release: 0.64 +ha_release: 0.65 ha_iot_class: "Cloud Polling" --- The `spotcrime` sensor allows one to track reported incidents occurring in a given area. Incidents include anything reported to [Spot Crime](http://spotcrime.com). Your regional emergency services may or may not report data. The sensor defaults to counting incidents within one day, but can be customized via configuration.yaml. -## Configuration +You will need to request an API key from [Spotcrime](mailto:pyrrhus@spotcrime.com). To enable this sensor, add the following lines to your `configuration.yaml`. Your `radius` should be of sufficient size to capture incidents in your area. 0.01 = 1 mile. @@ -23,23 +23,39 @@ sensor: - platform: spotcrime name: radius: - days: + api_key: <"your_api_key_here"> ``` -Configuration options for the Crime Reports Sensor: +{% configuration %} +name: + description: Name the sensor what you'd like. + required: true + type: string +radius: + description: Radius you'd like to search within. 0.01 = 1 mile. + required: true + type: float +api_key: + description: The API key to access the service. + required: true + type: string +days: + description: Number of days you'd like see to crime statistics for. + required: false + type: int +include: + description: Event types you want statistics for. + required: false + type: list +exclude: + description: Event types to ignore statistics for. + required: false + type: list +{% endconfiguration %} -- **name** (*Required*): Name the sensor whatever you want. -- **radius** (*Required*): Radius in miles. -- **days** (*Optional*): Defaults to 1 day. -- **latitude** (*Optional*): Defaults to your home zone latitude. -- **longitude** (*Optional*): Defaults to your home zone longitude. -- **include** (*Optional*): List of incident types to include. -- **exclude** (*Optional*): List of incident types to exclude. +## {% linkable_title Notes %} - -## Notes - -### Incident Types +### {% linkable_title Incident Types %} You can explicitly include or exclude incident types. Specifying `include`s restricts the incidents to those types. Specifying `exclude`s will return all incident types except those specified. @@ -55,6 +71,6 @@ These incident types are available: - Vandalism - Other -### Events +### {% linkable_title Events %} The `crimealerts` sensor fires a `crimealerts_incident` event when a new incident is detected, including the type, time, and location of the incident. diff --git a/source/_components/sensor.sql.md b/source/_components/sensor.sql.md index 28ec379788..e676ca9d43 100644 --- a/source/_components/sensor.sql.md +++ b/source/_components/sensor.sql.md @@ -37,7 +37,7 @@ sensor: db_url: description: The URL which points to your database. See [supported engines](/components/recorder/#custom-database-engines). required: false - default: Defaults to the recorder db_url. + default: "Defaults to the default recorder `db_url` (not the current `db_url` of recorder)." type: string queries: description: List of your queries. diff --git a/source/_components/sensor.statistics.markdown b/source/_components/sensor.statistics.markdown index a5b126fac4..9bfd40dd39 100644 --- a/source/_components/sensor.statistics.markdown +++ b/source/_components/sensor.statistics.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Statistics Sensor" -description: "Instructions how to integrate statistical sensors into Home Assistant." +description: "Instructions on how to integrate statistical sensors into Home Assistant." date: 2016-09-28 12:10 sidebar: true comments: false diff --git a/source/_components/sensor.supervisord.markdown b/source/_components/sensor.supervisord.markdown index 93a191fc9c..fc978f2f2d 100644 --- a/source/_components/sensor.supervisord.markdown +++ b/source/_components/sensor.supervisord.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Supervisord" -description: "Instructions how to integrate Supervisord within Home Assistant." +description: "Instructions on how to integrate Supervisord within Home Assistant." date: 2016-05-13 22:00 sidebar: true comments: false diff --git a/source/_components/sensor.swiss_hydrological_data.markdown b/source/_components/sensor.swiss_hydrological_data.markdown index 59f81644e2..44f4d6100b 100644 --- a/source/_components/sensor.swiss_hydrological_data.markdown +++ b/source/_components/sensor.swiss_hydrological_data.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Swiss Hydrological Data" -description: "Instructions how to integrate hydrological data of Swiss waters within Home Assistant." +description: "Instructions on how to integrate hydrological data of Swiss waters within Home Assistant." date: 2016-06-17 17:00 sidebar: true comments: false diff --git a/source/_components/sensor.swiss_public_transport.markdown b/source/_components/sensor.swiss_public_transport.markdown index 8b3ac28b09..c1063e4d4a 100644 --- a/source/_components/sensor.swiss_public_transport.markdown +++ b/source/_components/sensor.swiss_public_transport.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Swiss Public Transport" -description: "Instructions how to integrate timetable data for traveling in Switzerland within Home Assistant." +description: "Instructions on how to integrate timetable data for traveling in Switzerland within Home Assistant." date: 2015-06-02 21:45 sidebar: true comments: false diff --git a/source/_components/sensor.syncthru.markdown b/source/_components/sensor.syncthru.markdown new file mode 100644 index 0000000000..19b2e5d139 --- /dev/null +++ b/source/_components/sensor.syncthru.markdown @@ -0,0 +1,89 @@ +--- +layout: page +title: "Samsung SyncThru Printer" +description: "Instructions on how to integrate a Samsung printer providing SyncThru within Home Assistant." +date: 2018-02-19 23:33 +sidebar: true +comments: false +sharing: true +footer: true +logo: samsung.png +ha_category: Sensor +ha_iot_class: "Local Polling" +ha_release: 0.66 +--- + +The Samsung SyncThru Printer platform allows you to read current data from your local Samsung printer. + +It usually provides information about the device's state, the left amount of ink or toner and the state of paper trays. +The platform automatically monitors every supported part. + +If you wish not to include certain monitored values specify the values that you would like to see in the front-end via the `monitored_conditions` setting. + +```yaml +# Example configuration.yaml entry +sensor: + - platform: syncthru + resource: http://my-printer.address + name: My Awesome Printer + monitored_conditions: + - toner_black + - output_tray_0 +``` + +{% configuration %} + resource: + description: The address for connecting to the printer. Equal to the SyncThru Webservice address. + required: true + default: false + type: url + name: + description: A user specified name for the printer. Defaults to "Samsung Printer" and the friendly name will be the name of the printer model. + required: false + default: Samsung Printer + type: string + monitored_conditions: + description: Conditions to display in the frontend. + required: false + default: all values + type: list + keys: + toner_black: + description: Black toner fill level + toner_cyan: + description: Cyan toner fill level + toner_magenta: + description: Magenta toner fill level + toner_yellow: + description: Yellow toner fill level + drum_black: + description: Black drum state + drum_cyan: + description: Cyan drum state + drum_magenta: + description: Magenta drum state + drum_yellow: + description: Yellow drum state + tray_1: + description: First paper input tray state + tray_2: + description: Second paper input tray state + tray_3: + description: Third paper input tray state + tray_4: + description: Fourth paper input tray state + tray_5: + description: Fifth paper input tray state + output_tray_0: + description: First paper output tray state + output_tray_1: + description: Second paper output tray state + output_tray_2: + description: Third paper output tray state + output_tray_3: + description: Fourth paper output tray state + output_tray_4: + description: Fifth paper output tray state + output_tray_5: + description: Sixth paper output tray state +{% endconfiguration %} diff --git a/source/_components/sensor.synologydsm.markdown b/source/_components/sensor.synologydsm.markdown index bf7a0af0d0..0b4b4ba197 100644 --- a/source/_components/sensor.synologydsm.markdown +++ b/source/_components/sensor.synologydsm.markdown @@ -1,7 +1,7 @@ --- layout: page title: "SynologyDSM Sensor" -description: "Instructions how to integrate the SynologyDSM sensor within Home Assistant." +description: "Instructions on how to integrate the SynologyDSM sensor within Home Assistant." date: 2016-10-30 23:21 sidebar: true comments: false @@ -14,17 +14,19 @@ ha_iot_class: "Local Polling" --- -This `synologydsm` sensor allows getting various statistics from your [Synology NAS](https://www.synology.com). +The `synologydsm` sensor platform allows getting various statistics from your [Synology NAS](https://www.synology.com). + +## {% linkable_title Configuration %} To use the `synologydsm` sensor in your installation, add the following to your `configuration.yaml` file: ```yaml -# Example configuration.yml entry +# Example configuration.yaml entry sensor: - platform: synologydsm host: IP_ADDRESS_OF_SYNOLOGY_NAS - username: USERNAME - password: PASSWORD + username: YOUR_USERNAME + password: YOUR_PASSWORD monitored_conditions: - cpu_total_load - memory_real_usage @@ -33,7 +35,7 @@ sensor: Configuration variables: -- **host** (*Required*): The IP address of the Synology NAS to monitor +- **host** (*Required*): The IP address of the Synology NAS to monitor. - **port** (*Optional*): The port number on which the Synology NAS is reachable. Defaults to `5000`. - **username** (*Required*): An user to connect to the Synology NAS (a separate account is advised, see the Separate User Configuration section below for details). - **password** (*Required*): The password of the user to connect to the Synology NAS. diff --git a/source/_components/sensor.systemmonitor.markdown b/source/_components/sensor.systemmonitor.markdown index 9ae17d80ba..855dca71c0 100644 --- a/source/_components/sensor.systemmonitor.markdown +++ b/source/_components/sensor.systemmonitor.markdown @@ -1,7 +1,7 @@ --- layout: page title: "System Monitor" -description: "Instructions how to monitor the Home Assistant host." +description: "Instructions on how to monitor the Home Assistant host." date: 2015-03-23 19:59 sidebar: true comments: false @@ -56,7 +56,7 @@ The table contains types and their argument to use in your `configuration.yaml` | ipv4_address | Interface, eg. `eth0` | | ipv6_address | Interface, eg. `eth0` | | processor_use | | -| process | Binary, e.g. `octave-cli` | +| process | Binary, e.g., `octave-cli` | | last_boot | | | since_last_boot | | diff --git a/source/_components/sensor.sytadin.markdown b/source/_components/sensor.sytadin.markdown index 9f23c8df3f..1c44a9bdd3 100644 --- a/source/_components/sensor.sytadin.markdown +++ b/source/_components/sensor.sytadin.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Sytadin Sensor" -description: "Instructions how to integrate Sytadin sensors into Home Assistant." +description: "Instructions on how to integrate Sytadin sensors into Home Assistant." date: 2017-10-05 14:00 sidebar: true comments: false diff --git a/source/_components/sensor.tahoma.markdown b/source/_components/sensor.tahoma.markdown index 7a2b960de8..d5dbf0530e 100644 --- a/source/_components/sensor.tahoma.markdown +++ b/source/_components/sensor.tahoma.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Tahoma Sensor" -description: "Instructions how to integrate Tahoma sensors into Home Assistant." +description: "Instructions on how to integrate Tahoma sensors into Home Assistant." date: 2017-07-18 12:00 sidebar: true comments: false diff --git a/source/_components/sensor.tellduslive.markdown b/source/_components/sensor.tellduslive.markdown index 356ba316b5..4e136af476 100644 --- a/source/_components/sensor.tellduslive.markdown +++ b/source/_components/sensor.tellduslive.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Telldus Live sensor" -description: "Instructions how to integrate Telldus Live sensors into Home Assistant." +description: "Instructions on how to integrate Telldus Live sensors into Home Assistant." date: 2016-01-17 15:49 sidebar: true comments: false diff --git a/source/_components/sensor.tellstick.markdown b/source/_components/sensor.tellstick.markdown index dc4cf5be79..c980118ed4 100644 --- a/source/_components/sensor.tellstick.markdown +++ b/source/_components/sensor.tellstick.markdown @@ -1,7 +1,7 @@ --- layout: page title: "TellStick Sensor" -description: "Instructions how to integrate TellStick sensors into Home Assistant." +description: "Instructions on how to integrate TellStick sensors into Home Assistant." date: 2015-08-06 19:00 sidebar: true comments: false @@ -16,7 +16,7 @@ ha_iot_class: "Local Polling" The `tellstick` sensor platform allows you to get current meteorological data from a [TellStick](http://www.telldus.se/products/tellstick) device. -To use your TellStick device, you first have to set up your [Tellstick hub](https://home-assistant.io/components/tellstick/) and then add the following to your `configuration.yaml` file: +To use your TellStick device, you first have to set up your [Tellstick hub](/components/tellstick/) and then add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry diff --git a/source/_components/sensor.temper.markdown b/source/_components/sensor.temper.markdown index 227cc42f80..09626f0984 100644 --- a/source/_components/sensor.temper.markdown +++ b/source/_components/sensor.temper.markdown @@ -1,7 +1,7 @@ --- layout: page title: "TEMPer Sensor" -description: "Instructions how to integrate TEMPer sensors into Home Assistant." +description: "Instructions on how to integrate TEMPer sensors into Home Assistant." date: 2015-08-06 19:00 sidebar: true comments: false diff --git a/source/_components/sensor.template.markdown b/source/_components/sensor.template.markdown index 534fe54e9f..8ef5a5dc44 100644 --- a/source/_components/sensor.template.markdown +++ b/source/_components/sensor.template.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Template Sensor" -description: "Instructions how to integrate Template Sensors into Home Assistant." +description: "Instructions on how to integrate Template Sensors into Home Assistant." date: 2016-01-27 07:00 sidebar: true comments: false @@ -69,6 +69,11 @@ sensor: description: Defines a template for the entity picture of the sensor. required: false type: template + device_class: + description: The type/class of the sensor to set the icon in the frontend. + required: false + type: device_class + default: None {% endconfiguration %} ## {% linkable_title Considerations %} diff --git a/source/_components/sensor.thethingsnetwork.markdown b/source/_components/sensor.thethingsnetwork.markdown index 6dac17958f..faeb8b7e65 100644 --- a/source/_components/sensor.thethingsnetwork.markdown +++ b/source/_components/sensor.thethingsnetwork.markdown @@ -1,7 +1,7 @@ --- layout: page title: "The Things Network Sensor" -description: "Instructions how to integrate The Things Network sensors into Home Assistant." +description: "Instructions on how to integrate The Things Network sensors into Home Assistant." date: 2017-09-30 08:00 sidebar: true comments: false @@ -17,6 +17,8 @@ The `thethingsnetwork` sensor platform allows you to get data from a [The Things This platform requires that the [The Things Network component](/components/thethingsnetwork/) is set up and the [The Things Network Storage Integration](https://www.thethingsnetwork.org/docs/applications/storage/) as well. +## {% linkable_title Prerequisites %} + Visit the [The Things Network Console](https://console.thethingsnetwork.org/) website, log in with your The Things Network credentials, choose your application from **Applications** and go to **Integrations**. Add a new integration. @@ -54,6 +56,8 @@ Select **Devices** to get the ID of your device that you want to use. Devices overview

+## {% linkable_title Configuration %} + To enable this platform, add the following lines to your `configuration.yaml`: ```yaml diff --git a/source/_components/sensor.thinkingcleaner.markdown b/source/_components/sensor.thinkingcleaner.markdown index d5c681ff73..af6979bed2 100644 --- a/source/_components/sensor.thinkingcleaner.markdown +++ b/source/_components/sensor.thinkingcleaner.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Thinking Cleaner sensor" -description: "Instructions how to integrate a ThinkingCleaner sensor within Home Assistant." +description: "Instructions on how to integrate a ThinkingCleaner sensor within Home Assistant." date: 2016-04-10 17:24 sidebar: true comments: false diff --git a/source/_components/sensor.tibber.markdown b/source/_components/sensor.tibber.markdown index 6ebcc84bcf..81d11c7ac2 100644 --- a/source/_components/sensor.tibber.markdown +++ b/source/_components/sensor.tibber.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Tibber" -description: "Instructions how to integrate Tibber within Home Assistant." +description: "Instructions on how to integrate Tibber within Home Assistant." date: 2017-10-03 17:00 sidebar: true comments: false @@ -13,7 +13,6 @@ ha_release: 0.55 ha_iot_class: "Cloud Polling" --- - The `tibber` sensor provides the current electricity price if you are a [Tibber](https://tibber.com/) customer. To add Tibber to your installation, add the following to your `configuration.yaml` file: @@ -31,3 +30,31 @@ sensor: required: true type: string {% endconfiguration %} + +## {% linkable_title Examples %} + +In this section, you will find some real-life examples of how to use this sensor. + +### {% linkable_title Electricity price %} + +The electricity price can be used to make automations. The sensor has a `max_price` and `min_price` attribute, with max and min price for the current day. Here is an example to get a notification when the price is above 90% of the maximum price for the day: + +{% raw %} +```yaml +- alias: "Electricity price" + trigger: + platform: time + # Matches every hour at 1 minutes past whole + minutes: 1 + seconds: 00 + condition: + condition: template + value_template: '{{ float(states.sensor.electricity_price_hamretunet_10.state) > 0.9 * float(states.sensor.electricity_price_hamretunet_10.attributes.max_price) }}' + action: + - service: notify.pushbullet + data: + title: "Electricity price" + target: "device/daniel_telefon_cat" + message: "The electricity price is now {{ states.sensor.electricity_price_hamretunet_10.state }}" +``` +{% endraw %} diff --git a/source/_components/sensor.time_date.markdown b/source/_components/sensor.time_date.markdown index a37980565e..ce9547358e 100644 --- a/source/_components/sensor.time_date.markdown +++ b/source/_components/sensor.time_date.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Time & Date" -description: "Instructions how to integrate the time and the date within Home Assistant." +description: "Instructions on how to integrate the time and the date within Home Assistant." date: 2015-05-08 17:15 sidebar: true comments: false diff --git a/source/_components/sensor.toon.markdown b/source/_components/sensor.toon.markdown index fabf565aeb..7a82ab95e9 100644 --- a/source/_components/sensor.toon.markdown +++ b/source/_components/sensor.toon.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Toon Sensor" -description: "Instructions how to integrate Toon climate devices within Home Assistant." +description: "Instructions on how to integrate Toon climate devices within Home Assistant." date: 2017-10-22 12:00 sidebar: true comments: false diff --git a/source/_components/sensor.torque.markdown b/source/_components/sensor.torque.markdown index 87ff9e0eca..38379ccd67 100644 --- a/source/_components/sensor.torque.markdown +++ b/source/_components/sensor.torque.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Torque (OBD2)" -description: "Instructions how to integrate Torque sensors into Home Assistant." +description: "Instructions on how to integrate Torque sensors into Home Assistant." date: 2015-12-20 18:00 sidebar: true comments: false diff --git a/source/_components/sensor.tradfri.markdown b/source/_components/sensor.tradfri.markdown new file mode 100644 index 0000000000..fb78480fb1 --- /dev/null +++ b/source/_components/sensor.tradfri.markdown @@ -0,0 +1,16 @@ +--- +layout: page +title: "IKEA Trådfri sensors" +description: "Access and control your ZigBee-based IKEA Trådfri (Tradfri) Sensors." +date: 2017-04-12 22.04 +sidebar: true +comments: false +sharing: true +footer: true +logo: ikea.svg +ha_category: Sensor +ha_iot_class: "Local Polling" +ha_release: 0.67 +--- + +For installation instructions, see [the Trådfri component](/components/tradfri/). diff --git a/source/_components/sensor.trafikverket_weatherstation.markdown b/source/_components/sensor.trafikverket_weatherstation.markdown new file mode 100644 index 0000000000..272c4e0994 --- /dev/null +++ b/source/_components/sensor.trafikverket_weatherstation.markdown @@ -0,0 +1,86 @@ +--- +layout: page +title: "Trafikverket WeatherStation" +description: "Instructions how to integrate Trafikverket WeatherStation within Home Assistant." +date: 2018-02-01 12:06 +sidebar: true +comments: false +sharing: true +footer: true +logo: trafikverket.png +ha_category: Sensor +ha_release: 0.66.0 +--- + +Showing weather information for air and road temperature provided by [Trafikverket](https://www.trafikverket.se/) in Sweden. + +Potential use cases: +- Get weather data in general +- You live near a weather station and want to know the current temperature at home +- Setup automations for your car heating system. If the road is frozen along the way to work, you might want the car heating system to start earlier. + +##### {% linkable_title Configuration %} + +To enable this sensor, add the following lines to your `configuration.yaml`. + +```yaml +sensor: + - platform: trafikverket_weatherstation + name: Trafikverket Road WeatherStation Kungälv + api_key: eXXcbXXXacXXXXc39XX3aXXX4aXX46XX + station: Kungälv + type: road +``` + +{% configuration %} +name: + description: Unique name of the device in the frontend. + required: true + type: string +api_key: + description: API key from Trafikverket. + required: true + type: string +station: + description: Name of the weather station. + required: true + type: string +type: + description: Defines which temperature you want (`air` or `road`). + required: true + type: string +scan_interval: + description: How frequently to query for new data (in seconds). + required: false + type: int + default: 300 +{% endconfiguration %} + +##### {% linkable_title Obtaining API key %} + +Please click [here](https://api.trafikinfo.trafikverket.se/) and register to obtain the API key. + +##### {% linkable_title Weather stations %} + +Click [here](https://www.trafikverket.se/trafikinformation/vag/?TrafficType=personalTraffic&map=1/606442.17/6886316.22/&Layers=RoadWeather%2b) to get a map of valid weather stations. Once a station is found, copy the name according to the below picture and paste it in your `configuration.yaml` file as the `station` variable. + +

+ +

+ +##### {% linkable_title Examples %} + +```yaml +sensor: + - platform: trafikverket_weatherstation + name: Trafikverket Road WeatherStation Kungälv + api_key: eXXcbXXXacXXXXc39XX3aXXX4aXX46XX + station: Kungälv + type: road + - platform: trafikverket_weatherstation + name: Trafikverket Air WeatherStation Lanna + api_key: eXXcbXXXacXXXXc39XX3aXXX4aXX46XX + station: Lanna + type: air + scan_interval: 600 +``` diff --git a/source/_components/sensor.transmission.markdown b/source/_components/sensor.transmission.markdown index 4e54096833..e76da08026 100644 --- a/source/_components/sensor.transmission.markdown +++ b/source/_components/sensor.transmission.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Transmission Sensor" -description: "Instructions how to integrate Transmission sensors within Home Assistant." +description: "Instructions on how to integrate Transmission sensors within Home Assistant." date: 2015-04-25 9:06 sidebar: true comments: false diff --git a/source/_components/sensor.twitch.markdown b/source/_components/sensor.twitch.markdown index ce0b0d051b..6ed513ca90 100644 --- a/source/_components/sensor.twitch.markdown +++ b/source/_components/sensor.twitch.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Twitch" -description: "Instructions how to integrate Twitch sensors into Home Assistant." +description: "Instructions on how to integrate Twitch sensors into Home Assistant." date: 2015-12-19 09:00 sidebar: true comments: false diff --git a/source/_components/sensor.uk_transport.markdown b/source/_components/sensor.uk_transport.markdown index 759f37f982..de21db07dd 100644 --- a/source/_components/sensor.uk_transport.markdown +++ b/source/_components/sensor.uk_transport.markdown @@ -22,7 +22,7 @@ Additional sensors can be added but at the expense of a reduced refresh rate. 2 Queries are entered as a list, with the two transport modes available being `bus` and `train`. -Train departure sensors require three character long `origin` and `destination` station codes which are searchable on the [National Rail enquiries](http://www.nationalrail.co.uk/times_fares/ldb.aspx) website (e.g. `WAT` is London Waterloo). The validity of a route can be checked by performing a GET request to `/uk/train/station/{station_code}/live.json` in the [API reference webpage](https://developer.transportapi.com/docs?raml=https://transportapi.com/v3/raml/transportapi.raml##request_uk_train_station_station_code_live_json). +Train departure sensors require three character long `origin` and `destination` station codes which are searchable on the [National Rail enquiries](http://www.nationalrail.co.uk/times_fares/ldb.aspx) website (e.g., `WAT` is London Waterloo). The validity of a route can be checked by performing a GET request to `/uk/train/station/{station_code}/live.json` in the [API reference webpage](https://developer.transportapi.com/docs?raml=https://transportapi.com/v3/raml/transportapi.raml##request_uk_train_station_station_code_live_json). To add a single train departure sensor add the following to your `configuration.yaml` file: @@ -48,7 +48,7 @@ Configuration variables: - **origin** (*Required*): Specify the three character long origin station code. - **destination** (*Required*): Specify the three character long destination station code. -A large amount of information about upcoming departures is available within the attributes of the sensor. The example above creates a sensor with ID `sensor.next_train_to_wat` with the attribute `next_trains` which is a list of the next 25 departing trains. The status of the next departing train is accessed using the [template sensor](https://home-assistant.io/components/sensor.template/) below, as are the train origin, estimated and scheduled departure times, and the departure platform. +A large amount of information about upcoming departures is available within the attributes of the sensor. The example above creates a sensor with ID `sensor.next_train_to_wat` with the attribute `next_trains` which is a list of the next 25 departing trains. The status of the next departing train is accessed using the [template sensor](/components/sensor.template/) below, as are the train origin, estimated and scheduled departure times, and the departure platform. ```yaml # Example configuration.yaml entry for a template sensor to access the attributes of the next departing train. diff --git a/source/_components/sensor.uptime.markdown b/source/_components/sensor.uptime.markdown index b17f985797..f67feb188e 100644 --- a/source/_components/sensor.uptime.markdown +++ b/source/_components/sensor.uptime.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Uptime Sensor" -description: "Instructions how to integrate an uptime sensor into Home Assistant." +description: "Instructions on how to integrate an uptime sensor into Home Assistant." date: 2017-10-13 10:30 sidebar: true comments: false diff --git a/source/_components/sensor.uscis.markdown b/source/_components/sensor.uscis.markdown new file mode 100644 index 0000000000..3d214dc818 --- /dev/null +++ b/source/_components/sensor.uscis.markdown @@ -0,0 +1,39 @@ +--- +layout: page +title: USCIS Sensor +description: "Instructions on how to set up USCIS within Home Assistant." +date: 2018-03-21 08:00 +sidebar: false +comments: false +sharing: true +footer: true +logo: uscis.png +ha_category: Sensor +ha_release: 0.68 +ha_iot_class: "Cloud Polling" +--- + +The `uscis` sensor component allows you get updates on your USCIS case using your case/receipt number. The sensor gets the case information from [USCIS Website]( https://egov.uscis.gov/casestatus/landing.do) + +## Example for `configuration.yaml` : + +```yaml +sensor: + - platform: uscis + case_id: YOUR_CASE_NUMBER + name: OPTIONAL_NAME +``` + +{% configuration %} +friendly_name: + description: Name of the sensor in Home Assistant. + required: false + default: USCIS + type: string +case_id: + description: Case/receipt number used to get the case details from USCIS web client. + required: true + type: string +{% endconfiguration %} + +All the data will be fetch from [USCIS](https://egov.uscis.gov/casestatus/mycasestatus.do). diff --git a/source/_components/sensor.vasttrafik.markdown b/source/_components/sensor.vasttrafik.markdown index a5aad007bd..8f3862fdd8 100644 --- a/source/_components/sensor.vasttrafik.markdown +++ b/source/_components/sensor.vasttrafik.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Västtrafik Public Transport" -description: "Instructions how to integrate timetable data for traveling in Sweden within Home Assistant." +description: "Instructions on how to integrate timetable data for traveling in Sweden within Home Assistant." date: 2016-10-05 08:45 sidebar: true comments: false @@ -13,7 +13,6 @@ ha_iot_class: "Cloud Polling" ha_release: "0.30" --- - The `vasttrafik` sensor will provide you traveling details for the larger Göteborg area in Sweden from the [Västtrafik](https://vasttrafik.se/) public transportation service. You must create an application [here](https://developer.vasttrafik.se/portal/#/applications) to obtain a `key` and a `secret`. @@ -34,10 +33,11 @@ Configuration variables: - **key** (*Required*): The API key to access your Västtrafik account. - **secret** (*Required*): The API secret to access your Västtrafik account. -- **departures** array (*Required*): List of traveling routes. +- **departures** array (*Required*): List of travel routes. - **name** (*Optional*): Name of the route. - **from** (*Required*): The start station. - **heading** (*Optional*): Direction of the traveling. + - **lines** (*Optional*): Only consider these lines. - **delay** (*Optional*): Delay in minutes. Defaults to 0. The data are coming from [Västtrafik](https://vasttrafik.se/). @@ -54,5 +54,8 @@ sensor: - name: Mot järntorget from: Musikvägen heading: Järntorget + lines: + - 7 + - GRÖN delay: 10 ``` diff --git a/source/_components/sensor.vera.markdown b/source/_components/sensor.vera.markdown index c1e7b16a37..0fbdf0ff31 100644 --- a/source/_components/sensor.vera.markdown +++ b/source/_components/sensor.vera.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Vera Sensor" -description: "Instructions how to integrate Vera sensors into Home Assistant." +description: "Instructions on how to integrate Vera sensors into Home Assistant." date: 2015-10-20 21:00 sidebar: true comments: false diff --git a/source/_components/sensor.verisure.markdown b/source/_components/sensor.verisure.markdown index 75a4676365..8ee60938a9 100644 --- a/source/_components/sensor.verisure.markdown +++ b/source/_components/sensor.verisure.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Verisure Sensor" -description: "Instructions how to integrate Verisure sensors into Home Assistant." +description: "Instructions on how to integrate Verisure sensors into Home Assistant." date: 2016-02-23 21:31 +0100 sidebar: true comments: false diff --git a/source/_components/sensor.version.markdown b/source/_components/sensor.version.markdown index 3f8eaa196e..a84c05f7a2 100644 --- a/source/_components/sensor.version.markdown +++ b/source/_components/sensor.version.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Version Sensor" -description: "Instructions how to integrate a version sensor into Home Assistant." +description: "Instructions on how to integrate a version sensor into Home Assistant." date: 2017-08-10 10:30 sidebar: true comments: false diff --git a/source/_components/sensor.waqi.markdown b/source/_components/sensor.waqi.markdown index ce920cfeff..a3fd05aab8 100644 --- a/source/_components/sensor.waqi.markdown +++ b/source/_components/sensor.waqi.markdown @@ -1,7 +1,7 @@ --- layout: page title: "World Air Quality Index" -description: "Instructions how to setup World Air Quality Index sensor in Home Assistant." +description: "Instructions on how to setup World Air Quality Index sensor in Home Assistant." date: 2016-11-17 06:00 sidebar: true comments: false diff --git a/source/_components/sensor.waze_travel_time.markdown b/source/_components/sensor.waze_travel_time.markdown new file mode 100644 index 0000000000..db3e3f0418 --- /dev/null +++ b/source/_components/sensor.waze_travel_time.markdown @@ -0,0 +1,59 @@ +--- +layout: page +title: "Waze Travel Time" +description: "Instructions on how to add Waze travel time to Home Assistant." +date: 2018-01-23 00:00 +sidebar: true +comments: false +sharing: true +footer: true +logo: waze.png +ha_category: Transport +ha_iot_class: "Cloud Polling" +ha_release: 0.67 +--- + +The `waze_travel_time` sensor provides travel time from the [Waze](https://www.waze.com/). + +Unit system is set to metric system. + +## {% linkable_title Configuration %} + +To use this sensor in your installation, add the following `abode` section to your `configuration.yaml` file: + +```yaml +# Example entry for configuration.yaml +sensor: + - platform: waze_travel_time + origin: Montréal, QC + destination: Québec, QC + region: 'US' +``` + +{% configuration %} +origin: + description: Enter the starting address or the GPS coordinates of the location (GPS coordinates has to be separated by a comma). + required: true + type: string +destination: + description: Enter the destination address or the GPS coordinates of the location (GPS coordinates has to be separated by a comma). + required: true + type: string +region: + description: Choose one of the available regions from 'EU', 'US', 'NA' (equivalent to 'US') or 'IL'. + required: true + type: string +name: + description: A name to display on the sensor. + required: false + default: "Waze Travel Time" + type: string +incl_filter: + description: A substring that has to be present in the description of the selected route (a simple case-insensitive matching). + required: false + type: string +excl_filter: + description: A substring that has to be NOT present in the description of the selected route (a simple case-insensitive matching). + required: false + type: string +{% endconfiguration %} diff --git a/source/_components/sensor.wink.markdown b/source/_components/sensor.wink.markdown index 5a54a70424..7300fd8d65 100644 --- a/source/_components/sensor.wink.markdown +++ b/source/_components/sensor.wink.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Wink Sensor" -description: "Instructions how to setup the Wink sensors within Home Assistant." +description: "Instructions on how to setup the Wink sensors within Home Assistant." date: 2015-01-20 22:36 sidebar: true comments: false diff --git a/source/_components/sensor.worldclock.markdown b/source/_components/sensor.worldclock.markdown index e9f4ac8f9b..c35d652f10 100644 --- a/source/_components/sensor.worldclock.markdown +++ b/source/_components/sensor.worldclock.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Worldclock" -description: "Instructions how to integrate a Worldclock within Home Assistant." +description: "Instructions on how to integrate a Worldclock within Home Assistant." date: 2015-10-02 11:15 sidebar: true comments: false diff --git a/source/_components/sensor.worldtidesinfo.markdown b/source/_components/sensor.worldtidesinfo.markdown index 955f380d4a..1b5dca3185 100644 --- a/source/_components/sensor.worldtidesinfo.markdown +++ b/source/_components/sensor.worldtidesinfo.markdown @@ -1,7 +1,7 @@ --- layout: page title: "World Tides" -description: "Instructions how to add Tides information to Home Assistant." +description: "Instructions on how to add Tides information to Home Assistant." date: 2017-08-23 08:00 sidebar: true comments: false diff --git a/source/_components/sensor.worxlandroid.markdown b/source/_components/sensor.worxlandroid.markdown index 5f52ac95d9..5497ae7005 100644 --- a/source/_components/sensor.worxlandroid.markdown +++ b/source/_components/sensor.worxlandroid.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Worx Landroid" -description: "Instructions how to integrate Worx Landroid WG796E.1 or WG797E as sensors within Home Assistant." +description: "Instructions on how to integrate Worx Landroid WG796E.1 or WG797E as sensors within Home Assistant." date: 2017-09-12 13:23 sidebar: true comments: false diff --git a/source/_components/sensor.wunderground.markdown b/source/_components/sensor.wunderground.markdown index 4183dfa0b0..d86dd62935 100644 --- a/source/_components/sensor.wunderground.markdown +++ b/source/_components/sensor.wunderground.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Weather Underground (WUnderground)" -description: "Instructions how to integrate Weather Underground (WUnderground) Weather within Home Assistant." +description: "Instructions on how to integrate Weather Underground (WUnderground) Weather within Home Assistant." date: 2016-08-18 sidebar: true comments: false @@ -86,7 +86,7 @@ Configuration variables: - **weather**: A human-readable text summary with picture from Wunderground. - **weather_1d** [[12h]](#12h): A human-readable weather forecast using imperial units. - **weather_1d_metric** [[12h]](#12h): A human-readable weather forecast using metric units. - - **weather_1h** [[1h]](#1h): Weather conditions in 1 hour. (e.g. "Thunderstorm" etc.) + - **weather_1h** [[1h]](#1h): Weather conditions in 1 hour. (e.g., "Thunderstorm" etc.) - **wind_degrees**: Wind degrees - **wind_dir**: Wind direction - **wind_gust_kph**: Wind gusts speed in kph @@ -105,7 +105,7 @@ All the conditions listed above will be updated every 5 minutes. _12 hour forecasts_ -Monitored conditions marked above with [12h] are 12 hour forecasts. To get a forecast for different period/daytime replace the `_1d_` part of the sensor name. e.g. `weather_2n` will give you forecast for tomorrow night. Valid values for day are `1` to `4` and valid values for daytime are `d` or `n`. +Monitored conditions marked above with [12h] are 12 hour forecasts. To get a forecast for different period/daytime replace the `_1d_` part of the sensor name. e.g., `weather_2n` will give you forecast for tomorrow night. Valid values for day are `1` to `4` and valid values for daytime are `d` or `n`. _Daily forecasts_ @@ -115,7 +115,7 @@ in `_1d_` part of the sensor name. Valid values are from `1` to `4`. _Hourly forecasts_ Conditions marked with [1h] are hourly forecasts. To get forecast for different hour, replace the number -in the `_1h_` part of the sensor name with `1` to `36`. E.g. `weather_24h` will give you weather in 24 hours. +in the `_1h_` part of the sensor name with `1` to `36`. e.g., `weather_24h` will give you weather in 24 hours. ### {% linkable_title Additional examples %} diff --git a/source/_components/sensor.xiaomi_aqara.markdown b/source/_components/sensor.xiaomi_aqara.markdown index 247a9a94c9..a69c4f685a 100644 --- a/source/_components/sensor.xiaomi_aqara.markdown +++ b/source/_components/sensor.xiaomi_aqara.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Xiaomi Sensor" -description: "Instructions how to setup the Xiaomi sensor within Home Assistant." +description: "Instructions on how to setup the Xiaomi sensor within Home Assistant." date: 2017-07-21 16:34 sidebar: true comments: false diff --git a/source/_components/sensor.xiaomi_miio.markdown b/source/_components/sensor.xiaomi_miio.markdown new file mode 100644 index 0000000000..65d1f3780f --- /dev/null +++ b/source/_components/sensor.xiaomi_miio.markdown @@ -0,0 +1,54 @@ +--- +layout: page +title: "Xiaomi Air Quality Monitor" +description: "Instructions how to integrate your Xiaomi Mi Air Quality Monitor within Home Assistant." +date: 2018-02-28 08:35 +sidebar: true +comments: false +sharing: true +footer: true +logo: xiaomi.png +ha_category: Sensor +ha_version: 0.66 +ha_iot_class: "Local Polling" +--- + +The `xiaomi_miio` sensor platform is observing your Xiaomi Mi Air Quality Monitor (PM2.5) and reporting the air quality index. + +Currently, the supported features are: + +* Air Quality Index (AQI) +* Attributes + - power + - charging + - battery + - time_stat + +Please follow the instructions on [Retrieving the Access Token](/components/vacuum.xiaomi_miio/#retrieving-the-access-token) to get the API token. + +To add a Xiaomi Mi Air Quality Monitor to your installation, add the following to your `configuration.yaml` file: + +```yaml +# Example configuration.yaml entry +sensor: + - platform: xiaomi_miio + name: Xiaomi Air Quality Monitor + host: 192.168.130.73 + token: YOUR_TOKEN +``` + +{% configuration %} +host: + description: The IP address of your miio device. + required: true + type: string +token: + description: The API token of your miio device. + required: true + type: string +name: + description: The name of your miio device. + required: false + type: string + default: Xiaomi Miio Sensor +{% endconfiguration %} diff --git a/source/_components/sensor.yahoo_finance.markdown b/source/_components/sensor.yahoo_finance.markdown index 8a55a78dda..0e8d12c0fb 100644 --- a/source/_components/sensor.yahoo_finance.markdown +++ b/source/_components/sensor.yahoo_finance.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Yahoo Finance" -description: "Instructions how to setup Yahoo Finance within Home Assistant." +description: "Instructions on how to setup Yahoo Finance within Home Assistant." date: 2016-09-18 21:00 sidebar: true comments: false diff --git a/source/_components/sensor.yr.markdown b/source/_components/sensor.yr.markdown index 35813cb459..772fa6560e 100644 --- a/source/_components/sensor.yr.markdown +++ b/source/_components/sensor.yr.markdown @@ -1,7 +1,7 @@ --- layout: page title: "YR" -description: "Instructions how to integrate Yr.no within Home Assistant." +description: "Instructions on how to integrate Yr.no within Home Assistant." date: 2016-01-04 14:00 sidebar: true comments: false diff --git a/source/_components/sensor.yweather.markdown b/source/_components/sensor.yweather.markdown index 0f9bcd7a85..fdd5a38b80 100644 --- a/source/_components/sensor.yweather.markdown +++ b/source/_components/sensor.yweather.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Yahoo Weather Sensor" -description: "Instructions how to integrate Yahoo Weather within Home Assistant." +description: "Instructions on how to integrate Yahoo Weather within Home Assistant." date: 2016-07-06 9:06 sidebar: true comments: false diff --git a/source/_components/sensor.zabbix.markdown b/source/_components/sensor.zabbix.markdown index daf65e1a78..64e960ed61 100644 --- a/source/_components/sensor.zabbix.markdown +++ b/source/_components/sensor.zabbix.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Zabbix Sensor" -description: "Instructions how to integrate Zabbix Triggers sensors within Home Assistant." +description: "Instructions on how to integrate Zabbix Triggers sensors within Home Assistant." date: 2016-12-13 22:57 sidebar: true comments: false diff --git a/source/_components/sensor.zamg.markdown b/source/_components/sensor.zamg.markdown index 9c6558a569..014752a66e 100644 --- a/source/_components/sensor.zamg.markdown +++ b/source/_components/sensor.zamg.markdown @@ -1,7 +1,7 @@ --- layout: page title: "ZAMG Sensor" -description: "Instructions how to integrate ZAMG sensors within Home Assistant." +description: "Instructions on how to integrate ZAMG sensors within Home Assistant." date: 2016-12-06 08:00 sidebar: true comments: false diff --git a/source/_components/sensor.zestimate.markdown b/source/_components/sensor.zestimate.markdown index c791cd7b73..ca9547e404 100644 --- a/source/_components/sensor.zestimate.markdown +++ b/source/_components/sensor.zestimate.markdown @@ -8,25 +8,28 @@ comments: false sharing: true footer: true ha_category: Sensor +logo: zillow.png ha_release: 0.65 ha_iot_class: "Cloud Polling" --- The `zestimate` sensor allows one to track the Zestimate value of properties using the [Zillow API](https://www.zillow.com/howto/api/APIOverview.htm). +## {% linkable_title Configuration %} + You will need to sign up for the Zillow API at the following link [Zillow API](https://www.zillow.com/howto/api/APIOverview.htm). You will also need the Zillow property ID for each property you'd like to track. This information is available from the URL of a property you are interested in. -For example, the White House zpid is 84074482 and can be found in it's Zillow URL: https://www.zillow.com/homedetails/1600-Pennsylvania-Ave-NW-Washington-DC-20006/84074482_zpid/ +For example, the White House zpid is 84074482 and can be found in it's Zillow URL: [https://www.zillow.com/homedetails/1600-Pennsylvania-Ave-NW-Washington-DC-20006/84074482_zpid/](https://www.zillow.com/homedetails/1600-Pennsylvania-Ave-NW-Washington-DC-20006/84074482_zpid/) To enable this sensor, add the following lines to your `configuration.yaml`. ```yaml sensor: - platform: zestimate - api_key: API_KEY + api_key: YOUR_API_KEY zpid: - - - - + - YOUR_ZPID_1 + - YOUR_ZPID_2 ``` {% configuration %} @@ -40,7 +43,7 @@ zpid: type: list {% endconfiguration %} -### Additional Attributes +### {% linkable_title Additional Attributes %} The following additional attributes are also available via the sensor. diff --git a/source/_components/sensor.zwave.markdown b/source/_components/sensor.zwave.markdown index 2b22c7cce9..70fba841c5 100644 --- a/source/_components/sensor.zwave.markdown +++ b/source/_components/sensor.zwave.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Z-Wave Sensor" -description: "Instructions how to setup the Z-Wave sensors within Home Assistant." +description: "Instructions on how to setup the Z-Wave sensors within Home Assistant." date: 2015-11-15 13:00 sidebar: true comments: false diff --git a/source/_components/shell_command.markdown b/source/_components/shell_command.markdown index d9f64f8a07..8c03c7c7af 100644 --- a/source/_components/shell_command.markdown +++ b/source/_components/shell_command.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Shell command" -description: "Instructions how to integrate Shell commands into Home Assistant." +description: "Instructions on how to integrate Shell commands into Home Assistant." date: 2015-10-13 19:10 sidebar: true comments: false diff --git a/source/_components/shiftr.markdown b/source/_components/shiftr.markdown index 16ae6a53f0..a383534704 100644 --- a/source/_components/shiftr.markdown +++ b/source/_components/shiftr.markdown @@ -15,6 +15,8 @@ ha_release: 0.48 The `shiftr` component makes it possible to transfer details collected with Home Assistant to [Shiftr.io](https://shiftr.io) and visualize the flow of the information. Keep in mind that your details will be public! +## {% linkable_title Configuration %} + Create a new [namespace](https://shiftr.io/new) and generate a new token. You will need to use `Key (Username)` and `Secret (Password)` to setup the component. To use the `shiftr` component in your installation, add the following to your `configuration.yaml` file: @@ -22,12 +24,18 @@ To use the `shiftr` component in your installation, add the following to your `c ```yaml # Example configuration.yaml entry shiftr: - username: 63d8187f - password: 32fd92de6a59c3e2 + username: YOUR_NAMESPACE_USERNAME + password: YOUR_NAMESPACE_PASSWORD ``` -Configuration variables: - -- **username** (*Required*): Username for the namespace. -- **password** (*Required*): Password for the namespace. +{% configuration %} +username: + description: Username for the Shiftr namespace. + required: true + type: string +password: + description: Password for the Shiftr namespace. + required: true + type: string +{% endconfiguration %} diff --git a/source/_components/skybell.markdown b/source/_components/skybell.markdown index 4a7a2cfdac..189f3a1b99 100644 --- a/source/_components/skybell.markdown +++ b/source/_components/skybell.markdown @@ -17,13 +17,15 @@ The `skybell` implementation allows you to integrate your [Skybell.com](http://w Currently only the Skybell HD is supported by this platform. +## {% linkable_title Configuration %} + To enable devices set up with your [Skybell.com](http://www.skybell.com/) account, add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry skybell: - username: you@example.com - password: secret + username: YOUR_USERNAME + password: YOUR_PASSWORD ``` {% configuration %} diff --git a/source/_components/sleepiq.markdown b/source/_components/sleepiq.markdown index 6527c803f0..a3efeaa0a0 100644 --- a/source/_components/sleepiq.markdown +++ b/source/_components/sleepiq.markdown @@ -22,11 +22,18 @@ To set it up, add the following information to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry sleepiq: - username: you@example.com - password: omgsecure + username: YOUR_USERNAME + password: YOUR_PASSWORD ``` -Configuration variables: +{% configuration %} +username: + description: Your SleepIQ username (usually an e-mail address). + required: true + type: string +password: + description: Your SleepIQ password. + required: true + type: string +{% endconfiguration %} -- **username** (*Required*): Your SleepIQ username (usually an email address). -- **password** (*Required*): Your SleepIQ password. diff --git a/source/_components/smappee.markdown b/source/_components/smappee.markdown index 4bd050ad22..ce56987f72 100644 --- a/source/_components/smappee.markdown +++ b/source/_components/smappee.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Smappee" -description: "Instructions how to setup Smappee within Home Assistant." +description: "Instructions on how to setup Smappee within Home Assistant." date: 2018-02-26 08:37 sidebar: true comments: false @@ -12,41 +12,42 @@ ha_release: "0.64" ha_category: Hub --- -[Smappee](https://www.smappee.com/) controller for energy monitoring and Comport plug switches. +The `smappee` component adds support for the [Smappee](https://www.smappee.com/) controller for energy monitoring and Comport plug switches. Switches and Sensors are supported - and will be automatically added when you connect to the Smappee controller. -The smappee component gets information from [Smappee API](https://smappee.atlassian.net/wiki/display/DEVAPI/API+Methods) using the [smappy](https://github.com/EnergieID/smappy) pypy module +The smappee component gets information from [Smappee API](https://smappee.atlassian.net/wiki/display/DEVAPI/API+Methods). -

-Info on how to get api access is described in the [smappy wiki](https://github.com/EnergieID/smappy/wiki) -

+## {% linkable_title Configuration %} + +Info on how to get API access is described in the [smappy wiki](https://github.com/EnergieID/smappy/wiki). + +To use the `smappee` component in your installation, add the following to your `configuration.yaml` file: -# Configuration ```yaml # Example configuration.yaml entry smappee: - host: 10.0.0.5 - client_id: YOUR_CLIENT_ID - client_secret: YOUR_CLIENT_SECRET - username: YOUR_MYSMAPPEE_USERNAME - password: YOUR_MYSMAPPEE_PASSWORD + host: 10.0.0.5 + client_id: YOUR_CLIENT_ID + client_secret: YOUR_CLIENT_SECRET + username: YOUR_MYSMAPPEE_USERNAME + password: YOUR_MYSMAPPEE_PASSWORD ``` ```yaml # Minimal example configuration.yaml entry smappee: - host: 10.0.0.5 + host: 10.0.0.5 ``` ```yaml # Cloud only example configuration.yaml entry smappee: - client_id: YOUR_CLIENT_ID - client_secret: YOUR_CLIENT_SECRET - username: YOUR_MYSMAPPEE_USERNAME - password: YOUR_MYSMAPPEE_PASSWORD + client_id: YOUR_CLIENT_ID + client_secret: YOUR_CLIENT_SECRET + username: YOUR_MYSMAPPEE_USERNAME + password: YOUR_MYSMAPPEE_PASSWORD ``` Configuration variables: diff --git a/source/_components/snips.markdown b/source/_components/snips.markdown index 6f876effdd..e7086ac9dc 100644 --- a/source/_components/snips.markdown +++ b/source/_components/snips.markdown @@ -1,8 +1,8 @@ --- layout: page title: "Snips" -description: "Instructions how to integrate Snips within Home Assistant." -date: 2017-06-22 12:00 +description: "Instructions on how to integrate Snips within Home Assistant." +date: 2018-05-02 12:00 sidebar: true comments: false sharing: true @@ -14,7 +14,7 @@ ha_release: 0.48 The [Snips Voice Platform](https://www.snips.ai) allows users to add powerful voice assistants to their Raspberry Pi devices without compromising on privacy. It runs 100% on-device, and does not require an internet connection. It features Hotword Detection, Automatic Speech Recognition (ASR), Natural Language Understanding (NLU) and Dialog Management. -The latest documentation can be found here: [Snips Platform Documentation](https://github.com/snipsco/snips-platform-documentation/wiki). +The latest documentation can be found here: [Snips Platform Documentation](https://snips.gitbook.io/documentation/). ![Snips Modules](/images/screenshots/snips_modules.png) @@ -97,7 +97,7 @@ followed by a command, e.g. > Set the lights to green in the living room -As the Snips Platform parses this query into an intent, it will be published on MQTT, on the `hermes/intent/` topic. The Snips Home Assistant component subscribes to this topic, and handles the intent according to the rules defined in `configuration.yaml`, as explained below. +As the Snips Platform parses this query into an intent, it will be published on MQTT, on the `hermes/intent/` topic. The Snips Home Assistant component subscribes to this topic, and handles the intent according to the rules defined in `configuration.yaml` file, as explained below. #### {% linkable_title Optional: specifying an external MQTT broker %} @@ -166,11 +166,11 @@ SetTimer: ``` {% endraw %} -### Sending TTS Notifications +### {% linkable_title Sending TTS Notifications %} You can send TTS notifications to Snips using the snips.say and snips.say_action services. Say_action starts a session and waits for user response, "Would you like me to close the garage door?", "Yes, close the garage door". -#### {% linkable_title Service `snips/say` %} +#### {% linkable_title Service `snips.say` %} | Service data attribute | Optional | Description | |------------------------|----------|--------------------------------------------------------| @@ -178,7 +178,7 @@ You can send TTS notifications to Snips using the snips.say and snips.say_action | `site_id` | yes | Site to use to start session. | | `custom_data` | yes | custom data that will be included with all messages in this session. | -#### {% linkable_title Service `snips/say_action` %} +#### {% linkable_title Service `snips.say_action` %} | Service data attribute | Optional | Description | |------------------------|----------|--------------------------------------------------------| @@ -188,19 +188,48 @@ You can send TTS notifications to Snips using the snips.say and snips.say_action | `can_be_enqueued` | yes | If True, session waits for an open session to end, if False session is dropped if one is running. | | `intent_filter` | yes | Array of Strings - A list of intents names to restrict the NLU resolution to on the first query. | -#### Configuration Examples + +### {% linkable_title Snips Support %} + +There is an active [discord](https://discordapp.com/invite/3939Kqx) channel for further support. + +### {% linkable_title Configuration Examples %} + +#### {% linkable_title Turn on a light %} ```yaml -script: +intent_script: turn_on_light: - sequence: - service: script.turn_on_light - service: snips.say - data: - text: 'OK, the light is now on' + speech: + type: plain + text: 'OK, closing the garage door' + action: + service: light.turn_on +``` +##### {% linkable_title Open a Garage Door %} + +```yaml +intent_script: + OpenGarageDoor: + speech: + type: plain + text: 'OK, opening the garage door' + action: + - service: cover.open_cover + data: + entity_id: garage_door +``` + +##### {% linkable_title Intiating a query %} + +Here is a more complex example. The automation is triggered if the garage door is open for more than 10 minutes. +Snips will then ask you if you want to close it and if you respond with something like "Close the garage door" it +will do so. Unfortunately there is no builtin support for yes and no responses. + +```yaml automation: - query_garage_door: + garage_door_has_been_open: trigger: - platform: state entity_id: binary_sensor.my_garage_door_sensor @@ -224,3 +253,40 @@ intent_script: action: - service: script.garage_door_close ``` + +##### {% linkable_title Weather %} + +So now you can open and close your garage door, let's check the weather. Add the Weather by Snips Skill to your assistant. Create a weather sensor, in this example (Dark Sky)[/components/sensor.darksky/] and the `api_key` in the `secrets.yaml` file. + +```yaml +- platform: darksky + name: "Dark Sky Weather" + api_key: !secret dark_sky_key + update_interval: + minutes: 10 + monitored_conditions: + - summary + - hourly_summary + - temperature + - temperature_max + - temperature_min +``` + +Then create this `intent_script.yaml` file in your configuration directory. + +{% raw %} +```yaml +intent_script: + searchWeatherForecast: + speech: + type: plain + text: > + The weather is currently + {{ states('sensor.dark_sky_weather_temperature') | round(0) }} + degrees outside and {{ states('sensor.dark_sky_weather_summary') }}. + The high today will be + {{ states('sensor.dark_sky_weather_daily_high_temperature') | round(0)}} + and {{ states('sensor.dark_sky_weather_hourly_summary') }} +``` +{% endraw %} + diff --git a/source/_components/spc.markdown b/source/_components/spc.markdown index 1573174329..0e8819fb85 100644 --- a/source/_components/spc.markdown +++ b/source/_components/spc.markdown @@ -1,7 +1,7 @@ --- layout: page title: "SPC" -description: "Instructions how to setup Vanderbilt SPC devices within Home Assistant." +description: "Instructions on how to setup Vanderbilt SPC devices within Home Assistant." date: 2017-05-18 08:00 sidebar: true comments: false @@ -27,8 +27,8 @@ spc: Configuration variables: -- **api_url** (*Required*): URL of the SPC Web Gateway command REST API, e.g. `http://:8088`. -- **ws_url** (*Required*): URL of the SPC Web Gateway websocket, e.g. `ws://:8088`. +- **api_url** (*Required*): URL of the SPC Web Gateway command REST API, e.g., `http://:8088`. +- **ws_url** (*Required*): URL of the SPC Web Gateway websocket, e.g., `ws://:8088`. Supported sensors will be automatically discovered and added, however they will be hidden by default. diff --git a/source/_components/sun.markdown b/source/_components/sun.markdown index 8de87f43be..91d1f7903e 100644 --- a/source/_components/sun.markdown +++ b/source/_components/sun.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Sun" -description: "Instructions how to track the sun within Home Assistant." +description: "Instructions on how to track the sun within Home Assistant." date: 2015-01-24 14:39 sidebar: true comments: false diff --git a/source/_components/switch.abode.markdown b/source/_components/switch.abode.markdown index 8979b0e286..2cc7d2e977 100644 --- a/source/_components/switch.abode.markdown +++ b/source/_components/switch.abode.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Abode Switch" -description: "Instructions how to integrate Abode switches into Home Assistant." +description: "Instructions on how to integrate Abode switches into Home Assistant." date: 2017-08-26 13:28 sidebar: true comments: false diff --git a/source/_components/switch.acer_projector.markdown b/source/_components/switch.acer_projector.markdown index d9158b3152..70e1ae5499 100644 --- a/source/_components/switch.acer_projector.markdown +++ b/source/_components/switch.acer_projector.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Acer Projector Switch" -description: "Instructions how to integrate Acer Projector switches into Home Assistant." +description: "Instructions on how to integrate Acer Projector switches into Home Assistant." date: 2016-05-07 07:00 sidebar: true comments: false diff --git a/source/_components/switch.amcrest.markdown b/source/_components/switch.amcrest.markdown new file mode 100644 index 0000000000..d9ed4564b2 --- /dev/null +++ b/source/_components/switch.amcrest.markdown @@ -0,0 +1,18 @@ +--- +layout: page +title: "Amcrest IP Camera Settings" +description: "Instructions on how to integrate settings for Amcrest IP Camera as switches within Home Assistant." +date: 2018-03-08 00:00 +sidebar: true +comments: false +sharing: true +footer: true +logo: amcrest.png +ha_category: Switch +ha_release: 0.67 +ha_iot_class: "Local Polling" +--- + +The `amcrest` switch platform lets you control settings of [Amcrest IP Camera](https://home-assistant.io/components/camera.amcrest/) through Home Assistant. + +Switches will be configured automatically. Please refer to the [component](/components/amcrest/) configuration on how to setup. diff --git a/source/_components/switch.android_ip_webcam.markdown b/source/_components/switch.android_ip_webcam.markdown index 980d363adc..bb32b0c9f5 100644 --- a/source/_components/switch.android_ip_webcam.markdown +++ b/source/_components/switch.android_ip_webcam.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Android IP Webcam Settings" -description: "Instructions how to integrate settings for Android IP webcam as switch within Home Assistant." +description: "Instructions on how to integrate settings for Android IP webcam as switch within Home Assistant." date: 2017-03-10 00:00 sidebar: true comments: false diff --git a/source/_components/switch.anel_pwrctrl.markdown b/source/_components/switch.anel_pwrctrl.markdown index fbd3023d3f..c753805477 100644 --- a/source/_components/switch.anel_pwrctrl.markdown +++ b/source/_components/switch.anel_pwrctrl.markdown @@ -1,7 +1,7 @@ --- layout: page title: "ANEL PwrCtrl Switch" -description: "Instructions how to integrate ANEL PwrCtrl switches within Home Assistant." +description: "Instructions on how to integrate ANEL PwrCtrl switches within Home Assistant." date: 2016-10-02 19:04 sidebar: true comments: false diff --git a/source/_components/switch.arduino.markdown b/source/_components/switch.arduino.markdown index bc4f76b19e..a27907103a 100644 --- a/source/_components/switch.arduino.markdown +++ b/source/_components/switch.arduino.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Arduino Switch" -description: "Instructions how to integrate Arduino boards pins as switches within Home Assistant." +description: "Instructions on how to integrate Arduino boards pins as switches within Home Assistant." date: 2015-09-14 18:28 sidebar: true comments: false diff --git a/source/_components/switch.arest.markdown b/source/_components/switch.arest.markdown index bca17d23c5..603949d5c1 100644 --- a/source/_components/switch.arest.markdown +++ b/source/_components/switch.arest.markdown @@ -1,7 +1,7 @@ --- layout: page title: "aREST Switch" -description: "Instructions how to integrate aREST switches within Home Assistant." +description: "Instructions on how to integrate aREST switches within Home Assistant." date: 2015-09-11 23:15 sidebar: true comments: false diff --git a/source/_components/switch.bbb_gpio.markdown b/source/_components/switch.bbb_gpio.markdown index 22feef16a6..7b02e6a927 100644 --- a/source/_components/switch.bbb_gpio.markdown +++ b/source/_components/switch.bbb_gpio.markdown @@ -1,7 +1,7 @@ --- layout: page title: "BeagleBone Black GPIO Switch" -description: "Instructions how to integrate the GPIO of a BeagleBone Black into Home Assistant as a switch." +description: "Instructions on how to integrate the GPIO of a BeagleBone Black into Home Assistant as a switch." date: 2017-01-14 10:00 sidebar: true comments: false diff --git a/source/_components/switch.broadlink.markdown b/source/_components/switch.broadlink.markdown index f63297eed5..ad5f0214dc 100644 --- a/source/_components/switch.broadlink.markdown +++ b/source/_components/switch.broadlink.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Broadlink RM Switch" -description: "Instructions how to have Broadlink RM switches." +description: "Instructions on how to have Broadlink RM switches." date: 2016-11-22 22:41 sidebar: true comments: false @@ -43,7 +43,7 @@ Configuration variables: - **slot_3** (*Optional*) - **slot_4** (*Optional*) -Information about how to install on Windows can be found [here](https://home-assistant.io/components/sensor.broadlink/#microsoft-windows-installation) +Information about how to install on Windows can be found [here](/components/sensor.broadlink/#microsoft-windows-installation) ### {% linkable_title How to obtain IR/RF packets? %} @@ -90,8 +90,8 @@ switch: friendly_name: "Phillips Tv" command_on: 'JgAcAB0dHB44HhweGx4cHR06HB0cHhwdHB8bHhwADQUAAAAAAAAAAAAAAAA=' command_off: 'JgAaABweOR4bHhwdHB4dHRw6HhsdHR0dOTocAA0FAAAAAAAAAAAAAAAAAAA=' -``` - +``` + Example config for `sp1`, `sp2`, `honeywell_sp2`, `sp3`, `spmini2` and `spminiplus` devices: ```yaml @@ -106,7 +106,7 @@ switch: mac: 'MAC_ADDRESS' type: sp2 friendly_name: 'Humidifier' -``` +``` Example config for `mp1` device: @@ -142,10 +142,10 @@ script: sequence: - service: switch.broadlink_send_packet_192_168_0_107 data: - packet: + packet: - "JgCMAJSSFDYUNhQ2FBEUERQRFBEUERQ2FDYUNhQRFBEUERQRFBEUERQRFDYUERQRFBEUERQRFDYUNhQRFDYUNhQ2FDYUNhQABfWUkhQ2FDYUNhQRFBEUERQRFBEUNhQ2FDYUERQRFBEUERQRFBEUERQ2FBEUERQRFBEUERQ2FDYUERQ2FDYUNhQ2FDYUAA0FAAAAAAAAAAAAAAAA" - "JgBGAJSTFDUUNhM2ExITEhMSExITEhM2EzYTNhQRFBEUERQRFBEUNRQ2ExITNhMSExITNhMSExITEhM2ExITNhQ1FBEUNhMADQUAAA==" -``` +``` ### {% linkable_title Using E-Control Remotes %} @@ -168,7 +168,7 @@ First get or learn all the remotes you want to add to Home Assistant in E-Contro jsonSubIr jsonButton jsonIrCode - + 4. Install Requirements Run `pip install simplejson`. You must install simplejson in the same python version you will use to run the scripts. You can ensure that the current version is installed by attempting to install again and confirming that you see "Requirement already satisfied". diff --git a/source/_components/switch.command_line.markdown b/source/_components/switch.command_line.markdown index 0c70ae6afc..3f3ef8d022 100644 --- a/source/_components/switch.command_line.markdown +++ b/source/_components/switch.command_line.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Command line Switch" -description: "Instructions how to have switches call command line commands." +description: "Instructions on how to have switches call command line commands." date: 2015-06-10 22:41 sidebar: true comments: false @@ -40,7 +40,7 @@ Configuration variables: A note on `friendly_name`: -When set, the `friendly_name` had been previously used for API calls and backend configuration instead of the `object_id` ("identifier"), but [this behavior is changing](https://github.com/home-assistant/home-assistant/pull/4343) to make the `friendly_name` for display purposes only. This allows users to set an `identifier` that emphasizes uniqueness and predictability for API and config purposes but have a prettier `friendly_name` still show up in the UI. As an additional benefit, if a user wanted to change the `friendly_name` / display name (e.g. from "Kitchen Lightswitch" to "Kitchen Switch" or "Living Room Light", or remove the `friendly_name` altogether), he or she could do so without needing to change existing automations or API calls. See aREST device below for an example. +When set, the `friendly_name` had been previously used for API calls and backend configuration instead of the `object_id` ("identifier"), but [this behavior is changing](https://github.com/home-assistant/home-assistant/pull/4343) to make the `friendly_name` for display purposes only. This allows users to set an `identifier` that emphasizes uniqueness and predictability for API and config purposes but have a prettier `friendly_name` still show up in the UI. As an additional benefit, if a user wanted to change the `friendly_name` / display name (e.g., from "Kitchen Lightswitch" to "Kitchen Switch" or "Living Room Light", or remove the `friendly_name` altogether), he or she could do so without needing to change existing automations or API calls. See aREST device below for an example. ## {% linkable_title Examples %} @@ -63,7 +63,7 @@ switch: friendly_name: Kitchen Lightswitch ``` -Given this example, in the UI one would see the `friendly_name` of "Kitchen Light". However, the `identifier` is `arest_pin_four`, making the `entity_id` `switch.arest_pin_four`, which is what one would use in [`automation`](https://home-assistant.io/components/automation/) or in [API calls](https://home-assistant.io/developers/). +Given this example, in the UI one would see the `friendly_name` of "Kitchen Light". However, the `identifier` is `arest_pin_four`, making the `entity_id` `switch.arest_pin_four`, which is what one would use in [`automation`](/components/automation/) or in [API calls](/developers/). ### {% linkable_title Shutdown your local host %} @@ -85,7 +85,7 @@ switch: ### {% linkable_title Control your VLC player %} -This switch will control a local VLC media player ([Source](https://community.home-assistant.io/t/vlc-player/106)). +This switch will control a local VLC media player ([Source](https://community.home-assistant.io/t/vlc-player/106)). ```yaml diff --git a/source/_components/switch.deluge.markdown b/source/_components/switch.deluge.markdown index 738732d27c..b9673415c3 100644 --- a/source/_components/switch.deluge.markdown +++ b/source/_components/switch.deluge.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Deluge Switch" -description: "Instructions how to integrate Deluge within Home Assistant." +description: "Instructions on how to integrate Deluge within Home Assistant." date: 2017-10-19 09:00 sidebar: true comments: false diff --git a/source/_components/switch.digitalloggers.markdown b/source/_components/switch.digitalloggers.markdown index f3142a6bbc..c0c2272d17 100755 --- a/source/_components/switch.digitalloggers.markdown +++ b/source/_components/switch.digitalloggers.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Digital Loggers Switch" -description: "Instructions how to integrate Digital Loggers DIN III relays into Home Assistant." +description: "Instructions on how to integrate Digital Loggers DIN III relays into Home Assistant." date: 2016-10-02 10:00 sidebar: true comments: false diff --git a/source/_components/switch.dlink.markdown b/source/_components/switch.dlink.markdown index 708ba90e39..50da6cf4a7 100644 --- a/source/_components/switch.dlink.markdown +++ b/source/_components/switch.dlink.markdown @@ -1,7 +1,7 @@ --- layout: page title: "D-Link Switch" -description: "Instructions how to integrate D-Link switches into Home Assistant." +description: "Instructions on how to integrate D-Link switches into Home Assistant." date: 2016-02-21 09:00 sidebar: true comments: false diff --git a/source/_components/switch.doorbird.markdown b/source/_components/switch.doorbird.markdown index fc2497f917..cb5b66db17 100644 --- a/source/_components/switch.doorbird.markdown +++ b/source/_components/switch.doorbird.markdown @@ -1,7 +1,7 @@ --- layout: page title: "DoorBird Switch" -description: "Instructions how to integrate DoorBird video doorbell relays into Home Assistant." +description: "Instructions on how to integrate DoorBird video doorbell relays into Home Assistant." date: 2017-08-06 11:30 sidebar: true comments: false diff --git a/source/_components/switch.edimax.markdown b/source/_components/switch.edimax.markdown index 028b64d61a..06f58328a4 100644 --- a/source/_components/switch.edimax.markdown +++ b/source/_components/switch.edimax.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Edimax Switch" -description: "Instructions how to integrate Edimax switches into Home Assistant." +description: "Instructions on how to integrate Edimax switches into Home Assistant." date: 2015-06-10 22:54 sidebar: true comments: false diff --git a/source/_components/switch.eufy.markdown b/source/_components/switch.eufy.markdown new file mode 100644 index 0000000000..1a79dbd26b --- /dev/null +++ b/source/_components/switch.eufy.markdown @@ -0,0 +1,19 @@ +--- +layout: page +title: "Eufy Switch" +description: "Instructions on how to integrate Eufy switches into Home Assistant." +date: 2018-04-09 19:00 +sidebar: true +comments: false +sharing: true +footer: true +logo: eufy.png +ha_category: Switch +ha_iot_class: "Local Polling" +ha_release: 0.68 +--- + +The `eufy` platform allows you to control your [Eufy](http://www.eufylife.com) switches from within Home Assistant. + +They will be automatically discovered if the [Eufy](/components/eufy/) component is enabled. + diff --git a/source/_components/switch.flux.markdown b/source/_components/switch.flux.markdown index cfe74efd20..41df410065 100644 --- a/source/_components/switch.flux.markdown +++ b/source/_components/switch.flux.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Flux Light Adjustment" -description: "Instructions how to have switches call command line commands." +description: "Instructions on how to have switches call command line commands." date: 2016-06-01 17:41 sidebar: true comments: false diff --git a/source/_components/switch.fritzbox.markdown b/source/_components/switch.fritzbox.markdown new file mode 100644 index 0000000000..83657be0c8 --- /dev/null +++ b/source/_components/switch.fritzbox.markdown @@ -0,0 +1,31 @@ +--- +layout: page +title: "Fritzbox Switch" +description: "Instructions on how to integrate the AVM Fritzbox switch." +date: 2017-11-12 17:10 +sidebar: true +comments: false +sharing: true +footer: true +logo: avm.png +ha_category: Switch +ha_release: 0.68 +ha_iot_class: "Local Polling" +--- + +

+To get AVM Fritzbox switch follow the instructions for the general [Fritzbox](/components/fritzbox/). +

+ +### {% linkable_title Attributes %} + +The are several attributes that can be useful for automations and templates. + +| Attribute | Description | +| --------- | ----------- | +| `device_locked` | The state of the key lock at the device. +| `locked` | The state of the lock for configuring the device via the app or the Fritzbox web interface. +| `temperature_unit` | The unit of the temperature sensor (only available if the device support temperature sensor). +| `temperature` | The current temperature sensor reading (only available if the device supports temperature sensor). +| `total_consumption` | The total power consumption since the beginning of operation (only available if the device supports power meter function). +| `total_consumption_unit` | The unit of the total_consumption (only available if the device supports power meter function). diff --git a/source/_components/switch.fritzdect.markdown b/source/_components/switch.fritzdect.markdown index 96c46f29e8..380deebdaf 100644 --- a/source/_components/switch.fritzdect.markdown +++ b/source/_components/switch.fritzdect.markdown @@ -1,7 +1,7 @@ --- layout: page title: "AVM FRITZ!DECT Switch" -description: "Instructions how to integrate your AVM FRITZ!DECT switches into Home Assistant." +description: "Instructions on how to integrate your AVM FRITZ!DECT switches into Home Assistant." date: 2017-01-24 21:00 sidebar: true comments: false @@ -35,13 +35,23 @@ switch: password: YOUR_PASSWORD ``` -Configuration variables: +{% configuration %} +username: + description: The username for your Fritz!Box. + required: true + type: string +password: + description: The password for your Fritz!Box. + required: true + type: string +host: + description: The IP address/hostname of your Fritz!Box. + required: false + type: string + default: fritz.box +{% endconfiguration %} -- **username** (*Required*): The username for your Fritz!Box. -- **password** (*Required*): The password for your Fritz!Box. -- **host** (*Optional*): The IP address/hostname of your Fritz!Box. Defaults to `fritz.box`. - -It is recommened to create a dedicated user for Home Assistant and only allow access to "Smart Home". +It is recommended to create a dedicated user for Home Assistant and only allow access to "Smart Home".

If this component throws an error when starting home-assistant you should check if all actors are plugged in and connected to the FritzBox. Inactive actors that are not deleted from FritzBox configuration might lead to errors. diff --git a/source/_components/switch.hikvisioncam.markdown b/source/_components/switch.hikvisioncam.markdown index 85249cd681..64fc873989 100644 --- a/source/_components/switch.hikvisioncam.markdown +++ b/source/_components/switch.hikvisioncam.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Hikvision Camera Switch" -description: "Instructions how to integrate Hikvision camera switches into Home Assistant." +description: "Instructions on how to integrate Hikvision camera switches into Home Assistant." date: 2015-06-10 22:54 sidebar: true comments: false diff --git a/source/_components/switch.hive.markdown b/source/_components/switch.hive.markdown index 8f7d867722..e4ea483797 100644 --- a/source/_components/switch.hive.markdown +++ b/source/_components/switch.hive.markdown @@ -14,10 +14,11 @@ ha_iot_class: "Cloud Polling" --- -The 'hive' switch component integrates your Hive plugs into Home Assistant, enabling control of your devices. +The `hive` switch platform integrates your Hive plugs into Home Assistant, enabling control of your devices. -The Hive switch component supports the following Hive products: -- **Hive Active Plug** +The platform supports the following Hive products: + +- Hive Active Plug

diff --git a/source/_components/switch.homekit_controller.markdown b/source/_components/switch.homekit_controller.markdown new file mode 100644 index 0000000000..43bf3be57b --- /dev/null +++ b/source/_components/switch.homekit_controller.markdown @@ -0,0 +1,16 @@ +--- +layout: page +title: "HomeKit Switch" +description: "Instructions on how to setup HomeKit switches within Home Assistant." +date: 2017-03-19 21:08 +sidebar: true +comments: false +sharing: true +footer: true +logo: apple-homekit.png +ha_category: Light +ha_iot_class: "Local Polling" +ha_release: 0.68 +--- + +To get your HomeKit switches working with Home Assistant, follow the instructions for the general [HomeKit controller component](/components/homekit_controller/). diff --git a/source/_components/switch.homematic.markdown b/source/_components/switch.homematic.markdown index 3e3fd7e878..7902ae4974 100644 --- a/source/_components/switch.homematic.markdown +++ b/source/_components/switch.homematic.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Homematic Switch" -description: "Instructions how to integrate Homematic switches within Home Assistant." +description: "Instructions on how to integrate Homematic switches within Home Assistant." date: 2016-06-28 08:30 sidebar: true comments: false diff --git a/source/_components/switch.hook.markdown b/source/_components/switch.hook.markdown index 3ba23b8c19..fbfeef75b4 100644 --- a/source/_components/switch.hook.markdown +++ b/source/_components/switch.hook.markdown @@ -20,23 +20,44 @@ In short, Hook is an RF to Wi-Fi bridge, controlling devices that receive comman Hook provides a simple [REST API](https://app.swaggerhub.com/api/rahilj/GetHook_RestAPI/v1). This Home Assistant component reads in devices that have been set up in the official app. +## {% linkable_title Configuration %} + Configure with either your username/password or your API token for the official app. +To enable this platform in your installation, add the following to your `configuration.yaml` file: + ```yaml # Example configuration.yaml entry switch: - - platform: hook - username: - password: !secret hook + - platform: hook + username: YOUR_E_MAIL_ADDRESS + password: YOUR_HOOK ``` + Or + ```yaml # Example configuration.yaml entry switch: - - platform: hook - token: + - platform: hook + token: YOUR_API_TOKEN ``` +{% configuration %} +username: + description: The email address associated with your Hook Smart Home Hub. + required: true + type: string +password: + description: The password for your Hook Smart Home Hub. + required: true + type: string +token: + description: The API token for your Hook Smart Home Hub. + required: true + type: string +{% endconfiguration %} + Extra debug logging is available, if you need it. ```yaml diff --git a/source/_components/switch.ihc.markdown b/source/_components/switch.ihc.markdown index 011ef33a02..67abf63932 100644 --- a/source/_components/switch.ihc.markdown +++ b/source/_components/switch.ihc.markdown @@ -1,7 +1,7 @@ --- layout: page title: "IHC Switch" -description: "Instructions how to integrate IHC switches within Home Assistant." +description: "Instructions on how to integrate IHC switches within Home Assistant." date: 2017-11-27 13:35 sidebar: true comments: false diff --git a/source/_components/switch.insteon_local.markdown b/source/_components/switch.insteon_local.markdown index 0d8c71aa8d..8a3c3f9360 100644 --- a/source/_components/switch.insteon_local.markdown +++ b/source/_components/switch.insteon_local.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Insteon (Local) Switch" -description: "Instructions how to setup the Insteon Hub switches locally within Home Assistant." +description: "Instructions on how to setup the Insteon Hub switches locally within Home Assistant." date: 2016-12-18 08:00 sidebar: true comments: false diff --git a/source/_components/switch.insteon_plm.markdown b/source/_components/switch.insteon_plm.markdown index 0db0d143cc..8843679bb0 100644 --- a/source/_components/switch.insteon_plm.markdown +++ b/source/_components/switch.insteon_plm.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Insteon PLM Switch" -description: "Instructions how to setup the Insteon PLM switches locally within Home Assistant." +description: "Instructions on how to setup the Insteon PLM switches locally within Home Assistant." date: 2017-02-19 17:00 sidebar: true comments: false diff --git a/source/_components/switch.isy994.markdown b/source/_components/switch.isy994.markdown index e5b4249dd6..eacf1a002d 100644 --- a/source/_components/switch.isy994.markdown +++ b/source/_components/switch.isy994.markdown @@ -1,7 +1,7 @@ --- layout: page title: "ISY994 Switch" -description: "Instructions how to integrate ISY994 switch into Home Assistant." +description: "Instructions on how to integrate ISY994 switch into Home Assistant." date: 2016-09-03 23:00 sidebar: true comments: false diff --git a/source/_components/switch.kankun.markdown b/source/_components/switch.kankun.markdown index 03c5a217ed..919b798f9d 100644 --- a/source/_components/switch.kankun.markdown +++ b/source/_components/switch.kankun.markdown @@ -15,7 +15,7 @@ ha_iot_class: "Local Polling" The `kankun` switch platform allows you to toggle customized Kankun SP3 Wifi switches. Switches are modified to include the [json.cgi](https://github.com/homedash/kankun-json/blob/master/cgi-bin/json.cgi) -script to provide a HTTP API. Details of the necessary modifications can be found +script to provide an HTTP API. Details of the necessary modifications can be found [here](http://www.homeautomationforgeeks.com/openhab_http.shtml#kankun) (be sure to install the JSON version of the script as linked above). diff --git a/source/_components/switch.litejet.markdown b/source/_components/switch.litejet.markdown index 22c4d9d65f..34f90d9bad 100644 --- a/source/_components/switch.litejet.markdown +++ b/source/_components/switch.litejet.markdown @@ -1,7 +1,7 @@ --- layout: page title: "LiteJet Switch" -description: "Instructions how to setup the LiteJet switches within Home Assistant." +description: "Instructions on how to setup the LiteJet switches within Home Assistant." date: 2016-10-26 13:00 sidebar: true comments: false diff --git a/source/_components/switch.lutron_caseta.markdown b/source/_components/switch.lutron_caseta.markdown index 428006a56f..100e044b1b 100644 --- a/source/_components/switch.lutron_caseta.markdown +++ b/source/_components/switch.lutron_caseta.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Lutron Caseta Switch" -description: "Instructions how to setup the Lutron Caseta switches within Home Assistant." +description: "Instructions on how to setup the Lutron Caseta switches within Home Assistant." date: 2017-04-30 09:00 sidebar: true comments: false diff --git a/source/_components/switch.markdown b/source/_components/switch.markdown index 73a98c47c1..54fb891d5c 100644 --- a/source/_components/switch.markdown +++ b/source/_components/switch.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Switches" -description: "Instructions how to setup your switches with Home Assistant." +description: "Instructions on how to setup your switches with Home Assistant." date: 2015-01-24 14:39 sidebar: true comments: false diff --git a/source/_components/switch.mfi.markdown b/source/_components/switch.mfi.markdown index 62f6ed84d2..f82e580257 100644 --- a/source/_components/switch.mfi.markdown +++ b/source/_components/switch.mfi.markdown @@ -1,7 +1,7 @@ --- layout: page title: "mFi Switch" -description: "Instructions how to integrate mFi switches within Home Assistant." +description: "Instructions on how to integrate mFi switches within Home Assistant." date: 2016-02-07 10:00 sidebar: true comments: false @@ -15,15 +15,17 @@ ha_iot_class: "Local Polling" The `mfi` switch platform to allow you to control [mFi Controllable Power Outlets](https://www.ubnt.com/mfi/mpower/). +## {% linkable_title Configuration %} + To add this platform to your installation, add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry switch: - platform: mfi - host: IP_ADDRESS - username: USERNAME - password: PASSWORD + host: IP_ADDRESS_OF_SWITCH + username: YOUR_USERNAME + password: YOUR_PASSWORD ``` Configuration variables: diff --git a/source/_components/switch.mochad.markdown b/source/_components/switch.mochad.markdown index 383e91bacd..a1d7569ec1 100644 --- a/source/_components/switch.mochad.markdown +++ b/source/_components/switch.mochad.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Mochad Switch" -description: "Instructions how to integrate X10 Mochad switches into Home Assistant." +description: "Instructions on how to integrate X10 Mochad switches into Home Assistant." date: 2016-10-20 21:13 sidebar: true comments: false @@ -14,10 +14,12 @@ ha_release: 0.32 The `mochad` switch platform lets you control an X10 enabled switch device. +## {% linkable_title Configuration %} + To enable this sensor, you first have to set up the [mochad component](/components/mochad/) and then add the following to your `configuration.yaml` file: ```yaml -# Example configuration.yml entry +# Example configuration.yaml entry switch: - platform: mochad devices: @@ -31,3 +33,5 @@ Configuration variables: - **name** (*Optional*): The name of the switch. Default is: x10_switch_dev_*address*. - **comm_type** (*Optional*): pl (powerline) or rf (radio frequency). Default is pl. + + diff --git a/source/_components/switch.modbus.markdown b/source/_components/switch.modbus.markdown index bac21bbd81..3bf176c125 100644 --- a/source/_components/switch.modbus.markdown +++ b/source/_components/switch.modbus.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Modbus Switch" -description: "Instructions how to integrate Modbus switches into Home Assistant." +description: "Instructions on how to integrate Modbus switches into Home Assistant." date: 2015-08-30 23:38 sidebar: true comments: false @@ -16,10 +16,12 @@ ha_iot_class: "Local Push" The `modbus` switch platform allows you to control [Modbus](http://www.modbus.org/) coils or registers. +## {% linkable_title Configuration %} + To use your Modbus switches in your installation, add the following to your `configuration.yaml` file: ```yaml -# Example configuration.yml entry +# Example configuration.yaml entry switch: platform: modbus slave: 1 diff --git a/source/_components/switch.mqtt.markdown b/source/_components/switch.mqtt.markdown index 17430c9c8f..295ae106db 100644 --- a/source/_components/switch.mqtt.markdown +++ b/source/_components/switch.mqtt.markdown @@ -1,7 +1,7 @@ --- layout: page title: "MQTT Switch" -description: "Instructions how to integrate MQTT switches into Home Assistant." +description: "Instructions on how to integrate MQTT switches into Home Assistant." date: 2015-08-30 23:38 sidebar: true comments: false @@ -15,6 +15,8 @@ ha_iot_class: depends The `mqtt` switch platform lets you control your MQTT enabled switches. +## {% linkable_title Configuration %} + In an ideal scenario, the MQTT device will have a `state_topic` to publish state changes. If these messages are published with a `RETAIN` flag, the MQTT switch will receive an instant state update after subscription, and will start with the correct state. Otherwise, the initial state of the switch will be `false` / `off`. When a `state_topic` is not available, the switch will work in optimistic mode. In this mode, the switch will immediately change state after every command. Otherwise, the switch will wait for state confirmation from the device (message from `state_topic`). @@ -24,7 +26,7 @@ Optimistic mode can be forced, even if the `state_topic` is available. Try to en To enable this switch in your installation, add the following to your `configuration.yaml` file: ```yaml -# Example configuration.yml entry +# Example configuration.yaml entry switch: - platform: mqtt command_topic: "home/bedroom/switch1/set" @@ -36,6 +38,10 @@ name: required: false type: string default: MQTT Switch +icon: + description: Icon for the switch (e.g. `mdi:radiator`). + required: false + type: string state_topic: description: The MQTT topic subscribed to receive state updates. required: false @@ -102,7 +108,7 @@ In this section you will find some real life examples of how to use this sensor. The example below shows a full configuration for a switch. ```yaml -# Example configuration.yml entry +# Example configuration.yaml entry switch: - platform: mqtt name: "Bedroom Switch" @@ -136,7 +142,7 @@ The configuration will look like the example below: {% raw %} ```yaml -# Example configuration.yml entry +# Example configuration.yaml entry switch: - platform: mqtt name: bathroom diff --git a/source/_components/switch.mysensors.markdown b/source/_components/switch.mysensors.markdown index d383e68b7d..a0fffa84e3 100644 --- a/source/_components/switch.mysensors.markdown +++ b/source/_components/switch.mysensors.markdown @@ -1,7 +1,7 @@ --- layout: page title: "MySensors Switch" -description: "Instructions how to integrate MySensors switches into Home Assistant." +description: "Instructions on how to integrate MySensors switches into Home Assistant." date: 2016-10-01 15:00 +0200 sidebar: true comments: false diff --git a/source/_components/switch.mystrom.markdown b/source/_components/switch.mystrom.markdown index 6fafcbbb78..924087adcd 100644 --- a/source/_components/switch.mystrom.markdown +++ b/source/_components/switch.mystrom.markdown @@ -1,7 +1,7 @@ --- layout: page title: "myStrom Switch" -description: "Instructions how to integrate myStrom switches into Home Assistant." +description: "Instructions on how to integrate myStrom switches into Home Assistant." date: 2015-11-25 22:00 sidebar: true comments: false diff --git a/source/_components/switch.neato.markdown b/source/_components/switch.neato.markdown index b45fa7f5f2..2f0e1e8d1e 100644 --- a/source/_components/switch.neato.markdown +++ b/source/_components/switch.neato.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Neato Robotics Switch" -description: "Instructions how to integrate a Neato Botvac Connected switch within Home Assistant." +description: "Instructions on how to integrate a Neato Botvac Connected switch within Home Assistant." date: 2016-10-19 17:10 sidebar: true comments: false diff --git a/source/_components/switch.netio.markdown b/source/_components/switch.netio.markdown index 57f5a5abdb..f5c4a9742f 100644 --- a/source/_components/switch.netio.markdown +++ b/source/_components/switch.netio.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Netio Switch" -description: "Instructions how to integrate Netio switches into Home Assistant." +description: "Instructions on how to integrate Netio switches into Home Assistant." date: 2016-09-02 19:00 sidebar: true comments: false diff --git a/source/_components/switch.orvibo.markdown b/source/_components/switch.orvibo.markdown index 30516626df..656bcd4a22 100644 --- a/source/_components/switch.orvibo.markdown +++ b/source/_components/switch.orvibo.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Orvibo Switch" -description: "Instructions how to integrate Orvibo sockets within Home Assistant." +description: "Instructions on how to integrate Orvibo sockets within Home Assistant." date: 2015-11-15 18:15 sidebar: true comments: false diff --git a/source/_components/switch.pilight.markdown b/source/_components/switch.pilight.markdown index 8c803184a4..ca2c837986 100644 --- a/source/_components/switch.pilight.markdown +++ b/source/_components/switch.pilight.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Pilight Switch" -description: "Instructions how to have switches using 433 MHz connected to a computer running pilight." +description: "Instructions on how to have switches using 433 MHz connected to a computer running pilight." date: 2015-06-10 22:41 sidebar: true comments: false @@ -19,6 +19,8 @@ Additionally, RF commands can be defined that trigger this switch to turn on and To be really sure that Home Assistant knows the actual state of your device it is recommended to use the RF remote with codes unknown to any of your 433 MHz devices. Thus you use the remote to trigger this switch to send the correct RF code to the device. +## {% linkable_title Configuration %} + To define a Pilight switch, add the following lines to your `configuration.yaml`: ```yaml diff --git a/source/_components/switch.pulseaudio_loopback.markdown b/source/_components/switch.pulseaudio_loopback.markdown index 138dd949bc..6248f9910e 100644 --- a/source/_components/switch.pulseaudio_loopback.markdown +++ b/source/_components/switch.pulseaudio_loopback.markdown @@ -1,7 +1,7 @@ --- layout: page title: "PulseAudio Loopback Switch" -description: "Instructions how to use Pulseaudio loopback modules to build a flexible whole-home audio system." +description: "Instructions on how to use Pulseaudio loopback modules to build a flexible whole-home audio system." date: 2016-03-22 21:00:00 sidebar: true comments: false diff --git a/source/_components/switch.qwikswitch.markdown b/source/_components/switch.qwikswitch.markdown index 9b07aa24d0..805e47d5fe 100644 --- a/source/_components/switch.qwikswitch.markdown +++ b/source/_components/switch.qwikswitch.markdown @@ -1,7 +1,7 @@ --- layout: page title: "QwikSwitch Switch" -description: "Instructions how to integrate QwikSwitch relays into Home Assistant." +description: "Instructions on how to integrate QwikSwitch relays into Home Assistant." date: 2016-05-04 00:00 sidebar: true comments: false diff --git a/source/_components/switch.rachio.markdown b/source/_components/switch.rachio.markdown index e04bb7da70..9208a2d475 100644 --- a/source/_components/switch.rachio.markdown +++ b/source/_components/switch.rachio.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Rachio Switch" -description: "Instructions how to use Rachio switches with Home Assistant." +description: "Instructions on how to use Rachio switches with Home Assistant." date: 2017-05-29 09:00 sidebar: true comments: false diff --git a/source/_components/switch.rainbird.markdown b/source/_components/switch.rainbird.markdown index eee1d471b9..673c4d1928 100644 --- a/source/_components/switch.rainbird.markdown +++ b/source/_components/switch.rainbird.markdown @@ -15,20 +15,24 @@ ha_iot_class: "Local Polling" This `rainbird` switch platform allows interacting with [LNK WiFi](http://www.rainbird.com/landscape/products/controllers/LNK-WiFi.htm) module of the Rain Bird Irrigation system in Home Assistant. +## {% linkable_title Configuration %} + Once you have enabled the [Rain Bird component](/components/rainbird), add the following to your `configuration.yaml` file: ```yaml switch: - sprinkler_1: - zone: 1 - friendly_name: "Front sprinklers" - trigger_time: 20 - scan_interval: 10 - sprinkler_2: - friendly_name: "Back sprinklers" - zone: 2 - trigger_time: 20 - scan_interval: 10 + - platform: rainbird + switches: + sprinkler_1: + zone: 1 + friendly_name: "Front sprinklers" + trigger_time: 10 + scan_interval: 10 + sprinkler_2: + friendly_name: "Back sprinklers" + zone: 2 + trigger_time: 20 + scan_interval: 10 ``` Configuration variables: diff --git a/source/_components/switch.raincloud.markdown b/source/_components/switch.raincloud.markdown index e5cbc2d070..2e2af72de8 100644 --- a/source/_components/switch.raincloud.markdown +++ b/source/_components/switch.raincloud.markdown @@ -25,7 +25,7 @@ switch: Configuration variables: -- **watering_minutes** (*Optional*): Value in minutes to watering your garden via frontend. Defaults to 15. +- **watering_minutes** (*Optional*): Value in minutes to watering your garden via frontend. Defaults to 15. The values allowed are: 5, 10, 15, 30, 45, 60. - **monitored_conditions** array (*Optional*): Conditions to display in the frontend. If not specified, all conditions below will be enabled by default. The following conditions can be monitored. - **auto_watering**: Toggle the watering scheduled per zone. - **manual_watering**: Toggle manually the watering per zone. It will inherent the value in minutes specified on the RainCloud hub component. diff --git a/source/_components/switch.rainmachine.markdown b/source/_components/switch.rainmachine.markdown index 1b85b03aa4..f37ce0fbd5 100644 --- a/source/_components/switch.rainmachine.markdown +++ b/source/_components/switch.rainmachine.markdown @@ -13,77 +13,24 @@ ha_iot_class: "Cloud Polling" ha_release: 0.51 --- -The `rainmachine` switch platform allows you to control programs and zones within -a [RainMachine smart Wi-Fi sprinkler controller](http://www.rainmachine.com/). +The `rainmachine` switch platform allows you to control programs and zones +within a [RainMachine smart Wi-Fi sprinkler controller](http://www.rainmachine.com/). -## {% linkable_title Configuring the Platform %} - -The platform allows for either local (i.e., directly across the LAN) or remote -(i.e., through RainMachine's cloud API) access; the route you choose will -dictate what your configuration should look like. - -For local access, specify the IP address/hostname of your RainMachine unit -, your RainMachine password, and optionally, the device's HTTP port: - -```yaml -switch: - platform: rainmachine - ip_address: 192.168.1.100 - password: my_password_123 -``` - -For remote access, specify your RainMachine username/email and password: - -```yaml -switch: - platform: rainmachine - email: user@host.com - password: my_password_123 -``` - -Configuration Variables: - -- **ip_address** (*Optional*): the IP address of your RainMachine unit; cannot be -used with the `email` parameter -- **email** (*Optional*): your RainMachine username/email; cannot be used with the -`ip_address` parameter -- **password** (*Required*): your RainMachine password -- **port** (*Optional*): the TCP port used by your unit for the REST API (default: 8080) -- **ssl** (*Optional*): whether communication with the local device should occur -over HTTPS (default: true) -- **zone_run_time** (*Optional*): the number of seconds that a zone should run when -turned on (default: 600) +

+You must have the [RainMachine component](https://www.home-assistant.io/components/rainmachine/) +configured to use this switch. After configuring that component, switches will +automatically appear. +

## {% linkable_title Controlling Your Device %} -After Home Assistant loads, you will see new switches for every enabled program -and zone. These work as expected: +After Home Assistant loads, new switches will be added for every enabled +program and zone. These work as expected: - Program On/Off: starts/stops a program - Zone On/Off: starts/stops a zone (using the `zone_run_time` parameter to determine how long to run for) -Programs and zones are linked. If a program is running its final zone, you will -see both the program and zone switches turned on; turning either one off will -turn the other one off (just like in the web app). - -## {% linkable_title Weblink %} - -If you would like to see and control more detailed information, create an [iFrame](/components/panel_iframe/) that renders the RainMachine web app: - -```yaml -panel_iframe: - rainmachine: - title: RainMachine - url: "https://my.rainmachine.com/s//ui/" - icon: mdi:water-pump -``` - -You can find `` by logging into [https://my.rainmachine.com](https://my.rainmachine.com ) and taking note of the URL. - -## {% linkable_title For Awareness %} - -The remote RainMachine API currently has two broken operations (i.e., they return -error codes): starting a program and stopping a program. Please note that -starting/stopping programs with the remote API is disabled until RainMachine -can fix the issue. +Programs and zones are linked. While a program is running, you will see both +the program and zone switches turned on; turning either one off will turn the +other one off (just like in the web app). diff --git a/source/_components/switch.raspihats.markdown b/source/_components/switch.raspihats.markdown index 23f7afb96f..f31a33edaa 100644 --- a/source/_components/switch.raspihats.markdown +++ b/source/_components/switch.raspihats.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Raspihats Switch" -description: "Instructions how to integrate Raspihats add-on boards for Raspberry Pi into Home Assistant as a switch." +description: "Instructions on how to integrate Raspihats add-on boards for Raspberry Pi into Home Assistant as a switch." date: 2017-05-15 04:20 sidebar: true comments: false diff --git a/source/_components/switch.rest.markdown b/source/_components/switch.rest.markdown index 776882cd54..65f0afcd3e 100644 --- a/source/_components/switch.rest.markdown +++ b/source/_components/switch.rest.markdown @@ -1,7 +1,7 @@ --- layout: page title: "RESTful Switch" -description: "Instructions how to integrate REST switches into Home Assistant." +description: "Instructions on how to integrate REST switches into Home Assistant." date: 2015-09-14 19:10 sidebar: true comments: false @@ -13,9 +13,10 @@ ha_release: 0.7.6 ha_iot_class: "Local Polling" --- - The `rest` switch platform allows you to control a given endpoint that supports a [RESTful API](https://en.wikipedia.org/wiki/Representational_state_transfer). The switch can get the state via GET and set the state via POST on a given REST resource. +## {% linkable_title Configuration %} + To enable this switch, add the following lines to your `configuration.yaml` file: ```yaml @@ -30,17 +31,16 @@ resource: description: The resource or endpoint that contains the value. required: true type: string - default: string method: description: "The method of the request. Supported `post` or `put`." required: false type: string - default: POST + default: post name: description: Name of the REST Switch. required: false type: string - default: REST Binary Switch + default: REST Switch timeout: description: Timeout for the request. required: false @@ -68,6 +68,10 @@ password: description: The password for accessing the REST endpoint. required: false type: string +headers: + description: The headers for the request. + required: false + type: list, string {% endconfiguration %}

@@ -78,21 +82,23 @@ Make sure that the URL matches exactly your endpoint or resource. ### {% linkable_title Switch with templated value %} -This example shows a switch that uses a [template](/topics/templating/) to allow Home Assistant to determine its state. In this example the REST endpoint returns this JSON response with true indicating the switch is on. +This example shows a switch that uses a [template](/topics/templating/) to allow Home Assistant to determine its state. In this example, the REST endpoint returns this JSON response with true indicating the switch is on. ```json {"is_active": "true"} ``` - +{% raw %} ```yaml switch: - platform: rest resource: http://IP_ADDRESS/led_endpoint body_on: '{"active": "true"}' body_off: '{"active": "false"}' - is_on_template: '{% raw %}{{value_json.is_active}}{% endraw %}' + is_on_template: '{{ value_json.is_active }}' + headers: + Content-Type: application/json ``` +{% endraw %} `body_on` and `body_off` can also depend on the state of the system. For example, to enable a remote temperature sensor tracking on a radio thermostat, one has to send the current value of the remote temperature sensor. This can be achieved by using the template `{% raw %}'{"rem_temp":{{states.sensor.bedroom_temp.state}}}'{% endraw %}`. - diff --git a/source/_components/switch.rflink.markdown b/source/_components/switch.rflink.markdown index 08b5e61458..ee42e8bbd7 100644 --- a/source/_components/switch.rflink.markdown +++ b/source/_components/switch.rflink.markdown @@ -1,7 +1,7 @@ --- layout: page title: "RFLink Switch" -description: "Instructions how to integrate RFLink switches into Home Assistant." +description: "Instructions on how to integrate RFLink switches into Home Assistant." date: 2016-01-04 sidebar: true comments: false diff --git a/source/_components/switch.rfxtrx.markdown b/source/_components/switch.rfxtrx.markdown index 434a4c4563..52b58ab4a6 100644 --- a/source/_components/switch.rfxtrx.markdown +++ b/source/_components/switch.rfxtrx.markdown @@ -1,7 +1,7 @@ --- layout: page title: "RFXtrx Switch" -description: "Instructions how to integrate RFXtrx switches into Home Assistant." +description: "Instructions on how to integrate RFXtrx switches into Home Assistant." date: 2015-10-08 10:15 sidebar: true comments: false diff --git a/source/_components/switch.rpi_gpio.markdown b/source/_components/switch.rpi_gpio.markdown index 9f50d12987..5b3a888e24 100644 --- a/source/_components/switch.rpi_gpio.markdown +++ b/source/_components/switch.rpi_gpio.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Raspberry Pi GPIO Switch" -description: "Instructions how to integrate the GPIO of a Raspberry Pi into Home Assistant as a switch." +description: "Instructions on how to integrate the GPIO of a Raspberry Pi into Home Assistant as a switch." date: 2015-08-07 14:00 sidebar: true comments: false diff --git a/source/_components/switch.rpi_pfio.markdown b/source/_components/switch.rpi_pfio.markdown index d8e77e79fa..30498f7d99 100644 --- a/source/_components/switch.rpi_pfio.markdown +++ b/source/_components/switch.rpi_pfio.markdown @@ -1,7 +1,7 @@ --- layout: page title: "PiFace Digital I/O Switch" -description: "Instructions how to integrate the PiFace Digital I/O module into Home Assistant as a switch." +description: "Instructions on how to integrate the PiFace Digital I/O module into Home Assistant as a switch." date: 2016-05-08 15:00 sidebar: true comments: false diff --git a/source/_components/switch.rpi_rf.markdown b/source/_components/switch.rpi_rf.markdown index 2d412034f5..b9813ceb56 100644 --- a/source/_components/switch.rpi_rf.markdown +++ b/source/_components/switch.rpi_rf.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Raspberry Pi RF Switch" -description: "Instructions how to integrate devices controlled via codes sent with low-cost GPIO RF modules on a Raspberry Pi into Home Assistant as a switch." +description: "Instructions on how to integrate devices controlled via codes sent with low-cost GPIO RF modules on a Raspberry Pi into Home Assistant as a switch." date: 2016-05-10 09:00 sidebar: true comments: false diff --git a/source/_components/switch.scsgate.markdown b/source/_components/switch.scsgate.markdown index 07ff2d6005..35e1f6b7f8 100644 --- a/source/_components/switch.scsgate.markdown +++ b/source/_components/switch.scsgate.markdown @@ -1,7 +1,7 @@ --- layout: page title: "SCSGate Switch" -description: "Instructions how to integrate SCSGate switches into Home Assistant." +description: "Instructions on how to integrate SCSGate switches into Home Assistant." date: 2016-01-31 22:15 sidebar: true comments: false diff --git a/source/_components/switch.smappee.markdown b/source/_components/switch.smappee.markdown index 58db20afac..0576738e51 100644 --- a/source/_components/switch.smappee.markdown +++ b/source/_components/switch.smappee.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Smappee Switch" -description: "Instructions how to integrate Smappee Comfort Plug into Home Assistant." +description: "Instructions on how to integrate Smappee Comfort Plug into Home Assistant." date: 2018-02-26 08:37 sidebar: true comments: false diff --git a/source/_components/switch.tahoma.markdown b/source/_components/switch.tahoma.markdown new file mode 100644 index 0000000000..a7c3338fee --- /dev/null +++ b/source/_components/switch.tahoma.markdown @@ -0,0 +1,17 @@ +--- +layout: page +title: "Tahoma Switch" +description: "Instructions on how to integrate Tahoma switches into Home Assistant." +date: 2017-07-18 12:00 +sidebar: true +comments: false +sharing: true +footer: true +logo: tahoma.png +ha_category: Sensor +ha_release: 0.59 +--- + +The `tahoma` switch platform lets you see switches added to your Tahoma Box in Home Assistant. + +Switches will be added automatically. Please refer to the [component](/components/tahoma/) configuration on how to setup Tahoma. diff --git a/source/_components/switch.tellduslive.markdown b/source/_components/switch.tellduslive.markdown index 4477289a87..1cfa2c6fc8 100644 --- a/source/_components/switch.tellduslive.markdown +++ b/source/_components/switch.tellduslive.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Telldus Live Switch" -description: "Instructions how to integrate Telldus Live switches into Home Assistant." +description: "Instructions on how to integrate Telldus Live switches into Home Assistant." date: 2016-01-17 15:49 sidebar: true comments: false diff --git a/source/_components/switch.tellstick.markdown b/source/_components/switch.tellstick.markdown index 9c1ed88d73..9de976af4b 100644 --- a/source/_components/switch.tellstick.markdown +++ b/source/_components/switch.tellstick.markdown @@ -1,7 +1,7 @@ --- layout: page title: "TellStick Switch" -description: "Instructions how to integrate TellStick switches into Home Assistant." +description: "Instructions on how to integrate TellStick switches into Home Assistant." date: 2015-08-06 19:00 sidebar: true comments: false @@ -15,7 +15,7 @@ ha_iot_class: "Assumed State" This `tellstick` switch platform allows you to control [TellStick](http://www.telldus.se/products/tellstick) devices. -To use your TellStick device, you first have to set up your [Tellstick hub](https://home-assistant.io/components/tellstick/) and then add the following to your `configuration.yaml` file: +To use your TellStick device, you first have to set up your [Tellstick hub](/components/tellstick/) and then add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry diff --git a/source/_components/switch.telnet.markdown b/source/_components/switch.telnet.markdown index bffd8e78fb..ef1345cd5b 100644 --- a/source/_components/switch.telnet.markdown +++ b/source/_components/switch.telnet.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Telnet Switch" -description: "Instructions how to integrate telnet switches into Home Assistant." +description: "Instructions on how to integrate telnet switches into Home Assistant." date: 2017-08-10 19:19 sidebar: true comments: false @@ -39,6 +39,6 @@ Configuration variables: - **port** (*Optional*): Port to connect to. Default is 23 if not defined. - **command_on** (*Required*): Command to turn device on. - **command_off** (*Required*): Command to turn device off. - - **command_state** (*Required*): Command to determine the state of the switch. If not defined the switch will assume successful state changes. - - **value_template** (*Required*): The template evaluating to `true` will indicate that the switch is on. + - **command_state** (*Optional*): Command to determine the state of the switch. If not defined the switch will assume successful state changes. + - **value_template** (*Optional*): The template evaluating to `true` will indicate that the switch is on. - **name** (*Optional*): The name used to display the switch in the frontend. diff --git a/source/_components/switch.template.markdown b/source/_components/switch.template.markdown index 3568915ccc..cfcb54d092 100644 --- a/source/_components/switch.template.markdown +++ b/source/_components/switch.template.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Template Switch" -description: "Instructions how to integrate Template Switches into Home Assistant." +description: "Instructions on how to integrate Template Switches into Home Assistant." date: 2016-02-07 07:00 sidebar: true comments: false @@ -75,6 +75,10 @@ switch: description: Defines a template for the icon of the switch. required: false type: template + entity_picture_template: + description: Defines a template for the picture of the switch. + required: false + type: template {% endconfiguration %} ## {% linkable_title Considerations %} diff --git a/source/_components/switch.tesla.markdown b/source/_components/switch.tesla.markdown index a8c63ede4e..2ded4d7d10 100644 --- a/source/_components/switch.tesla.markdown +++ b/source/_components/switch.tesla.markdown @@ -13,7 +13,7 @@ ha_iot_class: "Cloud Push" ha_release: 0.54 --- -The `Tesla` platform allows you to control your [Tesla](https://www.tesla.com/) charger (enable/disable charging) from within Home Assistant. +The `Tesla` platform allows you to control your [Tesla](https://www.tesla.com/) charger (enable/disable charging, max range switch) from within Home Assistant. The switch platform will be automatically configured if Tesla component is configured. diff --git a/source/_components/switch.thinkingcleaner.markdown b/source/_components/switch.thinkingcleaner.markdown index 8be94f7992..30a937f212 100644 --- a/source/_components/switch.thinkingcleaner.markdown +++ b/source/_components/switch.thinkingcleaner.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Thinking Cleaner Switch" -description: "Instructions how to integrate a ThinkingCleaner switches within Home Assistant." +description: "Instructions on how to integrate a ThinkingCleaner switches within Home Assistant." date: 2016-04-10 17:24 sidebar: true comments: false diff --git a/source/_components/switch.toon.markdown b/source/_components/switch.toon.markdown index af4e197850..744622da78 100644 --- a/source/_components/switch.toon.markdown +++ b/source/_components/switch.toon.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Toon Smart Plugs" -description: "Instructions how to integrate Toon smart plugs within Home Assistant." +description: "Instructions on how to integrate Toon smart plugs within Home Assistant." date: 2017-10-22 12:00 sidebar: true comments: false diff --git a/source/_components/switch.tplink.markdown b/source/_components/switch.tplink.markdown index 5839ff2cef..da0083120b 100644 --- a/source/_components/switch.tplink.markdown +++ b/source/_components/switch.tplink.markdown @@ -1,7 +1,7 @@ --- layout: page title: "TP-Link Switch" -description: "Instructions how to integrate TP-Link switches into Home Assistant." +description: "Instructions on how to integrate TP-Link switches into Home Assistant." date: 2016-07-13 08:00 sidebar: true comments: false diff --git a/source/_components/switch.transmission.markdown b/source/_components/switch.transmission.markdown index 3c9ef39bfa..888f1470a0 100644 --- a/source/_components/switch.transmission.markdown +++ b/source/_components/switch.transmission.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Transmission Switch" -description: "Instructions how to integrate Transmission within Home Assistant." +description: "Instructions on how to integrate Transmission within Home Assistant." date: 2015-06-02 09:00 sidebar: true comments: false diff --git a/source/_components/switch.vera.markdown b/source/_components/switch.vera.markdown index 09dc61b109..e515a8d74c 100644 --- a/source/_components/switch.vera.markdown +++ b/source/_components/switch.vera.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Vera Switch" -description: "Instructions how to integrate Vera switches into Home Assistant." +description: "Instructions on how to integrate Vera switches into Home Assistant." date: 2015-10-20 21:00 sidebar: true comments: false diff --git a/source/_components/switch.verisure.markdown b/source/_components/switch.verisure.markdown index 4169abe98d..c84b3739f8 100644 --- a/source/_components/switch.verisure.markdown +++ b/source/_components/switch.verisure.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Verisure SmartPlug" -description: "Instructions how to setup the Verisure SmartPlug within Home Assistant." +description: "Instructions on how to setup the Verisure SmartPlug within Home Assistant." date: 2016-02-15 22:00 sidebar: true comments: false diff --git a/source/_components/switch.vesync.markdown b/source/_components/switch.vesync.markdown new file mode 100644 index 0000000000..b02f476e93 --- /dev/null +++ b/source/_components/switch.vesync.markdown @@ -0,0 +1,47 @@ +--- +layout: page +title: "VeSync Switch" +description: "Instructions on how to set up Etekcity VeSync switches within Home Assistant." +date: 2018-03-09 02:11 +sidebar: true +comments: false +sharing: true +footer: true +logo: vesync.png +ha_category: Switch +ha_release: 0.66 +--- + +The `vesync` switch platform enables integration with Etekcity VeSync smart switches. + +VeSync switches are low-cost wifi smart plugs that offer energy monitoring and work with popular voice assistants. + +To use your VeSync switches, you must first register your switches with the VeSync app. Once registration is complete you must add the following to your `configuration.yaml` file: + +```yaml +# Example configuration.yaml entry +switch: + - platform: vesync + username: YOUR_USERNAME + password: YOUR_PASSWORD +``` + +{% configuration %} +username: + description: Username needed to log in to VeSync. + required: true + type: string +password: + description: Password needed to log in to VeSync. + required: true + type: string +{% endconfiguration %} + +### {% linkable_title Exposed Attributes %} + +VeSync switches will expose the following details. + +| Attribute | Description | Example | +| ------------------- | ------------------------------------------------------------------- | --------------- | +| `current_power_w` | The present power consumption of the switch in watts. | 100 | +| `today_energy_kwh` | The kilowatt hours used by the switch during the previous 24 hours. | 0.12 | diff --git a/source/_components/switch.wake_on_lan.markdown b/source/_components/switch.wake_on_lan.markdown index 6fc7699fa7..161cfcd1b5 100644 --- a/source/_components/switch.wake_on_lan.markdown +++ b/source/_components/switch.wake_on_lan.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Wake on LAN Switch" -description: "Instructions how to integrate a wake on lan switch." +description: "Instructions on how to integrate a wake on lan switch." date: 2016-03-18 18:00 sidebar: true comments: false @@ -15,6 +15,8 @@ ha_iot_class: "Local Polling" The `wake_on_lan` (WOL) switch platform allows you to turn on a [WOL](https://en.wikipedia.org/wiki/Wake-on-LAN) enabled computer. +## {% linkable_title Configuration %} +

The WOL switch can only turn on your computer and monitor the state. There is no universal way to turn off a computer remotely. The `turn_off` variable is there to help you call a script when you have figured out how to remotely turn off your computer. See below for suggestions on how to do this. @@ -23,7 +25,7 @@ See below for suggestions on how to do this. To enable this switch in your installation, add the following to your `configuration.yaml` file: ```yaml -# Example configuration.yml entry +# Example configuration.yaml entry switch: - platform: wake_on_lan mac_address: "00-01-02-03-04-05" @@ -42,7 +44,8 @@ Configuration variables: Here are some real life examples of how to use the **turn_off** variable. ### {% linkable_title Suspending Linux %} -Suggested recipe for letting the turn_off script suspend a Linux computer (the **target**) + +Suggested recipe for letting the `turn_off` script suspend a Linux computer (the **target**) from Home Assistant running on another Linux computer (the **server**). 1. On the **server**, log in as the user account Home Assistant is running under. (I'm using `hass` in this example) diff --git a/source/_components/switch.wemo.markdown b/source/_components/switch.wemo.markdown index 7b6a4ae901..6bca30af1a 100644 --- a/source/_components/switch.wemo.markdown +++ b/source/_components/switch.wemo.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Belkin WeMo Switch" -description: "Instructions how to integrate Belkin WeMo switches into Home Assistant." +description: "Instructions on how to integrate Belkin WeMo switches into Home Assistant." date: 2016-02-20 00:47 sidebar: true comments: false diff --git a/source/_components/switch.wink.markdown b/source/_components/switch.wink.markdown index 085aba3a38..9a02607792 100644 --- a/source/_components/switch.wink.markdown +++ b/source/_components/switch.wink.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Wink Switch" -description: "Instructions how to setup the Wink switches within Home Assistant." +description: "Instructions on how to setup the Wink switches within Home Assistant." date: 2015-01-20 22:36 sidebar: true comments: false diff --git a/source/_components/switch.xiaomi_aqara.markdown b/source/_components/switch.xiaomi_aqara.markdown index f207229bee..0306ba2921 100644 --- a/source/_components/switch.xiaomi_aqara.markdown +++ b/source/_components/switch.xiaomi_aqara.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Xiaomi Switch" -description: "Instructions how to setup the Xiaomi switch within Home Assistant." +description: "Instructions on how to setup the Xiaomi switch within Home Assistant." date: 2017-07-21 16:34 sidebar: true comments: false diff --git a/source/_components/switch.xiaomi_miio.markdown b/source/_components/switch.xiaomi_miio.markdown index 7212a74287..6124437209 100644 --- a/source/_components/switch.xiaomi_miio.markdown +++ b/source/_components/switch.xiaomi_miio.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Xiaomi Smart WiFi Socket and Smart Power Strip" -description: "Instructions how to integrate your Xiaomi Smart WiFi Socket aka Plug or Xiaomi Smart Power Strip within Home Assistant." +description: "Instructions on how to integrate your Xiaomi Smart WiFi Socket aka Plug or Xiaomi Smart Power Strip within Home Assistant." date: 2017-08-26 10:18 sidebar: true comments: false @@ -13,12 +13,38 @@ ha_version: 0.56 ha_iot_class: "Local Polling" --- -The `xiaomi_miio` switch platform allows you to control the state of your Xiaomi Smart WiFi Socket aka Plug or Xiaomi Smart Power Strip. - -Currently, the supported features are `on`, `off`. If the device provides the current load, it will be reported. +The `xiaomi_miio` switch platform allows you to control the state of your Xiaomi Smart WiFi Socket aka Plug, Xiaomi Smart Power Strip and Xiaomi Chuangmi Plug V1. Please follow the instructions on [Retrieving the Access Token](/components/vacuum.xiaomi_miio/#retrieving-the-access-token) to get the API token to use in the `configuration.yaml` file. +## Features + +### Xiaomi Smart WiFi Socket + +* Power (on, off) +* Attributes + - Temperature + +### Xiaomi Chuangmi Plug V1 + +* Power (on, off) +* USB (on, off) +* Attributes + - Temperature + +### Xiaomi Smart Power Strip + +* Power (on, off) +* Wifi LED (on, off) +* Power Price (0...999) +* Power Mode (green, normal) (Power Strip V1 only) +* Attributes + - Temperature + - Current + - Load power + - Wifi LED + - Mode (Power Strip V1 only) + To add a plug to your installation, add the following to your `configuration.yaml` file: ```yaml @@ -35,7 +61,7 @@ Configuration variables: - **host** (*Required*): The IP of your miio device. - **token** (*Required*): The API token of your miio device. - **name** (*Optional*): The name of your miio device. -- **model** (*Optional*): The model of your miio device. Valid values are chuangmi.plug.v1`, `qmi.powerstrip.v1`, `zimi.powerstrip.v2`, `chuangmi.plug.m1` and `chuangmi.plug.v2`. This setting can be used to bypass the device model detection and is recommended if your device isn't always available. +- **model** (*Optional*): The model of your miio device. Valid values are `chuangmi.plug.v1`, `qmi.powerstrip.v1`, `zimi.powerstrip.v2`, `chuangmi.plug.m1` and `chuangmi.plug.v2`. This setting can be used to bypass the device model detection and is recommended if your device isn't always available. {% configuration %} host: @@ -56,3 +82,39 @@ model: required: false type: string {% endconfiguration %} + +## {% linkable_title Platform Services %} + +### {% linkable_title Service `switch.xiaomi_miio_set_wifi_led_on` %} (Power Strip only) + +Turn the wifi led on. + +| Service data attribute | Optional | Description | +|---------------------------|----------|---------------------------------------------------------| +| `entity_id` | yes | Only act on a specific xiaomi miio switch entity. Else targets all. | + +### {% linkable_title Service `switch.xiaomi_miio_set_wifi_led_off` %} (Power Strip only) + +Turn the wifi led off. + +| Service data attribute | Optional | Description | +|---------------------------|----------|---------------------------------------------------------| +| `entity_id` | yes | Only act on a specific xiaomi miio switch entity. Else targets all. | + +### {% linkable_title Service `switch.xiaomi_miio_set_power_price` %} (Power Strip) + +Set the power price. + +| Service data attribute | Optional | Description | +|---------------------------|----------|---------------------------------------------------------| +| `entity_id` | yes | Only act on a specific xiaomi miio switch entity. Else targets all. | +| `price` | no | Power price, between 0 and 999. | + +### {% linkable_title Service `switch.xiaomi_miio_set_power_mode` %} (Power Strip V1 only) + +Set the power mode. + +| Service data attribute | Optional | Description | +|---------------------------|----------|---------------------------------------------------------------| +| `entity_id` | yes | Only act on a specific xiaomi miio switch entity. Else targets all. | +| `mode` | no | Power mode, valid values are 'normal' and 'green' | diff --git a/source/_components/switch.zwave.markdown b/source/_components/switch.zwave.markdown index 2ae97b2180..9525daed35 100644 --- a/source/_components/switch.zwave.markdown +++ b/source/_components/switch.zwave.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Z-Wave Switch" -description: "Instructions how to setup the Z-Wave switches within Home Assistant." +description: "Instructions on how to setup the Z-Wave switches within Home Assistant." date: 2015-11-15 13:00 sidebar: true comments: false diff --git a/source/_components/telegram_bot.markdown b/source/_components/telegram_bot.markdown index 0c5ef3e502..32397d0fbe 100644 --- a/source/_components/telegram_bot.markdown +++ b/source/_components/telegram_bot.markdown @@ -19,10 +19,12 @@ This component creates notification services to send, or edit previously sent, m If you don't need to receive messages, you can use the [broadcast](/components/telegram_bot.broadcast/) platform instead. -### {% linkable_title Notification services %} -Available services: `send_message`, `send_photo`, `send_document`, `send_location`, `edit_message`, `edit_replymarkup`, `edit_caption`, `answer_callback_query`. +## {% linkable_title Notification services %} + +Available services: `send_message`, `send_photo`, `send_document`, `send_location`, `send_sticker`, `edit_message`, `edit_replymarkup`, `edit_caption` and `answer_callback_query`. + +### {% linkable_title Service `telegram_bot.send_message` %} -#### {% linkable_title Service `telegram_bot/send_message` %} Send a notification. | Service data attribute | Optional | Description | @@ -36,7 +38,8 @@ Send a notification. | `keyboard` | yes | List of rows of commands, comma-separated, to make a custom keyboard. Example: `["/command1, /command2", "/command3"]` | | `inline_keyboard` | yes | List of rows of commands, comma-separated, to make a custom inline keyboard with buttons with associated callback data. Example: `["/button1, /button2", "/button3"]` or `[[["Text btn1", "/button1"], ["Text btn2", "/button2"]], [["Text btn3", "/button3"]]]` | -#### {% linkable_title Service `telegram_bot/send_photo` %} +### {% linkable_title Service `telegram_bot.send_photo` and `telegram_bot.send_sticker` %} + Send a photo. | Service data attribute | Optional | Description | @@ -44,16 +47,16 @@ Send a photo. | `url` | no | Remote path to an image. | | `file` | no | Local path to an image. | | `caption` | yes | The title of the image. | -| `username` | yes | Username for a URL which require HTTP basic authentication. | -| `password` | yes | Password for a URL which require HTTP basic authentication. | +| `username` | yes | Username for a URL which requires HTTP basic authentication. | +| `password` | yes | Password for a URL which requires HTTP basic authentication. | | `authentication` | yes | Define which authentication method to use. Set to `digest` to use HTTP digest authentication. Defaults to `basic`. | | `target` | yes | An array of pre-authorized chat_ids or user_ids to send the notification to. Defaults to the first allowed chat_id. | | `disable_notification` | yes | True/false for send the message silently. iOS users and web users will not receive a notification, Android users will receive a notification with no sound. Defaults to False. | | `keyboard` | yes | List of rows of commands, comma-separated, to make a custom keyboard. Example: `["/command1, /command2", "/command3"]` | | `inline_keyboard` | yes | List of rows of commands, comma-separated, to make a custom inline keyboard with buttons with associated callback data. Example: `["/button1, /button2", "/button3"]` or `[[["Text btn1", "/button1"], ["Text btn2", "/button2"]], [["Text btn3", "/button3"]]]` | +### {% linkable_title Service `telegram_bot.send_video` %} -#### {% linkable_title Service `telegram_bot/send_video` %} Send a video. | Service data attribute | Optional | Description | @@ -69,7 +72,8 @@ Send a video. | `keyboard` | yes | List of rows of commands, comma-separated, to make a custom keyboard. Example: `["/command1, /command2", "/command3"]` | | `inline_keyboard` | yes | List of rows of commands, comma-separated, to make a custom inline keyboard with buttons with associated callback data. Example: `["/button1, /button2", "/button3"]` or `[[["Text btn1", "/button1"], ["Text btn2", "/button2"]], [["Text btn3", "/button3"]]]` | -#### {% linkable_title Service `telegram_bot/send_document` %} +### {% linkable_title Service `telegram_bot.send_document` %} + Send a document. | Service data attribute | Optional | Description | @@ -77,15 +81,16 @@ Send a document. | `url` | no | Remote path to a document. | | `file` | no | Local path to a document. | | `caption` | yes | The title of the document. | -| `username` | yes | Username for a URL which require HTTP basic authentication. | -| `password` | yes | Password for a URL which require HTTP basic authentication. | +| `username` | yes | Username for a URL which requires HTTP basic authentication. | +| `password` | yes | Password for a URL which requires HTTP basic authentication. | | `authentication` | yes | Define which authentication method to use. Set to `digest` to use HTTP digest authentication. Defaults to `basic`. | | `target` | yes | An array of pre-authorized chat_ids or user_ids to send the notification to. Defaults to the first allowed chat_id. | | `disable_notification` | yes | True/false for send the message silently. iOS users and web users will not receive a notification, Android users will receive a notification with no sound. Defaults to False. | | `keyboard` | yes | List of rows of commands, comma-separated, to make a custom keyboard. Example: `["/command1, /command2", "/command3"]` | | `inline_keyboard` | yes | List of rows of commands, comma-separated, to make a custom inline keyboard with buttons with associated callback data. Example: `["/button1, /button2", "/button3"]` or `[[["Text btn1", "/button1"], ["Text btn2", "/button2"]], [["Text btn3", "/button3"]]]` | -#### {% linkable_title Service `telegram_bot/send_location` %} +### {% linkable_title Service `telegram_bot.send_location` %} + Send a location. | Service data attribute | Optional | Description | @@ -97,7 +102,8 @@ Send a location. | `keyboard` | yes | List of rows of commands, comma-separated, to make a custom keyboard. Example: `["/command1, /command2", "/command3"]` | | `inline_keyboard` | yes | List of rows of commands, comma-separated, to make a custom inline keyboard with buttons with associated callback data. Example: `["/button1, /button2", "/button3"]` or `[[["Text btn1", "/button1"], ["Text btn2", "/button2"]], [["Text btn3", "/button3"]]]` | -#### {% linkable_title Service `telegram_bot/edit_message` %} +### {% linkable_title Service `telegram_bot.edit_message` %} + Edit a previously sent message in a conversation. | Service data attribute | Optional | Description | @@ -110,7 +116,8 @@ Edit a previously sent message in a conversation. | `disable_web_page_preview`| yes | True/false for disable link previews for links in the message. | | `inline_keyboard` | yes | List of rows of commands, comma-separated, to make a custom inline keyboard with buttons with associated callback data. Example: `["/button1, /button2", "/button3"]` or `[[["Text btn1", "/button1"], ["Text btn2", "/button2"]], [["Text btn3", "/button3"]]]` | -#### {% linkable_title Service `telegram_bot/edit_caption` %} +### {% linkable_title Service `telegram_bot.edit_caption` %} + Edit the caption of a previously sent message. | Service data attribute | Optional | Description | @@ -121,8 +128,9 @@ Edit the caption of a previously sent message. | `disable_web_page_preview`| yes | True/false for disable link previews for links in the message. | | `inline_keyboard` | yes | List of rows of commands, comma-separated, to make a custom inline keyboard with buttons with associated callback data. Example: `["/button1, /button2", "/button3"]` or `[[["Text btn1", "/button1"], ["Text btn2", "/button2"]], [["Text btn3", "/button3"]]]` | -#### {% linkable_title Service `telegram_bot/edit_replymarkup` %} -Edit the inline keyboard of a previusly sent message. +### {% linkable_title Service `telegram_bot.edit_replymarkup` %} + +Edit the inline keyboard of a previously sent message. | Service data attribute | Optional | Description | |---------------------------|----------|--------------------------------------------------| @@ -131,7 +139,8 @@ Edit the inline keyboard of a previusly sent message. | `disable_web_page_preview`| yes | True/false for disable link previews for links in the message. | | `inline_keyboard` | yes | List of rows of commands, comma-separated, to make a custom inline keyboard with buttons with associated callback data. Example: `["/button1, /button2", "/button3"]` or `[[["Text btn1", "/button1"], ["Text btn2", "/button2"]], [["Text btn3", "/button3"]]]` | -#### {% linkable_title Service `telegram_bot/answer_callback_query` %} +### {% linkable_title Service `telegram_bot.answer_callback_query` %} + Respond to a callback query originated by clicking on an online keyboard button. The answer will be displayed to the user as a notification at the top of the chat screen or as an alert. | Service data attribute | Optional | Description | @@ -140,7 +149,7 @@ Respond to a callback query originated by clicking on an online keyboard button. | `callback_query_id` | no | Unique id of the callback response. In the `telegram_callback` event data: `{{ trigger.event.data.id }}` | | `show_alert` | yes | True/false for show a permanent notification. Defaults to False. | -#### {% linkable_title Service `telegram_bot/delete_message` %} +### {% linkable_title Service `telegram_bot.delete_message` %} Delete a previously sent message in a conversation. | Service data attribute | Optional | Description | @@ -148,12 +157,12 @@ Delete a previously sent message in a conversation. | `message_id` | no | Id of the message to delete. When answering a callback from a pressed button, the id of the origin message is in: `{{ trigger.event.data.message.message_id }}`. You can use `"last"` to refer to the last message sent to `chat_id`. | | `chat_id` | no | The chat_id where to delete the message. | -### {% linkable_title `Telegram` notification platform %} +## {% linkable_title `telegram` notification platform %} - -The [Telegram notification platform](/components/notify.telegram/) requires the `telegram_bot` component to work with, and it's designed to generate a customized shortcut (`notify.USERNAME`) to send notifications (messages, photos, documents and locations) to a particular `chat_id` with the old syntax, allowing backward compatibility. +The [`telegram` notification platform](/components/notify.telegram/) requires the `telegram_bot` component to work with, and it's designed to generate a customized shortcut (`notify.USERNAME`) to send notifications (messages, photos, documents and locations) to a particular `chat_id` with the old syntax, allowing backward compatibility. The required yaml configuration now reduces to: + ```yaml notify: - name: NOTIFIER_NAME @@ -161,8 +170,7 @@ notify: chat_id: USER_CHAT_ID ``` -### {% linkable_title Event triggering %} - +## {% linkable_title Event triggering %} A command looks like `/thecommand`, or `/othercommand with some args`. @@ -189,7 +197,7 @@ chat_id: "" chat: "" ``` -if the message is sent from a [press from an inline button](https://core.telegram.org/bots#inline-keyboards-and-on-the-fly-updating), for example, a callback query is received, and Home Assistant will fire a `telegram_callback` event with: +If the message is sent from a [press from an inline button](https://core.telegram.org/bots#inline-keyboards-and-on-the-fly-updating), for example, a callback query is received, and Home Assistant will fire a `telegram_callback` event with: ```yaml data: "" @@ -204,7 +212,6 @@ chat_id: "" ### {% linkable_title Configuration samples %} - Simple ping pong example. ```yaml @@ -221,7 +228,7 @@ action: message: 'pong' ``` -Example that show keyboard interaction with `notify.telegram` +An example that shows keyboard interaction with `notify.telegram` ```yaml trigger: @@ -256,8 +263,9 @@ action: entity_id: switch.vision_zm1601eu5_battery_operated_siren_switch_9_0 ``` -An example to show the use of event_data in the action: +An example to show the use of event_data in action: +{% raw %} ```yaml - alias: 'Kitchen Telegram Speak' trigger: @@ -269,17 +277,21 @@ An example to show the use of event_data in the action: - service: notify.kitchen_echo data_template: message: > - Message from {% raw %}{{ trigger.event.data["from_first"] }}. {% for state in trigger.event.data["args"] %} {{ state }} {% endfor %}{% endraw %} + Message from {{ trigger.event.data["from_first"] }}. {% for state in trigger.event.data["args"] %} {{ state }} {% endfor %} ``` +{% endraw %} ### {% linkable_title Sample automations with callback queries and inline keyboards %} -Quick example to show some of the callback capabilities of inline keyboards with a dumb automation consisting in a simple repeater of normal text that presents an inline keyboard with 3 buttons: 'EDIT', 'NO' and 'REMOVE BUTTON': +A quick example to show some of the callback capabilities of inline keyboards with a dumb automation consisting in a simple repeater of normal text that presents an inline keyboard with 3 buttons: 'EDIT', 'NO' and 'REMOVE BUTTON': + - Pressing 'EDIT' changes the sent message. - Pressing 'NO' only shows a brief notification (answering the callback query). - Pressing 'REMOVE BUTTON' changes the inline keyboard removing that button. Text repeater: + +{% raw %} ```yaml - alias: 'Telegram bot that repeats text' hide_entity: true @@ -290,15 +302,18 @@ Text repeater: - service: telegram_bot.send_message data_template: title: '*Dumb automation*' - target: {% raw %}'{{ trigger.event.data.user_id }}'{% endraw %} - message: 'You said: {% raw %}{{ trigger.event.data.text }}{% endraw %}' + target: '{{ trigger.event.data.user_id }}' + message: 'You said: {{ trigger.event.data.text }}' disable_notification: true inline_keyboard: - "Edit message:/edit_msg, Don't:/do_nothing" - "Remove this button:/remove button" ``` +{% endraw %} Message editor: + +{% raw %} ```yaml - alias: 'Telegram bot that edits the last sent message' hide_entity: true @@ -315,19 +330,22 @@ Message editor: show_alert: true - service: telegram_bot.edit_message data_template: - message_id: {% raw %}'{{ trigger.event.data.message.message_id }}'{% endraw %} - chat_id: {% raw %}'{{ trigger.event.data.chat_id }}'{% endraw %} + message_id: '{{ trigger.event.data.message.message_id }}' + chat_id: '{{ trigger.event.data.chat_id }}' title: '*Message edit*' inline_keyboard: - "Edit message:/edit_msg, Don't:/do_nothing" - "Remove this button:/remove button" message: > - {% raw %}Callback received from {% raw %}{{ trigger.event.data.from_first }}{% endraw %}. - Message id: {% raw %}{{ trigger.event.data.message.message_id }}{% endraw %}. - Data: {% raw %}{{ trigger.event.data.data }}{% endraw %} + Callback received from {{ trigger.event.data.from_first }}. + Message id: {{ trigger.event.data.message.message_id }}. + Data: {{ trigger.event.data.data }} ``` +{% endraw %} Keyboard editor: + +{% raw %} ```yaml - alias: 'Telegram bot that edits the keyboard' hide_entity: true @@ -339,17 +357,20 @@ Keyboard editor: action: - service: telegram_bot.answer_callback_query data_template: - callback_query_id: {% raw %}'{{ trigger.event.data.id }}'{% endraw %} + callback_query_id: '{{ trigger.event.data.id }}' message: 'Callback received for editing the inline keyboard!' - service: telegram_bot.edit_replymarkup data_template: message_id: 'last' - chat_id: {% raw %}'{{ trigger.event.data.chat_id }}'{% endraw %} + chat_id: '{{ trigger.event.data.chat_id }}' inline_keyboard: - "Edit message:/edit_msg, Don't:/do_nothing" ``` +{% endraw %} Only acknowledges the 'NO' answer: + +{% raw %} ```yaml - alias: 'Telegram bot that simply acknowledges' hide_entity: true @@ -361,9 +382,10 @@ Only acknowledges the 'NO' answer: action: - service: telegram_bot.answer_callback_query data_template: - callback_query_id: {% raw %}'{{ trigger.event.data.id }}'{% endraw %} + callback_query_id: '{{ trigger.event.data.id }}' message: 'OK, you said no!' ``` +{% endraw %} For a more complex usage of the `telegram_bot` capabilities, using [AppDaemon](/docs/ecosystem/appdaemon/tutorial/) is advised. diff --git a/source/_components/tellduslive.markdown b/source/_components/tellduslive.markdown index 735593a0b1..42968880ba 100644 --- a/source/_components/tellduslive.markdown +++ b/source/_components/tellduslive.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Telldus Live" -description: "Instructions how to integrate Telldus Live into Home Assistant." +description: "Instructions on how to integrate Telldus Live into Home Assistant." date: 2016-01-17 16:00 sidebar: true comments: false @@ -21,7 +21,7 @@ If you are upgrading from 0.58 or older, you need to remove all Telldus configur Home Assistant will automatically discover the presence of a Tellstick Net or Tellstick ZNet on your local network if the [discovery]({{site_root}}/components/discovery/) component is enabled. When discovery and the key exchange with Telldus Live have been completed, you will be presented with an option to integrate with the cloud or local API for direct communication with your hardware in your LAN. Local API supports only one device at this stage. Local API is only supported with the Znet Lite products, the older hardware (such as Tellstick Net) does not support local API. -To manually integrate your Telldus Live with Home Assistant, e.g. if your device is on another network or in another location, add the following section to your `configuration.yaml` file: +To manually integrate your Telldus Live with Home Assistant, e.g., if your device is on another network or in another location, add the following section to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry diff --git a/source/_components/tellstick.markdown b/source/_components/tellstick.markdown index de69aaffc3..4f9e03870d 100644 --- a/source/_components/tellstick.markdown +++ b/source/_components/tellstick.markdown @@ -1,7 +1,7 @@ --- layout: page title: "TellStick" -description: "Instructions how to integrate your TellStick into Home Assistant." +description: "Instructions on how to integrate your TellStick into Home Assistant." date: 2015-03-28 13:06 sidebar: true comments: false @@ -30,6 +30,6 @@ tellstick: Configuration variables: - **signal_repetitions** (*Optional*): Because the tellstick sends its actions via radio and from most receivers it's impossible to know if the signal was received or not. Therefore you can configure the switch and light to try to send each signal repeatedly. -- **host** (*Optional*): If you run tellstick on a other server or with a hass.io add-on. +- **host** (*Optional*): If you run tellstick on another server or with a hass.io add-on. - **port** (*Optional*): If needed with host config option. Must be port pair, for example `[50800, 50801]`. diff --git a/source/_components/tesla.markdown b/source/_components/tesla.markdown index 6580d26e31..8673396fc6 100644 --- a/source/_components/tesla.markdown +++ b/source/_components/tesla.markdown @@ -29,8 +29,8 @@ To use Tesla in your installation, add the following to your `configuration.yaml ```yaml # Example configuration.yaml entry tesla: - username: email - password: password + username: YOUR_E_MAIL_ADDRESS + password: YOUR_PASSWORD ``` Configuration variables: diff --git a/source/_components/thethingsnetwork.markdown b/source/_components/thethingsnetwork.markdown index 65211c241d..328022f6cc 100644 --- a/source/_components/thethingsnetwork.markdown +++ b/source/_components/thethingsnetwork.markdown @@ -20,7 +20,7 @@ The Things network support various integrations to make the data available: | The Things Network Integration | Home Assistant platform | |---|---| | [MQTT](https://www.thethingsnetwork.org/docs/applications/mqtt/) | | -| [Storage](https://www.thethingsnetwork.org/docs/applications/storage/) | [`thethingsnetwork`](/component/sensor.thethingsnetwork/) | +| [Storage](https://www.thethingsnetwork.org/docs/applications/storage/) | [`thethingsnetwork`](/components/sensor.thethingsnetwork/) | | [HTTP](https://www.thethingsnetwork.org/docs/applications/http/) | | ### {% linkable_title Setup %} diff --git a/source/_components/thingspeak.markdown b/source/_components/thingspeak.markdown index d8da23a931..2336a59747 100644 --- a/source/_components/thingspeak.markdown +++ b/source/_components/thingspeak.markdown @@ -12,8 +12,8 @@ ha_category: "History" ha_release: 0.32 --- -The `thingspeak` components makes Home Assistant communicate with the [ThingSpeak API](https://thingspeak.com/). -For now, it records exactly one entity at once, which is great for testing purposes. For long-time storage you should rely on the [InfluxDB component](https://home-assistant.io/components/influxdb/). +The `thingspeak` components makes Home Assistant communicate with the [ThingSpeak API](https://thingspeak.com/). +For now, it records exactly one entity at once, which is great for testing purposes. For long-time storage you should rely on the [InfluxDB component](/components/influxdb/). You will have to create a [new channel](https://thingspeak.com/channels/new) on ThingSpeak and grab your Write API Key from the "API Keys" tab of the channel you want to use. diff --git a/source/_components/timer.markdown b/source/_components/timer.markdown index 61ff400aea..eb6db877f3 100644 --- a/source/_components/timer.markdown +++ b/source/_components/timer.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Timer" -description: "Instructions how to integrate timers into Home Assistant." +description: "Instructions on how to integrate timers into Home Assistant." date: 2017-10-23 06:00 sidebar: true comments: false @@ -107,30 +107,29 @@ timer: ```yaml # Example automations.yaml entry -- action: - - service: timer.start - entity_id: timer.test - alias: Timerswitch +- alias: Timerswitch id: 'Timerstart' - -# Timer is started when the switch pumprun is set to on. + # Timer is started when the switch pumprun is set to on. trigger: - platform: state + - platform: state entity_id: switch.pumprun to: 'on' + action: + - service: timer.start + entity_id: timer.test # When timer is stopped, the time run out, another message is sent -- action: - - service: notify.nma - data: - message: "Timer stop" - alias: Timerstop +- alias: Timerstop id: 'Timerstop' trigger: - platform: event + - platform: event event_type: timer.finished event_data: entity_id: timer.test + action: + - service: notify.nma + data: + message: "Timer stop" ``` ### {% linkable_title Control a timer from the frontend %} diff --git a/source/_components/toon.markdown b/source/_components/toon.markdown index 08c38f9ace..e516db9ce8 100644 --- a/source/_components/toon.markdown +++ b/source/_components/toon.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Toon" -description: "Instructions how to integrate Toon within Home Assistant." +description: "Instructions on how to integrate Toon within Home Assistant." date: 2017-10-22 12:00 sidebar: true comments: false diff --git a/source/_components/tts.amazon_polly.markdown b/source/_components/tts.amazon_polly.markdown index 465a5abea1..8be1fdc0a5 100644 --- a/source/_components/tts.amazon_polly.markdown +++ b/source/_components/tts.amazon_polly.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Amazon Polly" -description: "Instructions how to setup Amazon Polly with Home Assistant." +description: "Instructions on how to setup Amazon Polly with Home Assistant." date: 2017-01-28 09:00 sidebar: true comments: false @@ -15,6 +15,8 @@ ha_release: 0.37 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 Configuration %} + To get started, add the following lines to your `configuration.yaml` (example for Amazon Polly): ```yaml @@ -23,33 +25,62 @@ tts: - platform: amazon_polly aws_access_key_id: AWS_ACCESS_KEY_ID aws_secret_access_key: AWS_SECRET_ACCESS_KEY - profile_name: AWS_PROFILE - region_name: 'us-east-1' - voice: Joanna ``` -Configuration variables: +{% configuration %} +aws_access_key_id: + description: "Your AWS Access Key ID. For more information, please read the [AWS General Reference regarding Security Credentials](http://docs.aws.amazon.com/general/latest/gr/aws-security-credentials.html). If provided, you must also provide an `aws_secret_access_key` and must **not** provide a `profile_name`." + required: true + type: string +aws_secret_access_key: + description: "Your AWS Secret Access Key. For more information, please read the [AWS General Reference regarding Security Credentials](http://docs.aws.amazon.com/general/latest/gr/aws-security-credentials.html). If provided, you must also provide an `aws_access_key_id` and must **not** provide a `profile_name`." + required: true + type: string +profile_name: + description: A credentials profile name. For more information, please see the [boto3 Documentation](http://boto3.readthedocs.io/en/latest/guide/configuration.html#shared-credentials-file) for more information. + required: false + type: string +region_name: + description: "The region identifier to connect to. The default is `us-east-1`. See the [AWS Regions and Endpoints Reference](https://docs.aws.amazon.com/general/latest/gr/rande.html#pol_region) for available regions." + required: false + type: string or list +name: + description: "Setting the optional parameter `name` allows multiple notifiers to be created. The default value is `notify`. The notifier will bind to the service `notify.NOTIFIER_NAME`." + required: false + type: string +text_type: + description: "Specify wherever to use text (default) or ssml markup by default." + required: false + type: string + default: text +voice: + description: "Voice name to be used. See the [Amazon Documentation](http://docs.aws.amazon.com/polly/latest/dg/voicelist.html) for available voices." + required: false + type: string +output_format: + description: "Override the default output format, e.g., `mp3`, `ogg_vorbis` or `pcm`." + required: false + type: string + default: mp3 +sample_rate: + description: "Override the default sample rate, defaults to 22050 for MP3 and Ogg Vorbis, 16000 for pcm." + required: false + type: string +{% endconfiguration %} -| Parameter | Value | Description | -|---------------------|----------|-------------| -| `aws_access_key_id` | Required | Your AWS Access Key ID. For more information, please read the [AWS General Reference regarding Security Credentials](http://docs.aws.amazon.com/general/latest/gr/aws-security-credentials.html). If provided, you must also provide an `aws_secret_access_key` and must **not** provide a `profile_name` | -| `aws_secret_access_key` | Required | Your AWS Secret Access Key. For more information, please read the [AWS General Reference regarding Security Credentials](http://docs.aws.amazon.com/general/latest/gr/aws-security-credentials.html). If provided, you must also provide an `aws_access_key_id` and must **not** provide a `profile_name`. | -| `profile_name` | Optional | A credentials profile name. For more information, please see the [boto3 Documentation](http://boto3.readthedocs.io/en/latest/guide/configuration.html#shared-credentials-file) for more information. | -| `region_name` | Optional | The region identifier to connect to. The default is `us-east-1`. | -| `name` | Optional | Setting the optional parameter `name` allows multiple notifiers to be created. The default value is `notify`. The notifier will bind to the service `notify.NOTIFIER_NAME`. | -| `text_type` | text/ssml | text or ssml: Specify wherever to use text (default) or ssml markup by default. | -| `voice` | Optional | Voice name to be used. See the [Amazon Documentation](http://docs.aws.amazon.com/polly/latest/dg/voicelist.html) for available voices. | -| `output_format` | mp3/ogg_vorbis/pcm | Override the default output format, defaults to MP3. | -| `sample_rate` | 8000/16000/22050 | Override the default sample rate, defaults to 22050 for MP3 and Ogg Vorbis, 16000 for pcm. | -## Usage +## {% linkable_title Usage %} + Say to all `media_player` device entities: + ```yaml - service: tts.amazon_polly_say data_template: message: 'Hello from Amazon Polly' ``` + or + ```yaml - service: tts.amazon_polly_say data_template: diff --git a/source/_components/tts.baidu.markdown b/source/_components/tts.baidu.markdown index e8499742fd..47ba6f0ad8 100644 --- a/source/_components/tts.baidu.markdown +++ b/source/_components/tts.baidu.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Baidu Text-to-Speech" -description: "Instructions how to setup Baidu TTS with Home Assistant." +description: "Instructions on how to setup Baidu TTS with Home Assistant." date: 2017-11-21 09:00 sidebar: true comments: false diff --git a/source/_components/tts.google.markdown b/source/_components/tts.google.markdown index cbed90dada..1b0468c87d 100644 --- a/source/_components/tts.google.markdown +++ b/source/_components/tts.google.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Google Text-to-Speech" -description: "Instructions how to setup Google Text-to-Speech with Home Assistant." +description: "Instructions on how to setup Google Text-to-Speech with Home Assistant." date: 2016-12-13 07:00 sidebar: true comments: false diff --git a/source/_components/tts.markdown b/source/_components/tts.markdown index c32de7d20c..5fc0d8de47 100644 --- a/source/_components/tts.markdown +++ b/source/_components/tts.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Text-to-Speech (TTS)" -description: "Instructions how to setup Text-to-Speech (TTS) with Home Assistant." +description: "Instructions on how to setup Text-to-Speech (TTS) with Home Assistant." date: 2016-12-13 07:00 sidebar: true comments: false @@ -88,3 +88,33 @@ data_template: ## {% linkable_title Cache %} The component has two caches. Both caches can be controlled with the `cache` option in the platform configuration or the service call `say`. A long time cache will be located on the file system. The in-memory cache for fast responses to media players will be auto-cleaned after a short period. + +## {% linkable_title REST Api %} + +#### {% linkable_title POST /api/tts_get_url %} + +Returns an URL to the generated TTS file. Platform and message are required. + +```json +{ + "plaform": "amazon_polly", + "message": "I am speaking now" +} +``` + +The return code is 200 if the file is generated. The message body will contain a JSON object with the URL. + +```json +{ + "url": "http://127.0.0.1:8123/api/tts_proxy/265944c108cbb00b2a621be5930513e03a0bb2cd_en_-_demo.mp3" +} +``` + +Sample `curl` command: + +```bash +$ curl -X POST -H "x-ha-access: YOUR_PASSWORD" \ + -H "Content-Type: application/json" \ + -d '{"message": "I am speaking now", "platform": "amazon_polly"}' \ + http://localhost:8123/api/tts_get_url +``` diff --git a/source/_components/tts.marytts.markdown b/source/_components/tts.marytts.markdown index 42fff710e1..7b13da9906 100644 --- a/source/_components/tts.marytts.markdown +++ b/source/_components/tts.marytts.markdown @@ -1,7 +1,7 @@ --- layout: page title: "MaryTTS" -description: "Instructions how to setup MaryTTS with Home Assistant." +description: "Instructions on how to setup MaryTTS with Home Assistant." date: 2017-04-08 16:49 sidebar: true comments: false diff --git a/source/_components/tts.microsoft.markdown b/source/_components/tts.microsoft.markdown index 036dfed524..bb68917616 100644 --- a/source/_components/tts.microsoft.markdown +++ b/source/_components/tts.microsoft.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Microsoft Text-to-Speech" -description: "Instructions how to setup Microsoft Text-to-Speech with Home Assistant." +description: "Instructions on how to setup Microsoft Text-to-Speech with Home Assistant." date: 2017-11-07 12:00 sidebar: true comments: false diff --git a/source/_components/tts.picotts.markdown b/source/_components/tts.picotts.markdown index 411cc11c4c..5525c0b8ec 100644 --- a/source/_components/tts.picotts.markdown +++ b/source/_components/tts.picotts.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Pico Text-to-Speech" -description: "Instructions how to setup Pico Text-to-Speech with Home Assistant." +description: "Instructions on how to setup Pico Text-to-Speech with Home Assistant." date: 2017-01-03 16:00 sidebar: true comments: false diff --git a/source/_components/tts.voicerss.markdown b/source/_components/tts.voicerss.markdown index 612ae41082..99e6b5d685 100644 --- a/source/_components/tts.voicerss.markdown +++ b/source/_components/tts.voicerss.markdown @@ -1,7 +1,7 @@ --- layout: page title: "VoiceRSS" -description: "Instructions how to setup VoiceRSS TTS with Home Assistant." +description: "Instructions on how to setup VoiceRSS TTS with Home Assistant." date: 2016-12-13 07:00 sidebar: true comments: false diff --git a/source/_components/tts.yandextts.markdown b/source/_components/tts.yandextts.markdown index 18693965e7..af30eacea7 100644 --- a/source/_components/tts.yandextts.markdown +++ b/source/_components/tts.yandextts.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Yandex TTS" -description: "Instructions how to setup Yandex SpeechKit TTS with Home Assistant." +description: "Instructions on how to setup Yandex SpeechKit TTS with Home Assistant." date: 2017-01-17 03:04 sidebar: true comments: false diff --git a/source/_components/twilio.markdown b/source/_components/twilio.markdown index 299a91f019..ed3752a9e2 100644 --- a/source/_components/twilio.markdown +++ b/source/_components/twilio.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Twilio" -description: "Instructions how to add Twilio notifications to Home Assistant." +description: "Instructions on how to add Twilio notifications to Home Assistant." date: 2016-05-14 14:14 sidebar: true comments: false @@ -32,4 +32,4 @@ Configuration variables: - **auth_token** (*Required*): Your Twilio AUTH TOKEN which can be found in your [console](https://www.twilio.com/console). It should be directly under where you found the `account_sid`. ### {% linkable_title Usage %} -After configuring the base Twilio component, add and configure either or both of the [twilio SMS](https://home-assistant.io/components/notify.twilio_sms/) and [twilio Phone](https://home-assistant.io/components/notify.twilio_call) components to utilize the notification functionality. +After configuring the base Twilio component, add and configure either or both of the [twilio SMS](/components/notify.twilio_sms/) and [twilio Phone](/components/notify.twilio_call) components to utilize the notification functionality. diff --git a/source/_components/upcloud.markdown b/source/_components/upcloud.markdown index 726c776fa2..dcb15e41fc 100644 --- a/source/_components/upcloud.markdown +++ b/source/_components/upcloud.markdown @@ -1,7 +1,7 @@ --- layout: page title: UpCloud -description: Instructions how to integrate UpCloud within Home Assistant. +description: Instructions on how to integrate UpCloud within Home Assistant. date: 2018-01-28 20:00 sidebar: true comments: false diff --git a/source/_components/vacuum.dyson.markdown b/source/_components/vacuum.dyson.markdown index 4ac3d49e5e..b482899130 100644 --- a/source/_components/vacuum.dyson.markdown +++ b/source/_components/vacuum.dyson.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Dyson 360 Eye" -description: "Instructions how to integrate your Dyson Eye 360 vacuum robot within Home Assistant." +description: "Instructions on how to integrate your Dyson Eye 360 vacuum robot within Home Assistant." date: 2017-08-06 10:30 sidebar: true comments: false diff --git a/source/_components/vacuum.markdown b/source/_components/vacuum.markdown index 51b0adc667..c626a39934 100644 --- a/source/_components/vacuum.markdown +++ b/source/_components/vacuum.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Vacuum cleaner robots" -description: "Instructions how to setup a botvac in Home Assistant." +description: "Instructions on how to setup a botvac in Home Assistant." date: 2017-07-28 15:00 sidebar: true comments: false @@ -27,7 +27,7 @@ Available services: `turn_on`, `turn_off`, `start_pause`, `stop`, `return_to_hom Before calling one of these services, make sure your botvac platform supports it. -#### {% linkable_title Service `vacuum/turn_on` %} +#### {% linkable_title Service `vacuum.turn_on` %} Start a new cleaning task. @@ -35,7 +35,7 @@ Start a new cleaning task. |---------------------------|----------|-------------------------------------------------------| | `entity_id` | yes | Only act on specific botvac. Else targets all. | -#### {% linkable_title Service `vacuum/turn_off` %} +#### {% linkable_title Service `vacuum.turn_off` %} Stop the current cleaning task and return to the dock. @@ -43,7 +43,7 @@ Stop the current cleaning task and return to the dock. |---------------------------|----------|-------------------------------------------------------| | `entity_id` | yes | Only act on specific botvac. Else targets all. | -#### {% linkable_title Service `vacuum/start_pause` %} +#### {% linkable_title Service `vacuum.start_pause` %} Start, pause or resume a cleaning task. @@ -51,7 +51,7 @@ Start, pause or resume a cleaning task. |---------------------------|----------|-------------------------------------------------------| | `entity_id` | yes | Only act on specific botvac. Else targets all. | -#### {% linkable_title Service `vacuum/stop` %} +#### {% linkable_title Service `vacuum.stop` %} Stop the current activity of the botvac. @@ -59,7 +59,7 @@ Stop the current activity of the botvac. |---------------------------|----------|-------------------------------------------------------| | `entity_id` | yes | Only act on specific botvac. Else targets all. | -#### {% linkable_title Service `vacuum/return_to_home` %} +#### {% linkable_title Service `vacuum.return_to_home` %} Tell the botvac to return home. @@ -67,7 +67,7 @@ Tell the botvac to return home. |---------------------------|----------|-------------------------------------------------------| | `entity_id` | yes | Only act on specific botvac. Else targets all. | -#### {% linkable_title Service `vacuum/locate` %} +#### {% linkable_title Service `vacuum.locate` %} Locate the vacuum cleaner robot. @@ -75,7 +75,7 @@ Locate the vacuum cleaner robot. |---------------------------|----------|-------------------------------------------------------| | `entity_id` | yes | Only act on specific botvac. Else targets all. | -#### {% linkable_title Service `vacuum/clean_spot` %} +#### {% linkable_title Service `vacuum.clean_spot` %} Tell the vacuum cleaner to do a spot clean-up. @@ -83,7 +83,7 @@ Tell the vacuum cleaner to do a spot clean-up. |---------------------------|----------|-------------------------------------------------------| | `entity_id` | yes | Only act on specific botvac. Else targets all. | -#### {% linkable_title Service `vacuum/set_fanspeed` %} +#### {% linkable_title Service `vacuum.set_fanspeed` %} Set the fan speed of the botvac. The `fanspeed` can be a label, as `balanced` or `turbo`, or be a number; it depends on the `vacuum` platform. @@ -92,7 +92,7 @@ Set the fan speed of the botvac. The `fanspeed` can be a label, as `balanced` or | `entity_id` | yes | Only act on specific botvac. Else targets all. | | `fanspeed` | no | Platform dependent vacuum cleaner fan speed, with speed steps, like 'medium', or by percentage, between 0 and 100. | -#### {% linkable_title Service `vacuum/send_command` %} +#### {% linkable_title Service `vacuum.send_command` %} Send a platform-specific command to the vacuum cleaner. diff --git a/source/_components/vacuum.mqtt.markdown b/source/_components/vacuum.mqtt.markdown index 65ed9679ce..1777c7cd89 100644 --- a/source/_components/vacuum.mqtt.markdown +++ b/source/_components/vacuum.mqtt.markdown @@ -1,7 +1,7 @@ --- layout: page title: "MQTT Vacuum" -description: "Instructions how to integrate your MQTT enabled Vacuum within Home Assistant." +description: "Instructions on how to integrate your MQTT enabled Vacuum within Home Assistant." date: 2017-09-11 20:26 sidebar: true comments: false diff --git a/source/_components/vacuum.neato.markdown b/source/_components/vacuum.neato.markdown index 2c0ed93464..b670457369 100644 --- a/source/_components/vacuum.neato.markdown +++ b/source/_components/vacuum.neato.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Neato Robotics Vacuum" -description: "Instructions how to integrate a Neato Botvac Connected Vacuum within Home Assistant." +description: "Instructions on how to integrate a Neato Botvac Connected Vacuum within Home Assistant." date: 2017-10-18 16:11 sidebar: true comments: false diff --git a/source/_components/vacuum.roomba.markdown b/source/_components/vacuum.roomba.markdown index 32c1393eb2..bf28b11035 100644 --- a/source/_components/vacuum.roomba.markdown +++ b/source/_components/vacuum.roomba.markdown @@ -1,7 +1,7 @@ --- layout: page title: "iRobot Roomba" -description: "Instructions how to integrate your Wi-Fi enabled Roomba within Home Assistant." +description: "Instructions on how to integrate your Wi-Fi enabled Roomba within Home Assistant." date: 2017-08-04 20:43 sidebar: true comments: false diff --git a/source/_components/vacuum.xiaomi_miio.markdown b/source/_components/vacuum.xiaomi_miio.markdown index 3d6a7908b8..9fa8cbe3da 100644 --- a/source/_components/vacuum.xiaomi_miio.markdown +++ b/source/_components/vacuum.xiaomi_miio.markdown @@ -81,7 +81,7 @@ Remote control the robot. Please ensure you first set it in remote control mode | `entity_id` | yes | Only act on specific robot; default targets all | | `velocity` | no | Speed: between -0.29 and 0.29 | | `rotation` | no | Rotation: between -179 degrees and 179 degrees | -| `duration` | no | The number of seconds that the robot should move for | +| `duration` | no | The number of milliseconds that the robot should move for | ### {% linkable_title Service `vacuum.xiaomi_remote_control_move_step` %} @@ -92,7 +92,7 @@ Enter remote control mode, make one move, stop, and exit remote control mode. | `entity_id` | yes | Only act on specific robot; default targets all | | `velocity` | no | Speed: between -0.29 and 0.29. | | `rotation` | no | Rotation: between -179 degrees and 179 degrees. | -| `duration` | no | The number of seconds that the robot should move for | +| `duration` | no | The number of milliseconds that the robot should move for | ## {% linkable_title Attributes %} @@ -127,7 +127,7 @@ The following table shows the units of measurement for each attribute:

As per [python-miio issue 185](https://github.com/rytilahti/python-miio/issues/185) the Mi-Home app no longer stores the token within the database (it's retrieved from Xiaomi servers from version 5.0.31+). Currently the only known fix is to uninstall, then install a downgraded version of the apk. Apkmirror is a trusted source for older versions of the app. [Mi-Home version 5.0.0](https://www.apkmirror.com/apk/xiaomi-inc/mihome/mihome-5-0-0-release/) is confirmed as working for the following Android methods. -This token (32 hexadecimal characters) is required for the Xiaomi Mi Robot Vacuum, Xiaomi Philips Lights and Xiaomi IR Remote. The Xiaomi Gateway uses another security method and requires a `key` (16 alphanumeric chars), which can be obtained +This token (32 hexadecimal characters) is required for the Xiaomi Mi Robot Vacuum, Mi Robot 2 (Roborock) Vacuum, Xiaomi Philips Lights and Xiaomi IR Remote. The Xiaomi Gateway uses another security method and requires a `key` (16 alphanumeric chars), which can be obtained easily via a hidden menu item at the Mi-Home app or using the `miio` command line tool.

@@ -197,13 +197,13 @@ To fetch the token follow these instructions depending on your mobile phone plat 1. Configure the robot with the Mi-Home app. 2. Enable developer mode, USB debugging and plug the Android phone into the computer. -3. Get ADB e.g. `apt-get install android-tools-adb` or `apt-get install adb` +3. Get ADB e.g., `apt-get install android-tools-adb` or `apt-get install adb` 4. `adb devices` should list your device. Consult ADB manual if necessary. 5. Issue a backup command via adb: `adb backup -noapk com.xiaomi.smarthome -f backup.ab` (set a password if prompted on your phone). Some devices may required single quotes in the command `adb backup '-noapk com.xiaomi.smarthome -f backup.ab'` 6. Download the 'ADB Backup Extractor' from [here](https://sourceforge.net/projects/adbextractor/files/latest/download) 7. Extract the data from the backup: `java -jar Android\ Backup\ Utilities/Android\ Backup\ Extractor/android-backup-extractor-20171005-bin/abe.jar unpack backup.ab unpacked.tar` (enter the password, if prompted) 8. Untar the unpacked data: `tar -xvf unpacked.tar` -9. `sqlite3 apps/com.xiaomi.smarthome/db/miio2.db 'select token from devicerecord where name = "Mi Robot Vacuum";'` returns the token for your Xiaomi vacuum bot. +9. `sqlite3 apps/com.xiaomi.smarthome/db/miio2.db 'select token from devicerecord where name like "%Vacuum%";'` returns the token for your Xiaomi vacuum bot. #### {% linkable_title Linux and Android (rooted!) %} @@ -245,7 +245,7 @@ To fetch the token follow these instructions depending on your mobile phone plat 8. Install [DB Browser for SQLite](http://sqlitebrowser.org/). 9. Open DB Browser and load the `.sqlite` file you saved from your backup. 10. Click on the `Execute SQL` tab. -11. Input and run this query: `SELECT ZTOKEN FROM ZDEVICE WHERE ZNAME = "Mi Robot Vacuum"` +11. Input and run this query: `SELECT ZTOKEN FROM ZDEVICE WHERE ZNAME LIKE "%Vacuum%"` 12. Copy the returned 32-digit hexadecimal string to your clipboard. 13. Open `Terminal` and execute this command: `echo '0: ' | xxd -r -p | openssl enc -d -aes-128-ecb -nopad -nosalt -K 00000000000000000000000000000000` 14. Use the resulting string as your token. diff --git a/source/_components/vera.markdown b/source/_components/vera.markdown index 264f39157f..1dfa965fb4 100644 --- a/source/_components/vera.markdown +++ b/source/_components/vera.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Vera" -description: "Instructions how to setup Vera Z-Wave hubs and configure devices within Home Assistant." +description: "Instructions on how to setup Vera Z-Wave hubs and configure devices within Home Assistant." date: 2015-03-23 20:04 sidebar: true comments: false diff --git a/source/_components/verisure.markdown b/source/_components/verisure.markdown index 3f41ed18a5..7eac9bad58 100644 --- a/source/_components/verisure.markdown +++ b/source/_components/verisure.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Verisure" -description: "Instructions how to setup Verisure devices within Home Assistant." +description: "Instructions on how to setup Verisure devices within Home Assistant." date: 2015-08-17 20:28 sidebar: true comments: false diff --git a/source/_components/volvooncall.markdown b/source/_components/volvooncall.markdown index 09664ef231..6482d372cc 100644 --- a/source/_components/volvooncall.markdown +++ b/source/_components/volvooncall.markdown @@ -21,8 +21,8 @@ To use Volvo On Call in your installation, add the following to your `configurat ```yaml # Example configuration.yaml entry volvooncall: - username: username - password: password + username: YOUR_USERNAME + password: YOUR_PASSWORD ``` Users registered with Volvo in North America or China will need to specify a region: @@ -30,15 +30,18 @@ Users registered with Volvo in North America or China will need to specify a reg ```yaml # North America volvooncall: - username: username - password: password + username: YOUR_USERNAME + password: YOUR_PASSWORD region: na ``` + +or + ```yaml # China volvooncall: - username: username - password: password + username: YOUR_USERNAME + password: YOUR_PASSWORD region: cn ``` @@ -47,8 +50,8 @@ A more advanced example for setting the vehicle name and selecting what resource ```yaml # Example configuration.yaml entry volvooncall: - username: username - password: password + username: YOUR_USERNAME + password: YOUR_PASSWORD name: abc123: 'Batmobile' resources: diff --git a/source/_components/wake_on_lan.markdown b/source/_components/wake_on_lan.markdown index a6bd3291ac..2f7b1d4532 100644 --- a/source/_components/wake_on_lan.markdown +++ b/source/_components/wake_on_lan.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Wake on LAN" -description: "Instructions how to setup the Wake on LAN component in Home Assistant." +description: "Instructions on how to setup the Wake on LAN component in Home Assistant." date: 2017-07-8 15:00 sidebar: true comments: false diff --git a/source/_components/waterfurnace.markdown b/source/_components/waterfurnace.markdown index 9bf884e0c2..2555b1fb80 100644 --- a/source/_components/waterfurnace.markdown +++ b/source/_components/waterfurnace.markdown @@ -13,12 +13,11 @@ ha_release: 0.62 ha_iot_class: "Cloud Polling" --- -The `waterfurnace` component communicates with the WaterFurnace -Symphony website's WebSocket to show you many of the sensors in your -system. While not an official API, this is the same backend the -Symphony website is based on, and should be reasonably stable. +The `waterfurnace` component communicates with the WaterFurnace Symphony website's WebSocket to show you many of the sensors in your +system. While not an official API, this is the same backend the Symphony website is based on, and should be reasonably stable. The sensors provided include: + - Thermostat Setpoint - Thermostat Current Temp - Leaving Air Temp @@ -28,41 +27,37 @@ The sensors provided include: - Total system power (in Watts) - Furnace Mode +## {% linkable_title Configuration %} + To use Waterfurnace in your installation, add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry waterfurnace: - username: you@example.com - password: secr3tpassword + username: YOUR_USERNAME + password: YOUR_PASSWORD unit: 0123456789AB ``` {% configuration %} username: - description: The email address for your Symphony WaterFurnace account - required: true - type: string + description: The email address for your Symphony WaterFurnace account + required: true + type: string password: - description: The password for your Symphony WaterFurnace account - required: true - type: string + description: The password for your Symphony WaterFurnace account + required: true + type: string unit: - description: The unit serial number for your WaterFurnace - required: true - type: string + description: The unit serial number for your WaterFurnace + required: true + type: string {% endconfiguration %} #### {% linkable_title Limitations %} -The WebSocket interface used by this module requires active polling, -otherwise the server side shuts down the connection. By default, this -polling is happening every 10 seconds. All sensors are updated during -every polling cycle. +The WebSocket interface used by this module requires active polling, otherwise the server side shuts down the connection. By default, this polling is happening every 10 seconds. All sensors are updated during every polling cycle. + +While this is communicating with a thermostat, geothermal systems operate most efficiently when setbacks are not used, and the home is kept at a constant temperature. It remains useful to collect the data from the system to understand its performance, but a full climate interface won't be implemented. -While this is communicating with a thermostat, geothermal systems -operate most efficiently when setbacks are not used, and the home is -kept at a constant temperature. It remains useful to collect the data -from the system to understand its performance, but a full climate -interface won't be implemented. diff --git a/source/_components/weather.bom.markdown b/source/_components/weather.bom.markdown index 3a9d64c81a..fe26c58337 100644 --- a/source/_components/weather.bom.markdown +++ b/source/_components/weather.bom.markdown @@ -15,9 +15,12 @@ ha_iot_class: "Cloud Polling" The `bom` weather platform uses the [Australian Bureau of Meteorology (BOM)](http://www.bom.gov.au) as a source for current (half-hourly) meteorological data. +## {% linkable_title Configuration %} + To add the BOM weather platform to your installation, add the following to your `configuration.yaml` file: ```yaml +# Example configuration.yaml entry weather: - platform: bom ``` diff --git a/source/_components/weather.buienradar.markdown b/source/_components/weather.buienradar.markdown index 0377e8bfe2..0b4ef3f0db 100644 --- a/source/_components/weather.buienradar.markdown +++ b/source/_components/weather.buienradar.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Buienradar" -description: "Instructions how to integrate buienradar.nl weather within Home Assistant." +description: "Instructions on how to integrate buienradar.nl weather within Home Assistant." date: 2017-05-15 14:00 sidebar: true comments: false @@ -14,8 +14,11 @@ ha_iot_class: "Cloud Polling" --- The `buienradar` platform uses [buienradar.nl](http://buienradar.nl/) as a source for current meteorological data for your location. The weather forecast is delivered by Buienradar, who provides a web service that provides detailed weather information for users in The Netherlands. + The relevant weather station used will be automatically selected based on the location specified in the Home Assistant configuration (or in the Buienradar weather/sensor component). A map of all available weather stations can be found [here](https://www.google.com/maps/d/embed?mid=1NivHkTGQUOs0dwQTnTMZi8Uatj0). +## {% linkable_title Configuration %} + To add the Buienradar weather to your installation, add the following to your `configuration.yaml` file: ```yaml @@ -26,7 +29,7 @@ weather: Configuration variables: -- **name** (*Optional*): You can specify a name of the component, but do not have to. If you specify a name, the weather component will get an entity name of 'weather.[name]'; if no name is specified, it will try to set its name to 'weather.BR_[stationname]'. However at the moment in time, the entity is created, no data has been retrieved yet, so the entity will get named 'weather.BR_unknown_station'. Later the station name will be known and get updated, but the entity name remains. +- **name** (*Optional*): You can specify a name of the component, but do not have to. If you specify a name, the weather component will get an entity name of `weather.[name]`; if no name is specified, it will try to set its name to `weather.BR_[stationname]`. However at the moment in time, the entity is created, no data has been retrieved yet, so the entity will get named `weather.BR_unknown_station`. Later the station name will be known and get updated, but the entity name remains. - **latitude** (*Optional*): Latitude to use for selection of data source location. Longitude and latitude will be taken from Home Assistant configuration but can be overridden/changed in this component to select a different location for Buienradar. - **longitude**(*Optional*): Longitude to use for selection of data source location. Longitude and latitude will be taken from Home Assistant configuration but can be overridden/changed in this component to select a different location for Buienradar. - **forecast** (*Optional*): 'True' to add a temperature forecast, 'False' to suppress it. diff --git a/source/_components/weather.darksky.markdown b/source/_components/weather.darksky.markdown index 0130a933d0..6a3b1ad138 100644 --- a/source/_components/weather.darksky.markdown +++ b/source/_components/weather.darksky.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Dark Sky" -description: "Instructions how to integrate Dark Sky within Home Assistant." +description: "Instructions on how to integrate Dark Sky within Home Assistant." date: 2016-09-29 09:00 sidebar: true comments: false @@ -14,17 +14,14 @@ ha_release: 0.61 ha_iot_class: "Cloud Polling" --- -The `darksky` platform uses the [Dark Sky](https://darksky.net/) web service as -a source for meteorological data for your location. +The `darksky` platform uses the [Dark Sky](https://darksky.net/) web service as a source for meteorological data for your location. -You need an API key which is free but requires -[registration](https://darksky.net/dev/register). The free tier allows up to -1000 calls per day, this platform updates at most every 3 minutes, using up to -480 of those calls. +## {% linkable_title Configuration %} + +You need an API key which is free but requires [registration](https://darksky.net/dev/register). The free tier allows up to 1000 calls per day, this platform updates at most every 3 minutes, using up to 480 of those calls.

-[Dark Sky](https://darksky.net/dev/) will charge you $0.0001 per API call if you -enter your credit card details and create more than 1000 calls per day. +[Dark Sky](https://darksky.net/dev/) will charge you $0.0001 per API call if you enter your credit card details and create more than 1000 calls per day.

To add Dark Sky to your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/weather.ecobee.markdown b/source/_components/weather.ecobee.markdown index 0f32830963..33f1983ecd 100644 --- a/source/_components/weather.ecobee.markdown +++ b/source/_components/weather.ecobee.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Ecobee Weather" -description: "Instructions how to setup the Ecobee weather within Home Assistant." +description: "Instructions on how to setup the Ecobee weather within Home Assistant." date: 2017-11-29 21:00 sidebar: true comments: false diff --git a/source/_components/weather.markdown b/source/_components/weather.markdown index f082409139..c256cae2a8 100644 --- a/source/_components/weather.markdown +++ b/source/_components/weather.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Weather" -description: "Instructions how to setup your Weather platforms with Home Assistant." +description: "Instructions on how to setup your Weather platforms with Home Assistant." date: 2016-09-28 14:00 sidebar: true comments: false @@ -13,4 +13,22 @@ The `weather` platforms are gathering meteorological information from web servic Home Assistant currently supports free web services and such which require a registration. Please check the sidebar for a full list of supported `weather` platforms. +## {% linkable_title Condition mapping %} + +The `weather` platform only knows the below listed conditions. The reason for this is that for these conditions is an icon from [Material Design Icons](https://materialdesignicons.com/) available and mapped in the [frontend](https://github.com/home-assistant/home-assistant-polymer/blob/master/src/cards/ha-weather-card.html#L77). + +- 'cloudy' +- 'fog' +- 'hail' +- 'lightning' +- 'lightning-rainy' +- 'partlycloudy' +- 'pouring' +- 'rainy' +- 'snowy' +- 'snowy-rainy' +- 'sunny' +- 'windy' +- 'windy-variant' +- 'exceptional': diff --git a/source/_components/weather.metoffice.markdown b/source/_components/weather.metoffice.markdown index 5875121806..df624d2a9c 100644 --- a/source/_components/weather.metoffice.markdown +++ b/source/_components/weather.metoffice.markdown @@ -15,9 +15,12 @@ ha_iot_class: "Cloud Polling" The `metoffice` weather platform uses the Met Office's [DataPoint API][datapoint] for weather data. +## {% linkable_title Configuration %} + To add the Met Office weather platform to your installation, you'll need to register for a free API key at the link above and then add the following to your `configuration.yaml` file: ```yaml +# Example configuration.yaml entry weather: - platform: metoffice api_key: YOUR_API_KEY diff --git a/source/_components/weather.openweathermap.markdown b/source/_components/weather.openweathermap.markdown index 9c0a24f447..53f7e9a348 100644 --- a/source/_components/weather.openweathermap.markdown +++ b/source/_components/weather.openweathermap.markdown @@ -1,7 +1,7 @@ --- layout: page title: "OpenWeatherMap" -description: "Instructions how to integrate OpenWeatherMap within Home Assistant." +description: "Instructions on how to integrate OpenWeatherMap within Home Assistant." date: 2016-09-29 09:00 sidebar: true comments: false @@ -15,6 +15,8 @@ ha_iot_class: "Cloud Polling" The `openweathermap` weather platform uses [OpenWeatherMap](http://openweathermap.org/) as a source for current meteorological data for your location. +## {% linkable_title Configuration %} + You need an API key which is free but requires a [registration](http://home.openweathermap.org/users/sign_up). To add OpenWeatherMap to your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/weather.yweather.markdown b/source/_components/weather.yweather.markdown index e087503679..27bbda8214 100644 --- a/source/_components/weather.yweather.markdown +++ b/source/_components/weather.yweather.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Yahoo Weather" -description: "Instructions how to integrate Yahoo Weather within Home Assistant." +description: "Instructions on how to integrate Yahoo Weather within Home Assistant." date: 2016-07-06 9:06 sidebar: true comments: false @@ -19,6 +19,8 @@ The `yweather` platform uses [Yahoo Weather](https://www.yahoo.com/news/weather/ Use of the Yahoo Weather API should not exceed reasonable request volume. Access is limited to 2000 signed calls per day.

+## {% linkable_title Configuration %} + The `woeid` (Where On Earth ID) for your location, as shown in the example below. You can find your WOEID by copying the numeric digits at the end of the URL for your location at [Yahoo Weather](https://www.yahoo.com/news/weather/). If you don't add a WOEID, it will be generated from Home Assistant's latitude and longitude. To add Yahoo Weather to your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/weather.zamg.markdown b/source/_components/weather.zamg.markdown index 89cc25bca8..b3112d97ea 100644 --- a/source/_components/weather.zamg.markdown +++ b/source/_components/weather.zamg.markdown @@ -1,7 +1,7 @@ --- layout: page title: "ZAMG Weather" -description: "Instructions how to integrate ZAMG sensors within Home Assistant." +description: "Instructions on how to integrate ZAMG sensors within Home Assistant." date: 2016-12-06 08:00 sidebar: true comments: false @@ -17,6 +17,8 @@ The `zamg` platform uses meteorological details published by the Austrian weathe Only observations for capital cities are publicly available. You can check the list of stations in [CSV format](http://www.zamg.ac.at/ogd). +## {% linkable_title Configuration %} + To add ZAMG to your installation, add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/weblink.markdown b/source/_components/weblink.markdown index a816180fd1..ebc44a1eb9 100644 --- a/source/_components/weblink.markdown +++ b/source/_components/weblink.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Weblink" -description: "Instructions how to setup Links within Home Assistant." +description: "Instructions on how to setup Links within Home Assistant." date: 2016-02-02 20:00 sidebar: true comments: false @@ -24,7 +24,7 @@ weblink: url: http://192.168.1.1/ icon: mdi:router-wireless - name: Home Assistant - url: https://home-assistant.io + url: https://www.home-assistant.io - name: Grafana url: /grafana ``` diff --git a/source/_components/websocket_api.markdown b/source/_components/websocket_api.markdown index 4eff8a8a3f..5cb8e926d0 100644 --- a/source/_components/websocket_api.markdown +++ b/source/_components/websocket_api.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Websocket API" -description: "Instructions how to setup the WebSocket API within Home Assistant." +description: "Instructions on how to setup the WebSocket API within Home Assistant." date: 2018-01-21 08:00 sidebar: true comments: false diff --git a/source/_components/wemo.markdown b/source/_components/wemo.markdown index 96821a0032..ab0f345bf7 100644 --- a/source/_components/wemo.markdown +++ b/source/_components/wemo.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Belkin WeMo" -description: "Instructions how to integrate Belkin WeMo devices into Home Assistant." +description: "Instructions on how to integrate Belkin WeMo devices into Home Assistant." date: 2016-02-20 00:41 sidebar: true comments: false diff --git a/source/_components/wink.markdown b/source/_components/wink.markdown index e1d617a9e3..cf62b8d380 100644 --- a/source/_components/wink.markdown +++ b/source/_components/wink.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Wink" -description: "Instructions how to setup the Wink hub within Home Assistant." +description: "Instructions on how to setup the Wink hub within Home Assistant." date: 2015-01-20 22:36 sidebar: true comments: false diff --git a/source/_components/xiaomi_aqara.markdown b/source/_components/xiaomi_aqara.markdown index c5cdbcc788..1fd18f55c2 100644 --- a/source/_components/xiaomi_aqara.markdown +++ b/source/_components/xiaomi_aqara.markdown @@ -18,6 +18,9 @@ The `xiaomi_aqara` component allows you to integrate [Xiaomi](http://www.mi.com/ #### {% linkable_title Supported Devices %} +- Xiaomi Aqara Gateway (lumi.gateway.v2, lumi.gateway.v3) +- Aqara Air Conditioning Companion (lumi.acpartner.v3) +- Aqara Intelligent Door Lock (lock.aq1) - Temperature and Humidity Sensor (1st and 2nd generation) - Motion Sensor (1st and 2nd generation) - Door and Window Sensor (1st and 2nd generation) @@ -42,8 +45,8 @@ The `xiaomi_aqara` component allows you to integrate [Xiaomi](http://www.mi.com/ - Gateway Radio - Gateway Button -- Aqara Air Conditioning Companion -- Aqara Intelligent Air Conditioner Controller Hub +- Xiaomi Mi Air Conditioning Companion (lumi.acpartner.v2) +- Aqara Intelligent Air Conditioner Controller Hub (lumi.acpartner.v1) - Decoupled mode of the Aqara Wall Switches (Single & Double) - Additional alarm events of the Gas and Smoke Detector: Analog alarm, battery fault alarm (smoke detector only), sensitivity fault alarm, I2C communication failure @@ -165,12 +168,6 @@ Stops a playing ringtone immediately. #### {% linkable_title Service `xiaomi_aqara.add_device` %} -| Service data attribute | Optional | Description | -|---------------------------|----------|-------------------------------------------------------| -| `gw_mac` | no | MAC address of the Xiaomi Aqara Gateway | - -#### {% linkable_title Service `xiaomi_aqara.add_device` %} - Enables the join permission of the Xiaomi Aqara Gateway for 30 seconds. A new device can be added afterwards by pressing the pairing button once. | Service data attribute | Optional | Description | diff --git a/source/_components/zabbix.markdown b/source/_components/zabbix.markdown index 0bc2fe72cb..e463083999 100644 --- a/source/_components/zabbix.markdown +++ b/source/_components/zabbix.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Zabbix" -description: "Instructions how to integrate Zabbix into Home Assistant." +description: "Instructions on how to integrate Zabbix into Home Assistant." date: 2016-12-13 22:57 sidebar: true comments: false diff --git a/source/_components/zha.markdown b/source/_components/zha.markdown index 2a6b6355f2..0e769fc6a4 100644 --- a/source/_components/zha.markdown +++ b/source/_components/zha.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Zigbee Home Automation" -description: "Instructions how to integrate your Zigbee Home Automation within Home Assistant." +description: "Instructions on how to integrate your Zigbee Home Automation within Home Assistant." date: 2017-02-22 19:59 sidebar: true comments: false @@ -18,15 +18,18 @@ integration for Home Assistant allows you to connect many off-the-shelf ZigBee d There is currently support for the following device types within Home Assistant: -- [Binary Sensor](../binary_sensor.zha) (e.g. motion and door sensors) -- [Sensor](../sensor.zha) (e.g. temperature sensors) +- [Binary Sensor](../binary_sensor.zha) (e.g., motion and door sensors) +- [Sensor](../sensor.zha) (e.g., temperature sensors) - [Light](../light.zha) - [Switch](../switch.zha) +- [Fan](../fan.zha) Known working ZigBee radios: -- Nortek/GoControl Z-Wave & Zigbee USB Adaptor - Model HUSBZB-1 +- Nortek/GoControl Z-Wave & Zigbee USB Adapter - Model HUSBZB-1 - XBee Series 2C +- [Elelabs ZigBee USB Adapter](https://elelabs.com/products/elelabs_usb_adapter.html) +- [Elelabs ZigBee Raspberry Pi Shield](https://elelabs.com/products/elelabs_zigbee_shield.html) To configure the component, a `zha` section must be present in the `configuration.yaml`, and the path to the serial device for the radio and path to the database which will persist your network data is required. diff --git a/source/_components/zone.markdown b/source/_components/zone.markdown index 00d4f7e664..c97d06657f 100644 --- a/source/_components/zone.markdown +++ b/source/_components/zone.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Zone" -description: "Instructions how to setup zones within Home Assistant." +description: "Instructions on how to setup zones within Home Assistant." date: 2015-10-04 09:23 sidebar: true comments: false diff --git a/source/_components/zoneminder.markdown b/source/_components/zoneminder.markdown index 0f3bccbb94..0ebf5fbafc 100644 --- a/source/_components/zoneminder.markdown +++ b/source/_components/zoneminder.markdown @@ -39,6 +39,6 @@ zoneminder: path: ZM_PATH path_zms: ZM_PATH_ZMS ssl: False - username: USERNAME - password: PASSWORD + username: YOUR_USERNAME + password: YOUR_PASSWORD ``` diff --git a/source/_components/zwave.markdown b/source/_components/zwave.markdown index 316c2d3bd1..9dd4811b3e 100644 --- a/source/_components/zwave.markdown +++ b/source/_components/zwave.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Z-Wave" -description: "Instructions how to integrate your existing Z-Wave within Home Assistant." +description: "Instructions on how to integrate your existing Z-Wave within Home Assistant." date: 2016-02-27 19:59 sidebar: true comments: false diff --git a/source/_cookbook/automation_flashing_lights.markdown b/source/_cookbook/automation_flashing_lights.markdown index df14121307..5a55323eac 100644 --- a/source/_cookbook/automation_flashing_lights.markdown +++ b/source/_cookbook/automation_flashing_lights.markdown @@ -97,6 +97,14 @@ script: service: homeassistant.turn_off data: entity_id: switch.REL1 + - alias: loop_room1 + service: script.turn_on + data: + entity_id: script.flash_loop + + flash_loop: + alias: Flash loop + sequence: - delay: # time for flash light off seconds: 1 diff --git a/source/_cookbook/automation_kodi_dynamic_input_select.markdown b/source/_cookbook/automation_kodi_dynamic_input_select.markdown index 040d4f1284..9fc1bbd3f9 100644 --- a/source/_cookbook/automation_kodi_dynamic_input_select.markdown +++ b/source/_cookbook/automation_kodi_dynamic_input_select.markdown @@ -12,7 +12,7 @@ ha_category: Automation Examples This requires a [Kodi](/components/media_player.kodi/) media player, and consists of commands that perform queries in the Kodi library, and a selection box (`input_select`) that shows the available options. By clicking the commands, the selection box is updated, and when selecting an option, Kodi plays the media. -Option filling is done in an [AppDaemon](https://home-assistant.io/docs/ecosystem/appdaemon/tutorial/) app, which listens for events that are triggered with the results of the Kodi JSONRPC API queries when scripts run. This application also listens to the selection box and calls the play media service with the corresponding parameters. +Option filling is done in an [AppDaemon](/docs/ecosystem/appdaemon/tutorial/) app, which listens for events that are triggered with the results of the Kodi JSONRPC API queries when scripts run. This application also listens to the selection box and calls the play media service with the corresponding parameters. The media player yaml config: diff --git a/source/_cookbook/configuration_yaml_by_apocrathia.markdown b/source/_cookbook/configuration_yaml_by_apocrathia.markdown new file mode 100644 index 0000000000..6ac2ccd329 --- /dev/null +++ b/source/_cookbook/configuration_yaml_by_apocrathia.markdown @@ -0,0 +1,12 @@ +--- +layout: page +title: "Configuration.yaml by Apocrathia" +description: "" +date: 2018-05-02 12:40 +sidebar: true +comments: false +sharing: true +footer: true +ha_category: Example configuration.yaml +ha_external_link: https://github.com/Apocrathia/home-assistant-config/ +--- diff --git a/source/_cookbook/configuration_yaml_by_gummientchen.markdown b/source/_cookbook/configuration_yaml_by_gummientchen.markdown new file mode 100644 index 0000000000..3205562886 --- /dev/null +++ b/source/_cookbook/configuration_yaml_by_gummientchen.markdown @@ -0,0 +1,12 @@ +--- +layout: page +title: "Configuration.yaml by Gummientchen" +description: "" +date: 2018-03-23 09:13 +sidebar: true +comments: false +sharing: true +footer: true +ha_category: Example configuration.yaml +ha_external_link: https://github.com/Gummientchen/Home-AssistantConfig +--- diff --git a/source/_cookbook/custom_panel_using_react.markdown b/source/_cookbook/custom_panel_using_react.markdown index 800f2f3378..e526487b0c 100644 --- a/source/_cookbook/custom_panel_using_react.markdown +++ b/source/_cookbook/custom_panel_using_react.markdown @@ -20,7 +20,7 @@ This is a [React](https://facebook.github.io/react/) implementation of [TodoMVC] Download the source [here](https://github.com/home-assistant/example-custom-config/blob/master/panels/react.html). Copy the file to `/panels/` (you might have to create the directory if it doesn't exist). -Create a entry for the panel in your `configuration.yaml` file to enable it. +Create an entry for the panel in your `configuration.yaml` file to enable it. ```yaml panel_custom: diff --git a/source/_cookbook/dim_lights_when_playing_media.markdown b/source/_cookbook/dim_lights_when_playing_media.markdown index e0c19c45d3..a53c90d9f0 100644 --- a/source/_cookbook/dim_lights_when_playing_media.markdown +++ b/source/_cookbook/dim_lights_when_playing_media.markdown @@ -12,7 +12,7 @@ ha_category: Automation Examples Like it how the lights dim up/down at the movies? Do it at home as well! -This example uses the [media player](https://home-assistant.io/components/media_player/), [lights](https://home-assistant.io/components/light/) (transitions) and the [sun](https://home-assistant.io/components/sun/) component. We'll use actions to detect media player state changes and [scenes](https://home-assistant.io/components/scene/) to control multiple lights and transition between scenes. +This example uses the [media player](/components/media_player/), [lights](/components/light/) (transitions) and the [sun](/components/sun/) component. We'll use actions to detect media player state changes and [scenes](/components/scene/) to control multiple lights and transition between scenes. #### {% linkable_title Scenes %} One scene for normal light, one for when movies are on. A 2 second transition gives a nice 'feel' to the switch. diff --git a/source/_cookbook/sonos_say.markdown b/source/_cookbook/sonos_say.markdown index 80a928d7a4..fd4b04b402 100644 --- a/source/_cookbook/sonos_say.markdown +++ b/source/_cookbook/sonos_say.markdown @@ -12,7 +12,7 @@ ha_category: Automation Examples #### {% linkable_title Sonos say script to speak with text-to-speech %} -This script allows you to use [TTS](https://home-assistant.io/components/#text-to-speech) on Sonos. +This script allows you to use [TTS](/components/#text-to-speech) on Sonos. ```yaml script: @@ -46,7 +46,7 @@ automation: trigger: - platform: state entity_id: input_boolean.mytest - action: + action: - service: script.sonos_say data: sonos_entity: media_player.office @@ -54,3 +54,14 @@ automation: message: 'Your husband coming home!' delay: '00:00:05' ``` +Note that this example uses the `voicerss` text-to-speech platform. There are many platforms that can be used. The one installed by default with Home Assistant is Google TTS. This appears in your `configuration.yaml` file as: + +``` + tts: + - platform: google +``` + +If you want to use this TTS engine, change the line in the example provided to: +``` +- service: tts.google_say +``` diff --git a/source/_cookbook/track_battery_level.markdown b/source/_cookbook/track_battery_level.markdown index b623f46b04..13eca37354 100644 --- a/source/_cookbook/track_battery_level.markdown +++ b/source/_cookbook/track_battery_level.markdown @@ -12,7 +12,7 @@ ha_category: Automation Examples ### {% linkable_title iOS Devices %} -If you have a device running iOS (iPhone, iPad, etc), The [iCloud](/components/device_tracker.icloud/) is gathering various details about your device including the battery level. To display it in the Frontend use a [template sensor](/components/sensor.template/). You can also use the icon template option to create a dynamic icon that changes with the battery level. +If you have a device running iOS (iPhone, iPad, etc), The [iCloud](/components/device_tracker.icloud/) is gathering various details about your device including the battery level. To display it in the Frontend use a [template sensor](/components/sensor.template/). You can also the `battery` [sensor device class](/components/sensor/#device-class) to dynamically change the icon with the battery level. {% raw %} ```yaml @@ -21,8 +21,6 @@ sensor: sensors: battery_iphone: friendly_name: iPhone Battery - # "entity_id:" ensures that this sensor will only update when your device tracker does. - entity_id: device_tracker.iphone unit_of_measurement: '%' value_template: >- {%- if states.device_tracker.iphone.attributes.battery %} @@ -30,21 +28,10 @@ sensor: {% else %} {{ states.sensor.battery_iphone.state }} {%- endif %} - icon_template: > - {% set battery_level = states.sensor.battery_iphone.state|default(0)|int %} - {% set battery_round = (battery_level / 10) |int * 10 %} - {% if battery_round >= 100 %} - mdi:battery - {% elif battery_round > 0 %} - mdi:battery-{{ battery_round }} - {% else %} - mdi:battery-alert - {% endif %} + device_class: battery ``` {% endraw %} -The `else` part is used to have the sensor keep its last state if the newest [iCloud](/components/device_tracker.icloud/) update doesn't have any battery state in it (which happens sometimes). Otherwise the sensor will be blank. - ### {% linkable_title Android and iOS Devices %} While running the [Owntracks](/components/device_tracker.owntracks/) device tracker you can retrieve the battery level with a MQTT sensor. Replace username with your MQTT username (for the embedded MQTT it's simply homeassistant), and deviceid with the set Device ID in Owntracks. @@ -57,5 +44,6 @@ sensor: name: "Battery Tablet" unit_of_measurement: "%" value_template: '{{ value_json.batt }}' + device_class: battery ``` {% endraw %} diff --git a/source/_docs/asterisk_mbox.markdown b/source/_docs/asterisk_mbox.markdown index fae79de927..c5f3d7cbd7 100644 --- a/source/_docs/asterisk_mbox.markdown +++ b/source/_docs/asterisk_mbox.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Asterisk Voicemail Server Installation" -description: "Instructions how to integrate your existing Asterisk voicemail within Home Assistant." +description: "Instructions on how to integrate your existing Asterisk voicemail within Home Assistant." date: 2017-06-30 18:30 sidebar: true comments: false diff --git a/source/_docs/automation.markdown b/source/_docs/automation.markdown index 8eb4124183..e50db5d9bf 100644 --- a/source/_docs/automation.markdown +++ b/source/_docs/automation.markdown @@ -47,14 +47,12 @@ State changes can be used as the source of triggers and the current state can be Actions are all about calling services. To explore the available services open the Services developer tool. Services allow to change anything. For example turn on a light, run a script or enable a scene. Each service has a domain and a name. For example the service `light.turn_on` is capable of turning on any light in your system. Services can be passed parameters to for example tell which device to turn on or what color to use. -

-As of version 0.42 you have to set an initial state in your automations in order for Home Assistant to restore them upon restart. +You have to set an initial state in your automations in order for Home Assistant to enable them upon restart. ```text +automation: - alias: Automation Name initial_state: True trigger: ... ``` - -

diff --git a/source/_docs/automation/action.markdown b/source/_docs/automation/action.markdown index ce9d7c9e05..0df212be7c 100644 --- a/source/_docs/automation/action.markdown +++ b/source/_docs/automation/action.markdown @@ -22,13 +22,12 @@ automation: event: sunset action: service: light.turn_on - entity_id: - - light.kitchen - - light.living_room data: brightness: 150 rgb_color: [255, 0, 0] - + entity_id: + - light.kitchen + - light.living_room automation 2: # Notify me on my mobile phone of an event trigger: diff --git a/source/_docs/automation/condition.markdown b/source/_docs/automation/condition.markdown index 78f396fa67..cae9f96a97 100644 --- a/source/_docs/automation/condition.markdown +++ b/source/_docs/automation/condition.markdown @@ -17,6 +17,7 @@ The available conditions for an automation are the same as for the script syntax Example of using condition: ```yaml +automation: - alias: 'Enciende Despacho' trigger: platform: state diff --git a/source/_docs/automation/editor.markdown b/source/_docs/automation/editor.markdown index 3788800fd1..31bced2ddb 100644 --- a/source/_docs/automation/editor.markdown +++ b/source/_docs/automation/editor.markdown @@ -9,7 +9,7 @@ sharing: true footer: true --- -In Home Assistant 0.45 we introduced the first version of our automation editor. If you just created a new configuration with Home Assistant then you're all set! Go to the UI and enjoy. +In Home Assistant 0.45 we introduced the first version of our automation editor. If you just created a new configuration with Home Assistant, then you're all set! Go to the UI and enjoy. From the UI choose **Configuration** which is located in the sidebar, then click on **Automation** to go to the automation editor. Press the **+** sign in the lower right corner to get started. This example is based on the manual steps described in the [Getting started section](/getting-started/automation/) for a [`random` sensor](/components/sensor.random/). @@ -19,7 +19,7 @@ Choose a meaningful name for your automation rules.

-If the value of the sensor is greater than 10 then the automation rule should apply. +If the value of the sensor is greater than 10, then the automation rule should apply.

@@ -39,18 +39,20 @@ As "Service Data" we want a simple text that is shown as part of the notificatio } ``` -Don't forget to save your new automation rule. In order for your saved automation rule to come into effect you will need to go to the **Configuration** page and click on **Reload Automation**. +Don't forget to save your new automation rule. For your saved automation rule to come into effect, you will need to go to the **Configuration** page and click on **Reload Automation**. ## {% linkable_title Updating your configuration to use the editor %} -First check that you have activated the configuration editor. +First, check that you have activated the configuration editor. ```yaml # Activate the configuration editor config: ``` -The automation editor reads and writes to the file `automations.yaml` in your [configuration](/docs/configuration/) folder. Make sure that you have set up the automation component to read from it: +The automation editor reads and writes to the file `automations.yaml` in the root of your [configuration](/docs/configuration/) folder. +Currently, both the name of this file and its location are fixed. +Make sure that you have set up the automation component to read from it: ```yaml # Configuration.yaml example @@ -65,7 +67,7 @@ automation old: platform: ... ``` -You can use the `automation:` and `automation old:` sections in the same time: +You can use the `automation:` and `automation old:` sections at the same time: - `automation old:` to keep your manual designed automations - `automation:` to save the automation created by the online editor @@ -77,7 +79,7 @@ automation old: !include_dir_merge_list automations ## {% linkable_title Migrating your automations to `automations.yaml` %} -If you want to migrate your old automations to use the editor, you'll have to copy them to `automations.yaml`. Make sure that `automations.yaml` remains a list! For each automation that you copy over you'll have to add an `id`. This can be any string as long as it's unique. +If you want to migrate your old automations to use the editor, you'll have to copy them to `automations.yaml`. Make sure that `automations.yaml` remains a list! For each automation that you copy over, you'll have to add an `id`. This can be any string as long as it's unique. For example, the below automation will be triggered when the sun goes from below the horizon to above the horizon. Then, if the temperature is between 17 and 25 degrees, a light will be turned on. diff --git a/source/_docs/automation/examples.markdown b/source/_docs/automation/examples.markdown index 9e28e0b3e7..2e2ade256f 100644 --- a/source/_docs/automation/examples.markdown +++ b/source/_docs/automation/examples.markdown @@ -38,6 +38,7 @@ automation: after: '16:00:00' before: '23:00:00' action: + # With a single service call, we don't need a '-' before service - though you can if you want to service: homeassistant.turn_on entity_id: group.living_room @@ -76,9 +77,9 @@ automation: event_data: entity_id: binary_sensor.cube_158d000103a3de action: - - service_template: notify.pushover - data_template: - title: "Cube event detected" - message: "Cube has triggered this event: {{ trigger.event }}" + service_template: notify.pushover + data_template: + title: "Cube event detected" + message: "Cube has triggered this event: {{ trigger.event }}" ``` {% endraw %} diff --git a/source/_docs/automation/trigger.markdown b/source/_docs/automation/trigger.markdown index b6a9a283a0..748ff6313d 100644 --- a/source/_docs/automation/trigger.markdown +++ b/source/_docs/automation/trigger.markdown @@ -78,7 +78,8 @@ automation:

Listing above and below together means the numeric_state has to be between the two values. -In the example above, a numeric_state that is 17.1-24.9 would fire this trigger. +In the example above, a numeric_state that goes to 17.1-24.9 (from 17 or below, or 25 or above) +would fire this trigger.

### {% linkable_title State trigger %} @@ -182,7 +183,7 @@ automation 3: ### {% linkable_title Zone trigger %} -Zone triggers can trigger when an entity is entering or leaving the zone. For zone automation to work, you need to have setup a device tracker platform that supports reporting GPS coordinates. Currently this is limited to the [OwnTracks platform](/components/device_tracker.owntracks/) as well as the [iCloud platform](/components/device_tracker.icloud/). +Zone triggers can trigger when an entity is entering or leaving the zone. For zone automation to work, you need to have setup a device tracker platform that supports reporting GPS coordinates. This includes [GPS Logger](/components/device_tracker.gpslogger/), the [OwnTracks platform](/components/device_tracker.owntracks/), and the [iCloud platform](/components/device_tracker.icloud/). ```yaml automation: diff --git a/source/_docs/autostart.markdown b/source/_docs/autostart.markdown index 95e9608adc..48ca9fb411 100644 --- a/source/_docs/autostart.markdown +++ b/source/_docs/autostart.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Autostart Home Assistant" -description: "Instructions how to setup Home Assistant to launch on start." +description: "Instructions on how to setup Home Assistant to launch on start." date: 2015-9-1 22:57 sidebar: true comments: false diff --git a/source/_docs/autostart/macos.markdown b/source/_docs/autostart/macos.markdown index 0a1b6ea134..56e6b27c3f 100644 --- a/source/_docs/autostart/macos.markdown +++ b/source/_docs/autostart/macos.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Autostart on macOS" -description: "Instructions how to setup Home Assistant to launch on Apple macOS." +description: "Instructions on how to setup Home Assistant to launch on Apple macOS." date: 2015-9-1 22:57 sidebar: true comments: false diff --git a/source/_docs/autostart/synology.markdown b/source/_docs/autostart/synology.markdown index 2d97b91e57..f19f15ab73 100644 --- a/source/_docs/autostart/synology.markdown +++ b/source/_docs/autostart/synology.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Autostart on Synology NAS boot" -description: "Instructions how to setup Home Assistant to launch on boot on Synology NAS." +description: "Instructions on how to setup Home Assistant to launch on boot on Synology NAS." date: 2015-9-1 22:57 sidebar: true comments: false diff --git a/source/_docs/autostart/systemd.markdown b/source/_docs/autostart/systemd.markdown index e1e1b6b466..17211e5ed9 100644 --- a/source/_docs/autostart/systemd.markdown +++ b/source/_docs/autostart/systemd.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Autostart using systemd" -description: "Instructions how to setup Home Assistant to launch on boot using systemd." +description: "Instructions on how to setup Home Assistant to launch on boot using systemd." date: 2015-9-1 22:57 sidebar: true comments: false @@ -21,7 +21,7 @@ If the preceding command returns the string `systemd`, continue with the instruc A service file is needed to control Home Assistant with `systemd`. The template below should be created using a text editor. Note, root permissions via `sudo` will likely be needed. The following should be noted to modify the template: - `ExecStart` contains the path to `hass` and this may vary. Check with `whereis hass` for the location. -- For most systems, the file is `/etc/systemd/system/home-assistant@[your user].service` with [your user] replaced by the user account that Home Assistant will run as (normally `homeassistant`). In particular, this is the case for Ubuntu 16.04. +- For most systems, the file is `/etc/systemd/system/home-assistant@[your user].service` with [your user] replaced by the user account that Home Assistant will run as (normally `homeassistant`). In particular, this is the case for Ubuntu 16.04. - If unfamiliar with command-line text editors, `sudo nano -w [filename]` can be used with `[filename]` replaced with the full path to the file. Ex. `sudo nano -w /etc/systemd/system/home-assistant@[your user].service`. After text entered, press CTRL-X then press Y to save and exit. - If you're running Home Assistant in a Python virtual environment or a Docker container, please skip to the appropriate template listed below. @@ -41,7 +41,7 @@ WantedBy=multi-user.target ### {% linkable_title Python virtual environment %} -If you've setup Home Assistant in `virtualenv` following our [Python installation guide](https://home-assistant.io/getting-started/installation-virtualenv/) or [manual installation guide for Raspberry Pi](https://home-assistant.io/getting-started/installation-raspberry-pi/), the following template should work for you. If Home Assistant install is not located at `/srv/homeassistant`, please modify the `ExecStart=` line appropriately. +If you've setup Home Assistant in `virtualenv` following our [Python installation guide](/getting-started/installation-virtualenv/) or [manual installation guide for Raspberry Pi](/getting-started/installation-raspberry-pi/), the following template should work for you. If Home Assistant install is not located at `/srv/homeassistant`, please modify the `ExecStart=` line appropriately. ``` [Unit] @@ -80,7 +80,7 @@ WantedBy=multi-user.target ### Next Steps -You need to reload `systemd` to make the daemon aware of the new configuration. +You need to reload `systemd` to make the daemon aware of the new configuration. ```bash $ sudo systemctl --system daemon-reload diff --git a/source/_docs/autostart/upstart.markdown b/source/_docs/autostart/upstart.markdown index b627ab3806..c77660a84d 100644 --- a/source/_docs/autostart/upstart.markdown +++ b/source/_docs/autostart/upstart.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Autostart using Upstart" -description: "Instructions how to setup Home Assistant to launch on boot using Upstart." +description: "Instructions on how to setup Home Assistant to launch on boot using Upstart." date: 2015-9-1 22:57 sidebar: true comments: false diff --git a/source/_docs/configuration.markdown b/source/_docs/configuration.markdown index ae5349fe90..2d0dc0f027 100644 --- a/source/_docs/configuration.markdown +++ b/source/_docs/configuration.markdown @@ -26,12 +26,12 @@ If you want to use a different folder for configuration, use the config command Inside your configuration folder is the file `configuration.yaml`. This is the main file that contains components to be loaded with their configurations. Throughout the documentation you will find snippets that you can add to your configuration file to enable functionality.

- You will have to restart Home Assistant for changes to `configuration.yaml` to take effect. + You will have to restart Home Assistant for most changes to `configuration.yaml` to take effect. You can load changes to [automations](/docs/automation/), [customize](/docs/configuration/customizing-devices/), [groups](/components/group/), and [scripts](/components/script/) without restarting.

If you run into trouble while configuring Home Assistant, have a look at the [configuration troubleshooting page](/getting-started/troubleshooting-configuration/) and at the [configuration.yaml examples](/cookbook/#example-configurationyaml).

- Test any changes to your configuration files from the command line with `hass --script check_config`. This script allows you to test changes without the need to restart Home Assistant. + Test any changes to your configuration files from the command line with `hass --script check_config`. This script allows you to test changes without the need to restart Home Assistant. Remember to run this as the user you run Home Assistant as.

diff --git a/source/_docs/configuration/customizing-devices.markdown b/source/_docs/configuration/customizing-devices.markdown index 71b8a2f561..a76c1ed2aa 100644 --- a/source/_docs/configuration/customizing-devices.markdown +++ b/source/_docs/configuration/customizing-devices.markdown @@ -71,14 +71,15 @@ homeassistant: ### {% linkable_title Device Class %} -Device class is currently supported by the following platforms: +Device class is currently supported by the following components: * [Binary Sensor](/components/binary_sensor/) +* [Sensor](/components/sensor/) * [Cover](/components/cover/) ### {% linkable_title Reloading customize %} -Home Assistant offers a service to reload the core configuration while Home Assistant is running called `homeassistant/reload_core_config`. This allows you to change your customize section and see it being applied without having to restart Home Assistant. To call this service, go to the service developer tool icon service developer tools, select the service `homeassistant/reload_core_config` and click "Call Service". +Home Assistant offers a service to reload the core configuration while Home Assistant is running called `homeassistant.reload_core_config`. This allows you to change your customize section and see it being applied without having to restart Home Assistant. To call this service, go to the service developer tool icon service developer tools, select the service `homeassistant.reload_core_config` and click "CALL SERVICE".

New customize information will be applied the next time the state of the entity gets updated. diff --git a/source/_docs/configuration/entity-registry.markdown b/source/_docs/configuration/entity-registry.markdown index e31e014c32..6c75ad8dfe 100644 --- a/source/_docs/configuration/entity-registry.markdown +++ b/source/_docs/configuration/entity-registry.markdown @@ -52,3 +52,7 @@ value to each entry. cause integrations to fail and might be removed in the future. _Added in Home Assistant 0.64._ + +{% linkable_title Supported Components %} + +At the moment, only the following components are supported: Z-Wave, Hue, Nest, LIFX, Sonos, Apple TV diff --git a/source/_docs/configuration/group_visibility.markdown b/source/_docs/configuration/group_visibility.markdown index acd352a07d..0ea062deb9 100644 --- a/source/_docs/configuration/group_visibility.markdown +++ b/source/_docs/configuration/group_visibility.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Group Visibility" -description: "Instructions how to change group visibility using automations." +description: "Instructions on how to change group visibility using automations." date: 2016-10-29 13:00 sidebar: true comments: false diff --git a/source/_docs/configuration/packages.markdown b/source/_docs/configuration/packages.markdown index 7e5016be99..7c95fa719e 100644 --- a/source/_docs/configuration/packages.markdown +++ b/source/_docs/configuration/packages.markdown @@ -10,9 +10,9 @@ footer: true redirect_from: /topics/packages/ --- -Packages in Home Assistant provides a way to bundle different component's configuration together. We were already introduced to the two configuration styles (specifying platforms entries together or individually) on the [adding devices](/docs/configuration/devices/) page. Both of these configuration methods require you to create the component key in the main `configuration.yaml` file. With packages we have a way to include different components, or parts of configuration using any of the `!include` directives introduced in [splitting the configuration](/docs/configuration/splitting_configuration). +Packages in Home Assistant provides a way to bundle different component's configuration together. We already learned about the two configuration styles (specifying platforms entries together or individually) on the [adding devices](/docs/configuration/devices/) page. Both of these configuration methods require you to create the component key in the main `configuration.yaml` file. With packages we have a way to include different components, or different configuration parts using any of the `!include` directives introduced in [splitting the configuration](/docs/configuration/splitting_configuration). -Packages are configured under the core `homeassistant/packages` in the configuration and take the format of a packages name (no spaces, all lower case) followed by a dictionary with the package config. For example, package `pack_1` would be created as: +Packages are configured under the core `homeassistant/packages` in the configuration and take the format of a package name (no spaces, all lower case) followed by a dictionary with the package config. For example, package `pack_1` would be created as: ```yaml homeassistant: @@ -22,7 +22,7 @@ homeassistant: ...package configuration here... ``` -The package configuration can include: `switch`, `light`, `automation`, `groups` or the majority of the Home Assistant components. +The package configuration can include: `switch`, `light`, `automation`, `groups`, or most other Home Assistant components. It can be specified inline or in a separate YAML file using `!include`. @@ -63,7 +63,7 @@ light: There are some rules for packages that will be merged: -1. Component names may only use the basic form (e.g. `switch`, but not `switch 1` or `switch aa`). +1. Component names may only use the basic form (e.g., `switch`, but not `switch 1` or `switch aa`). 2. Platform based components (`light`, `switch`, etc) can always be merged. 3. Components where entities are identified by a key that will represent the entity_id (`{key: config}`) need to have unique 'keys' between packages and the main configuration file. @@ -81,7 +81,7 @@ Components inside packages can only specify platform entries using configuration ### {% linkable_title Create a packages folder %} -One way to organize packages would be to create a folder named "packages" in your Home Assistant configuration directory. In the packages directory you can store any number of packages in a YAML file. This entry in your `configuration.yaml` will load all packages: +One way to organize packages is to create a folder named "packages" in your Home Assistant configuration directory. In the packages directory you can store any number of packages in a YAML file. This entry in your `configuration.yaml` will load all packages: ```yaml homeassistant: diff --git a/source/_docs/configuration/remote.markdown b/source/_docs/configuration/remote.markdown index 77bacfd35f..a323ff1c98 100644 --- a/source/_docs/configuration/remote.markdown +++ b/source/_docs/configuration/remote.markdown @@ -15,7 +15,7 @@ The most common approach is to set up port forwarding from your router to port 8 A problem with making a port accessible is that some Internet Service Providers only offer dynamic IPs. This can cause you to lose access to Home Assistant while away. You can solve this by using a free Dynamic DNS service like [DuckDNS](https://www.duckdns.org/). -Remember: Just putting a port up is not secure. You should definitely consider encrypting your traffic if you are accessing your Home Assistant installation remotely. For details please check the [set up encryption using Let's Encrypt](/blog/2015/12/13/setup-encryption-using-lets-encrypt/) blog post, or this [detailed guide](https://home-assistant.io/docs/ecosystem/certificates/lets_encrypt/) to using Let's Encrypt with HA. +Remember: Just putting a port up is not secure. You should definitely consider encrypting your traffic if you are accessing your Home Assistant installation remotely. For details please check the [set up encryption using Let's Encrypt](/blog/2015/12/13/setup-encryption-using-lets-encrypt/) blog post, or this [detailed guide](/docs/ecosystem/certificates/lets_encrypt/) to using Let's Encrypt with HA. Protect your communication with a [self-signed certificate](/cookbook/tls_self_signed_certificate/) between your client and the Home Assistant instance. diff --git a/source/_docs/configuration/securing.markdown b/source/_docs/configuration/securing.markdown index 24ec0aa4f0..fa6e91f8d3 100644 --- a/source/_docs/configuration/securing.markdown +++ b/source/_docs/configuration/securing.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Securing" -description: "Instructions how to secure your Home Assistant installation." +description: "Instructions on how to secure your Home Assistant installation." date: 2016-10-06 06:00 sidebar: true comments: false @@ -14,10 +14,10 @@ One major advantage of Home Assistant is that it's not dependent on cloud servic ### {% linkable_title Checklist %} -- [Protect your web interface with a password](https://home-assistant.io/getting-started/basic/#password-protecting-the-web-interface) +- [Protect your web interface with a password](/getting-started/basic/#password-protecting-the-web-interface) - Secure your host. Sources could be [Red Hat Enterprise Linux 7 Security Guide](https://access.redhat.com/documentation/en-US/Red_Hat_Enterprise_Linux/7/pdf/Security_Guide/Red_Hat_Enterprise_Linux-7-Security_Guide-en-US.pdf), [CIS Red Hat Enterprise Linux 7 Benchmark](https://benchmarks.cisecurity.org/tools2/linux/CIS_Red_Hat_Enterprise_Linux_7_Benchmark_v1.0.0.pdf), or the [Securing Debian Manual](https://www.debian.org/doc/manuals/securing-debian-howto/index.en.html). - Restrict network access to your devices. Set `PermitRootLogin no` in your sshd config (usually `/etc/ssh/sshd_config`) and to use SSH keys for authentication instead of passwords. -- Don't run Home Assistant as root – consider the Principle of Least Privilege. +- Don't run Home Assistant as root – consider the Principle of Least Privilege. - Keep your [secrets](/topics/secrets/) safe. If you want to allow remote access, consider these additional points: diff --git a/source/_docs/configuration/splitting_configuration.markdown b/source/_docs/configuration/splitting_configuration.markdown index 3a1a9b6e53..ec0d021ea5 100644 --- a/source/_docs/configuration/splitting_configuration.markdown +++ b/source/_docs/configuration/splitting_configuration.markdown @@ -10,9 +10,9 @@ footer: true redirect_from: /topics/splitting_configuration/ --- -So you've been using Home Assistant for a while now and your [configuration.yaml file brings people to tears](https://home-assistant.io/cookbook/configuration_yaml_from_bassclarinetl2/) or you simply want to start off with the distributed approach, here's how to "split the configuration.yaml" into more manageable (read: humanly readable) pieces. +So you've been using Home Assistant for a while now and your [configuration.yaml file brings people to tears](/cookbook/configuration_yaml_from_bassclarinetl2/) or you simply want to start off with the distributed approach, here's how to "split the configuration.yaml" into more manageable (read: humanly readable) pieces. -First off, several community members have sanitized (read: without api keys/passwords etc) versions of their configurations available for viewing, you can see a list of them [here](https://home-assistant.io/cookbook/#example-configurationyaml). +First off, several community members have sanitized (read: without api keys/passwords etc) versions of their configurations available for viewing, you can see a list of them [here](/cookbook/#example-configurationyaml). As commenting code doesn't always happen, please read on for the details. diff --git a/source/_docs/configuration/state_object.markdown b/source/_docs/configuration/state_object.markdown index c9ee1f9403..fdb99ea075 100644 --- a/source/_docs/configuration/state_object.markdown +++ b/source/_docs/configuration/state_object.markdown @@ -37,7 +37,7 @@ Attribute | Description `icon` | Icon to use for the entity in the frontend. Example: `mdi:home`. `hidden` | Boolean if the entity should not be shown in the frontend. Example: `true`. `entity_picture` | URL to a picture that should be used instead of showing the domain icon. Example: `http://example.com/picture.jpg`. -`assumed_state` | Boolean if the current state is an assumption. [More info](https://home-assistant.io/blog/2016/02/12/classifying-the-internet-of-things/#classifiers) Example: `True`. +`assumed_state` | Boolean if the current state is an assumption. [More info](/blog/2016/02/12/classifying-the-internet-of-things/#classifiers) Example: `True`. `unit_of_measurement` | The unit of measurement the state is expressed in. Used for grouping graphs or understanding the entity. Example: `°C`. When an attribute contains spaces, you can retrieve it like this: `states.sensor.livingroom.attributes["Battery numeric"]`. diff --git a/source/_docs/configuration/templating.markdown b/source/_docs/configuration/templating.markdown index 1e26ff126c..dfcd8bddce 100644 --- a/source/_docs/configuration/templating.markdown +++ b/source/_docs/configuration/templating.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Templating" -description: "Instructions how to use the templating feature of Home Assistant." +description: "Instructions on how to use the templating feature of Home Assistant." date: 2015-12-12 12:00 sidebar: true comments: false @@ -68,6 +68,7 @@ Home Assistant adds extensions to allow templates to access all of the current s - `states.sensor.temperature` returns the state object for `sensor.temperature`. - `states('device_tracker.paulus')` will return the state string (not the object) of the given entity or `unknown` if it doesn't exist. - `is_state('device_tracker.paulus', 'home')` will test if the given entity is specified state. +- `state_attr('device_tracker.paulus', 'battery')` will return the value of the attribute or None if it doesn't exist. - `is_state_attr('device_tracker.paulus', 'battery', 40)` will test if the given entity is specified state. - `now()` will be rendered as current time in your time zone. - For specific values: `now().second`, `now().minute`, `now().hour`, `now().day`, `now().month`, `now().year`, `now().weekday()` and `now().isoweekday()` @@ -79,14 +80,25 @@ Home Assistant adds extensions to allow templates to access all of the current s - `float` will format the output as float. - `strptime(string, format)` will parse a string to a datetime based on a [format][strp-format]. - `log(value, base)` will take the logarithm of the input. When the base is omitted, it defaults to `e` - the natural logarithm. Can also be used as a filter. +- `sin(value)` will return the sine of the input. Can be used as a filter. +- `cos(value)` will return the cosine of the input. Can be used as a filter. +- `tan(value)` will return the tangent of the input. Can be used as a filter. +- `sqrt(value)` will return the square root of the input. Can be used as a filter. +- `e` mathematical constant, approximately 2.71828. +- `pi` mathematical constant, approximately 3.14159. +- `tau` mathematical constant, approximately 6.28318. - Filter `round(x)` will convert the input to a number and round it to `x` decimals. - Filter `timestamp_local` will convert an UNIX timestamp to local time/data. - Filter `timestamp_utc` will convert an UNIX timestamp to UTC time/data. - Filter `timestamp_custom(format_string, local_boolean)` will convert an UNIX timestamp to a custom format, the use of a local timestamp is default, supporting [Python format options](https://docs.python.org/3/library/time.html#time.strftime). -- Filter `max` will obtain the larget item in a sequence. +- Filter `max` will obtain the largest item in a sequence. - Filter `min` will obtain the smallest item in a sequence. +- Filter `regex_match(string, find, ignorecase=FALSE)` will match the find expression at the beginning of the string using regex. +- Filter `regex_search(string, find, ignorecase=FALSE)` will match the find expression anywhere in the string using regex. +- Filter `regex_replace(string, find='', replace='', ignorecase=False)` will replace the find expression with the replace string using regex. +- Filter `regex_findall_index(string, find='', index=0, ignorecase=False)` will find all regex matches of find in string and return the match at index (findall returns an array of matches). -[strp-format]: https://docs.python.org/3.4/library/datetime.html#strftime-and-strptime-behavior +[strp-format]: https://docs.python.org/3.6/library/datetime.html#strftime-and-strptime-behavior

If your template uses an `entity_id` that begins with a number (example: `states.device_tracker.2008_gmc`) you must use a bracket syntax to avoid errors caused by rendering the `entity_id` improperly. In the example given, the correct syntax for the device tracker would be: `states.device_tracker['2008_gmc']` @@ -114,7 +126,7 @@ The next two statements result in same value if state exists. The second one wil ### {% linkable_title Attributes %} -Print an attribute if state is defined +Print an attribute if state is defined. Both will return the same thing but the last one you can specify entity_id from a variable. ```text {% raw %}{% if states.device_tracker.paulus %} @@ -124,6 +136,18 @@ Print an attribute if state is defined {% endif %}{% endraw %} ``` +With strings + +```text +{% raw %}{% set tracker_name = "paulus"%} + +{% if states("device_tracker." + tracker_name) != "unknown" %} + {{ state_attr("device_tracker." + tracker_name, "battery")}} +{% else %} + ?? +{% endif %}{% endraw %} +``` + ### {% linkable_title Sensor states %} Print out a list of all the sensor states. @@ -257,6 +281,10 @@ The following overview contains a couple of options to get the needed values: {% raw %}{{ float(value_json) * (2**10) }}{% endraw %} {% raw %}{{ value_json | log }}{% endraw %} {% raw %}{{ log(1000, 10) }}{% endraw %} +{% raw %}{{ sin(pi / 2) }}{% endraw %} +{% raw %}{{ cos(tau) }}{% endraw %} +{% raw %}{{ tan(pi) }}{% endraw %} +{% raw %}{{ sqrt(e) }}{% endraw %} # Timestamps {% raw %}{{ value_json.tst | timestamp_local }}{% endraw %} diff --git a/source/_docs/configuration/troubleshooting.markdown b/source/_docs/configuration/troubleshooting.markdown index f1b88fe876..0d867a2622 100644 --- a/source/_docs/configuration/troubleshooting.markdown +++ b/source/_docs/configuration/troubleshooting.markdown @@ -20,7 +20,7 @@ Whenever a component or configuration option results in a warning, it will be st When a component does not show up, many different things can be the case. Before you try any of these steps, make sure to look at the `home-assistant.log` file and see if there are any errors related to your component you are trying to set up. -If you have incorrect entries in your configuration files you can use the `check_config` script to assist in identifying them: `hass --script check_config`. +If you have incorrect entries in your configuration files you can use the [`check_config`](/docs/tools/check_config/) script to assist in identifying them: `hass --script check_config`. If you need to provide the path for your configuration you can do this using the `-c` argument like this: `hass --script check_config -c /path/to/your/config/dir`. #### {% linkable_title Problems with the configuration %} diff --git a/source/_docs/configuration/yaml.markdown b/source/_docs/configuration/yaml.markdown index 9398ec30bd..68503dab96 100644 --- a/source/_docs/configuration/yaml.markdown +++ b/source/_docs/configuration/yaml.markdown @@ -93,3 +93,15 @@ lights: !include lights.yaml ``` More information about this feature can also be found at [splitting configuration](/docs/configuration/splitting_configuration/). + +## {% linkable_title Common Issues %} + +### {% linkable_title found character '\t' %} + +If you see the following message: + +``` +found character '\t' that cannot start any token +``` + +This means that you've mistakenly entered a tab character, instead of spaces. diff --git a/source/_docs/ecosystem/apache.markdown b/source/_docs/ecosystem/apache.markdown index ae0c192511..92c27eb51a 100644 --- a/source/_docs/ecosystem/apache.markdown +++ b/source/_docs/ecosystem/apache.markdown @@ -35,10 +35,10 @@ To be able to access to your Home Assistant instance by using https://home.examp ServerName home.example.org ProxyPreserveHost On ProxyRequests off - ProxyPass / http://localhost:8123/ - ProxyPassReverse / http://localhost:8123/ ProxyPass /api/websocket ws://localhost:8123/api/websocket ProxyPassReverse /api/websocket ws://localhost:8123/api/websocket + ProxyPass / http://localhost:8123/ + ProxyPassReverse / http://localhost:8123/ RewriteEngine on RewriteCond %{HTTP:Upgrade} =websocket [NC] diff --git a/source/_docs/ecosystem/appdaemon/api.markdown b/source/_docs/ecosystem/appdaemon/api.markdown index 48c8d994ba..923505b262 100755 --- a/source/_docs/ecosystem/appdaemon/api.markdown +++ b/source/_docs/ecosystem/appdaemon/api.markdown @@ -39,7 +39,7 @@ There are several circumstances under which `initialize()` might be called: - Following a change in the status of Daylight Savings Time - Following a restart of Home Assistant -In every case, the App is responsible for recreating any state it might need as if it were the first time it was ever started. If `initialize()` is called, the app can safely assume that it is either being loaded for the first time, or that all callbacks and timers have been canceled. In either case, the APP will need to recreate them. Depending upon the application it may be desirable for the App to establish state such as whether or not a particular light is on, within the `initialize()` function to ensure that everything is as expected or to make immediate remedial action (e.g. turn off a light that might have been left on by mistake when the app was restarted). +In every case, the App is responsible for recreating any state it might need as if it were the first time it was ever started. If `initialize()` is called, the app can safely assume that it is either being loaded for the first time, or that all callbacks and timers have been canceled. In either case, the APP will need to recreate them. Depending upon the application it may be desirable for the App to establish state such as whether or not a particular light is on, within the `initialize()` function to ensure that everything is as expected or to make immediate remedial action (e.g., turn off a light that might have been left on by mistake when the app was restarted). After the `initialize()` function is in place, the rest of the app consists of functions that are called by the various callback mechanisms, and any additional functions the user wants to add as part of the program logic. Apps are able to subscribe to 2 main classes of events: @@ -150,7 +150,7 @@ light = light.garage ## {% linkable_title Callback Constraints %} -Callback constraints are a feature of AppDaemon that removes the need for repetition of some common coding checks. Many Apps will wish to process their callbacks only when certain conditions are met, e.g. someone is home, and it's after sunset. These kinds of conditions crop up a lot, and use of callback constraints can significantly simplify the logic required within callbacks. +Callback constraints are a feature of AppDaemon that removes the need for repetition of some common coding checks. Many Apps will wish to process their callbacks only when certain conditions are met, e.g., someone is home, and it's after sunset. These kinds of conditions crop up a lot, and use of callback constraints can significantly simplify the logic required within callbacks. Put simply, callback constraints are one or more conditions on callback execution that can be applied to an individual App. An App's callbacks will only be executed if all of the constraints are met. If a constraint is absent it will not be checked for. @@ -194,7 +194,7 @@ constrain_input_boolean = input_boolean.enable_motion_detection,off ``` ### {% linkable_title input_select %} -The input_select constraint prevents callbacks unless the specified input_select is set to one or more of the nominated (comma separated) values. This is useful to allow certain Apps to be turned on and off according to some flag, e.g. a house mode flag. +The input_select constraint prevents callbacks unless the specified input_select is set to one or more of the nominated (comma separated) values. This is useful to allow certain Apps to be turned on and off according to some flag, e.g., a house mode flag. ```ini # Single value @@ -272,7 +272,7 @@ Any other attributes such as brightness for a lamp will only be present if the e Also bear in mind that some attributes such as brightness for a light, will not be present when the light is off. -In most cases, the attribute `state` has the most important value in it, e.g. for a light or switch this will be `on` or `off`, for a sensor it will be the value of that sensor. Many of the AppDaemon API calls and callbacks will implicitly return the value of state unless told to do otherwise. +In most cases, the attribute `state` has the most important value in it, e.g., for a light or switch this will be `on` or `off`, for a sensor it will be the value of that sensor. Many of the AppDaemon API calls and callbacks will implicitly return the value of state unless told to do otherwise. ### {% linkable_title get_state() %} @@ -294,9 +294,9 @@ All parameters are optional, and if `get_state()` is called with no parameters i ##### {% linkable_title entity %} -This is the name of an entity or device type. If just a device type is provided, e.g. `light` or `binary_sensor`, `get_state()` will return a dictionary of all devices of that type, indexed by the entity_id, containing all the state for each entity. +This is the name of an entity or device type. If just a device type is provided, e.g., `light` or `binary_sensor`, `get_state()` will return a dictionary of all devices of that type, indexed by the entity_id, containing all the state for each entity. -If a fully qualified `entity_id` is provided, `get_state()` will return the state attribute for that entity, e.g. `on` or `off` for a light. +If a fully qualified `entity_id` is provided, `get_state()` will return the state attribute for that entity, e.g., `on` or `off` for a light. ##### {% linkable_title attribute %} @@ -345,11 +345,11 @@ set_state(entity_id, **kwargs) ##### {% linkable_title entity_id %} -Entity id for which the state is to be set, e.g. `light.office_1`. +Entity id for which the state is to be set, e.g., `light.office_1`. ##### {% linkable_title values %} -A list of keyword values to be changed or added to the entities state. e.g. `state = "off"`. Note that any optional attributes such as colors for bulbs etc, need to reside in a dictionary called `attributes`; see the example. +A list of keyword values to be changed or added to the entities state. e.g., `state = "off"`. Note that any optional attributes such as colors for bulbs etc, need to reside in a dictionary called `attributes`; see the example. #### {% linkable_title Examples %} @@ -461,7 +461,7 @@ handle = listen_state(callback, entity = None, **kwargs) #### {% linkable_title Returns %} -A unique identifier that can be used to cancel the callback if required. Since variables created within object methods are local to the function they are created in, and in all likelihood the cancellation will be invoked later in a different function, it is recommended that handles are stored in the object namespace, e.g. `self.handle`. +A unique identifier that can be used to cancel the callback if required. Since variables created within object methods are local to the function they are created in, and in all likelihood the cancellation will be invoked later in a different function, it is recommended that handles are stored in the object namespace, e.g., `self.handle`. #### {% linkable_title Parameters %} @@ -473,9 +473,9 @@ Function to be invoked when the requested state change occurs. It must conform t ##### {% linkable_title entity %} -This is the name of an entity or device type. If just a device type is provided, e.g. `light` or `binary_sensor`, `listen_state()` will subscribe to state changes of all devices of that type. If a fully qualified `entity_id` is provided, `listen_state()` will listen for state changes for just that entity. +This is the name of an entity or device type. If just a device type is provided, e.g., `light` or `binary_sensor`, `listen_state()` will subscribe to state changes of all devices of that type. If a fully qualified `entity_id` is provided, `listen_state()` will listen for state changes for just that entity. -When called, AppDaemon will supply the callback function, in old and new, with the state attribute for that entity, e.g. `on` or `off` for a light. +When called, AppDaemon will supply the callback function, in old and new, with the state attribute for that entity, e.g., `on` or `off` for a light. ##### {% linkable_title attribute (optional) %} @@ -949,11 +949,11 @@ All of the scheduler calls above support 2 additional optional arguments, `rando For example: ```python -# Run a callback in 2 minutes minus a random number of seconds between 0 and 60, e.g. run between 60 and 120 seconds from now +# Run a callback in 2 minutes minus a random number of seconds between 0 and 60, e.g., run between 60 and 120 seconds from now self.handle = self.run_in(callback, 120, random_start = -60, **kwargs) -# Run a callback in 2 minutes plus a random number of seconds between 0 and 60, e.g. run between 120 and 180 seconds from now +# Run a callback in 2 minutes plus a random number of seconds between 0 and 60, e.g., run between 120 and 180 seconds from now self.handle = self.run_in(callback, 120, random_end = 60, **kwargs) -# Run a callback in 2 minutes plus or minus a random number of seconds between 0 and 60, e.g. run between 60 and 180 seconds from now +# Run a callback in 2 minutes plus or minus a random number of seconds between 0 and 60, e.g., run between 60 and 180 seconds from now self.handle = self.run_in(callback, 120, random_start = -60, random_end = 60, **kwargs) ``` @@ -1150,11 +1150,11 @@ None ##### {% linkable_title service %} -The service name, e.g. `light.turn_on`. +The service name, e.g., `light.turn_on`. ##### {% linkable_title \*\*kwargs %} -Each service has different parameter requirements. This argument allows you to specify a comma separated list of keyword value pairs, e.g. `entity_id = light.office_1`. These parameters will be different for every service and can be discovered using the developer tools. Most if not all service calls require an `entity_id` however, so use of the above example is very common with this call. +Each service has different parameter requirements. This argument allows you to specify a comma separated list of keyword value pairs, e.g., `entity_id = light.office_1`. These parameters will be different for every service and can be discovered using the developer tools. Most if not all service calls require an `entity_id` however, so use of the above example is very common with this call. #### {% linkable_title Examples %} @@ -1187,7 +1187,7 @@ None ##### {% linkable_title entity_id %} -Fully qualified entity_id of the thing to be turned on, e.g. `light.office_lamp` or ```scene.downstairs_on``` +Fully qualified entity_id of the thing to be turned on, e.g., `light.office_lamp` or ```scene.downstairs_on``` ##### {% linkable_title \*\*kwargs %} @@ -1219,7 +1219,7 @@ None ##### {% linkable_title entity_id %} -Fully qualified entity_id of the thing to be turned off, e.g. `light.office_lamp` or `scene.downstairs_on`. +Fully qualified entity_id of the thing to be turned off, e.g., `light.office_lamp` or `scene.downstairs_on`. #### {% linkable_title Examples %} @@ -1246,7 +1246,7 @@ None ##### {% linkable_title entity_id %} -Fully qualified entity_id of the thing to be toggled, e.g. `light.office_lamp` or `scene.downstairs_on`. +Fully qualified entity_id of the thing to be toggled, e.g., `light.office_lamp` or `scene.downstairs_on`. #### {% linkable_title Examples %} @@ -1273,7 +1273,7 @@ None ##### {% linkable_title entity_id %} -Fully qualified entity_id of the input_number to be changed, e.g. `input_number.alarm_hour`. +Fully qualified entity_id of the input_number to be changed, e.g., `input_number.alarm_hour`. ##### {% linkable_title value %} @@ -1303,7 +1303,7 @@ None ##### {% linkable_title entity_id %} -Fully qualified entity_id of the input_select to be changed, e.g. `input_select.mode`. +Fully qualified entity_id of the input_select to be changed, e.g., `input_select.mode`. ##### {% linkable_title value %} @@ -1385,7 +1385,7 @@ A standard Python object reference. #### {% linkable_title event_name %} -Name of the event that was called, e.g. `call_service`. +Name of the event that was called, e.g., `call_service`. #### {% linkable_title data %} @@ -1422,7 +1422,7 @@ Name of the event to subscribe to. Can be a standard Home Assistant event such a One or more keyword value pairs representing App specific parameters to supply to the callback. If the keywords match values within the event data, they will act as filters, meaning that if they don't match the values, the callback will not fire. -As an example of this, a Minimote controller when activated will generate an event called `zwave.scene_activated`, along with 2 pieces of data that are specific to the event - `entity_id` and `scene`. If you include keyword values for either of those, the values supplied to the `listen_event()1 call must match the values in the event or it will not fire. If the keywords do not match any of the data in the event they are simply ignored. +As an example of this, a Minimote controller when activated will generate an event called `zwave.scene_activated`, along with 2 pieces of data that are specific to the event - `entity_id` and `scene`. If you include keyword values for either of those, the values supplied to the `listen_event()` call must match the values in the event or it will not fire. If the keywords do not match any of the data in the event they are simply ignored. Filtering will work with any event type, but it will be necessary to figure out the data associated with the event to understand what values can be filtered on. This can be achieved by examining Home Assistant's logfiles when the event fires. @@ -1528,7 +1528,7 @@ def service(self, event_name, data): #### {% linkable_title event_name %} -The name of the event that caused the callback, e.g. `"MODE_CHANGE"` or `call_service`. +The name of the event that caused the callback, e.g., `"MODE_CHANGE"` or `call_service`. #### {% linkable_title data %} @@ -1617,7 +1617,7 @@ A string representing the location of the tracker. ##### {% linkable_title tracker_id %} -Fully qualified entity_id of the device tracker to query, e.g. `device_tracker.andrew`. +Fully qualified entity_id of the device tracker to query, e.g., `device_tracker.andrew`. #### {% linkable_title Examples %} @@ -1871,7 +1871,7 @@ self.log("{} ({}) is {}".format(tracker, self.friendly_name(tracker), self.get_ ### {% linkable_title split_entity() %} -`split_entity()` will take a fully qualified entity id of the form `light.hall_light` and split it into 2 values, the device and the entity, e.g. `light` and `hall_light`. +`split_entity()` will take a fully qualified entity id of the form `light.hall_light` and split it into 2 values, the device and the entity, e.g., `light` and `hall_light`. #### {% linkable_title Synopsis %} @@ -1925,7 +1925,7 @@ MyApp.turn_light_on() ### {% linkable_title split_device_list() %} -`split_device_list()` will take a comma separated list of device types (or anything else for that matter) and return them as an iterable list. This is intended to assist in use cases where the App takes a list of entities from an argument, e.g. a list of sensors to monitor. If only one entry is provided, an iterable list will still be returned to avoid the need for special processing. +`split_device_list()` will take a comma separated list of device types (or anything else for that matter) and return them as an iterable list. This is intended to assist in use cases where the App takes a list of entities from an argument, e.g., a list of sensors to monitor. If only one entry is provided, an iterable list will still be returned to avoid the need for special processing. #### {% linkable_title Synopsis %} @@ -1941,7 +1941,7 @@ A list of split devices with 1 or more entries. ```python for sensor in self.split_device_list(self.args["sensors"]): - do something for each sensor, e.g. make a state subscription + do something for each sensor, e.g., make a state subscription ``` diff --git a/source/_docs/ecosystem/appdaemon/tutorial.markdown b/source/_docs/ecosystem/appdaemon/tutorial.markdown index 962be8ea9f..28f325dfa0 100755 --- a/source/_docs/ecosystem/appdaemon/tutorial.markdown +++ b/source/_docs/ecosystem/appdaemon/tutorial.markdown @@ -12,7 +12,7 @@ redirect_from: /ecosystem/appdaemon/tutorial/ ## {% linkable_title Another Take on Automation %} -If you haven't yet read Paulus' excellent Blog entry on [Perfect Home Automation](https://home-assistant.io/blog/2016/01/19/perfect-home-automation/) I would encourage you to take a look. As a veteran of several Home Automation systems with varying degrees success, it was this article more than anything else that convinced me that Home Assistant had the right philosophy behind it and was on the right track. One of the most important points made is that being able to control your lights from your phone, 9 times out of 10 is harder than using a lightswitch - where Home Automation really comes into its own is when you start removing the need to use a phone or the switch - the "Automation" in Home Automation. A surprisingly large number of systems out there miss this essential point and have limited abilities to automate anything which is why a robust and open system such as Home Assistant is such an important part of the equation in bring this all together in the vast and chaotic ecosystem that is the "Internet of Things". +If you haven't yet read Paulus' excellent Blog entry on [Perfect Home Automation](/blog/2016/01/19/perfect-home-automation/) I would encourage you to take a look. As a veteran of several Home Automation systems with varying degrees success, it was this article more than anything else that convinced me that Home Assistant had the right philosophy behind it and was on the right track. One of the most important points made is that being able to control your lights from your phone, 9 times out of 10 is harder than using a lightswitch - where Home Automation really comes into its own is when you start removing the need to use a phone or the switch - the "Automation" in Home Automation. A surprisingly large number of systems out there miss this essential point and have limited abilities to automate anything which is why a robust and open system such as Home Assistant is such an important part of the equation in bring this all together in the vast and chaotic ecosystem that is the "Internet of Things". So given the importance of Automation, what should Automation allow us to do? I am a pragmatist at heart so I judge individual systems by the ease of accomplishing a few basic but representative tasks: @@ -29,7 +29,7 @@ So why `AppDaemon`? AppDaemon is not meant to replace Home Assistant Automations - New paradigm - some problems require a procedural and/or iterative approach, and `AppDaemon` Apps are a much more natural fit for this. Recent enhancements to Home Assistant scripts and templates have made huge strides, but for the most complex scenarios, Apps can do things that Automations can't - Ease of use - AppDaemon's API is full of helper functions that make programming as easy and natural as possible. The functions and their operation are as "Pythonic" as possible, experienced Python programmers should feel right at home. -- Reuse - write a piece of code once and instantiate it as an app as many times as you need with different parameters e.g. a motion light program that you can use in 5 different places around your home. The code stays the same, you just dynamically add new instances of it in the config file +- Reuse - write a piece of code once and instantiate it as an app as many times as you need with different parameters e.g., a motion light program that you can use in 5 different places around your home. The code stays the same, you just dynamically add new instances of it in the config file - Dynamic - AppDaemon has been designed from the start to enable the user to make changes without requiring a restart of Home Assistant, thanks to its loose coupling. However, it is better than that - the user can make changes to code and AppDaemon will automatically reload the code, figure out which Apps were using it and restart them to use the new code with out the need to restart `AppDaemon` itself. It is also possible to change parameters for an individual or multiple apps and have them picked up dynamically, and for a final trick, removing or adding apps is also picked up dynamically. Testing cycles become a lot more efficient as a result. - Complex logic - Python's If/Else constructs are clearer and easier to code for arbitrarily complex nested logic - Durable variables and state - variables can be kept between events to keep track of things like the number of times a motion sensor has been activated, or how long it has been since a door opened @@ -69,7 +69,7 @@ different scenes in a different version of the App. def initialize(self): self.run_at_sunrise(self.sunrise_cb) self.run_at_sunset(self.before_sunset_cb, offset=-900) - + def sunrise_cb(self, kwargs): self.turn_on(self.args["off_scene"]) @@ -91,12 +91,12 @@ class FlashyMotionLights(appapi.AppDaemon): def initialize(self): self.listen_state(self.motion, "binary_sensor.drive", new = "on") - + def motion(self, entity, attribute, old, new, kwargs): if self.sun_down(): self.turn_on("light.drive") self.run_in(self.light_off, 60) - + def light_off(self, kwargs): self.turn_off("light.drive") ``` @@ -112,17 +112,17 @@ class MotionLights(appapi.AppDaemon): def initialize(self): self.listen_state(self.motion, "binary_sensor.drive", new = "on") - + def motion(self, entity, attribute, old, new, kwargs): if self.self.sun_down(): self.turn_on("light.drive") self.run_in(self.light_off, 60) self.flashcount = 0 self.run_in(self.flash_warning, 1) - + def light_off(self, kwargs): self.turn_off("light.drive") - + def flash_warning(self, kwargs): self.toggle("light.living_room") self.flashcount += 1 @@ -138,7 +138,7 @@ I have spent the last few weeks moving all of my (fairly complex) automations ov Some people will maybe look at all of this and say "what use is this, I can already do all of this", and that is fine, as I said this is an alternative not a replacement, but I am hopeful that for some users this will seem a more natural, powerful and nimble way of building potentially very complex automations. -If this has whet your appetite, feel free to give it a try. +If this has whet your appetite, feel free to give it a try. Happy Automating! diff --git a/source/_docs/ecosystem/backup/backup_dropbox.markdown b/source/_docs/ecosystem/backup/backup_dropbox.markdown index e0d7336899..6baa2cbc9a 100644 --- a/source/_docs/ecosystem/backup/backup_dropbox.markdown +++ b/source/_docs/ecosystem/backup/backup_dropbox.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Configuration Backup to Dropbox" -description: "Instructions how backup your Home Assistant configuration to Dropbox" +description: "Instructions on how backup your Home Assistant configuration to Dropbox" date: 2017-04-24 18:00 sidebar: true comments: false @@ -10,7 +10,7 @@ footer: true redirect_from: /cookbook/dropboxbackup/ --- -Backing up and regularly syncing your Home Assistant configuration to [Dropbox](http://dropbox.com) similar to [Github Backup](https://home-assistant.io/docs/ecosystem/backup/backup_github/) +Backing up and regularly syncing your Home Assistant configuration to [Dropbox](http://dropbox.com) similar to [Github Backup](/docs/ecosystem/backup/backup_github/) ### {% linkable_title Requirements %} diff --git a/source/_docs/ecosystem/backup/backup_github.markdown b/source/_docs/ecosystem/backup/backup_github.markdown index db4ab29626..278d3fc20c 100644 --- a/source/_docs/ecosystem/backup/backup_github.markdown +++ b/source/_docs/ecosystem/backup/backup_github.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Configuration Backup to GitHub" -description: "Instructions how backup your Home Assistant configuration to GitHub" +description: "Instructions on how backup your Home Assistant configuration to GitHub" date: 2017-01-05 18:00 sidebar: true comments: false @@ -28,21 +28,21 @@ This will not create a full backup of your Home Assistant files or your OS. In a Some best practices to consider before putting your configuration on GitHub: -- Extensive use of [secrets.yaml](https://home-assistant.io/topics/secrets/) to hide sensitive information like usernames, passwords, device information, and location +- Extensive use of [secrets.yaml](/topics/secrets/) to hide sensitive information like usernames, passwords, device information, and location - Exclusion of some files, including `secrets.yaml` and device-specific information using a [`.gitignore`](https://git-scm.com/docs/gitignore) file - Regularly committing your configuration to GitHub to make sure that your backup is up to date - Use a README.md to document your configuration and include screenshots of your Home Assistant GUI ### {% linkable_title Step 1: Installing and Initializing Git %} -In order to put your configuration on GitHub, you must install the git package on your Home Assistant server (instructions below will work on Raspberry Pi, Ubunutu, or any Debian-based system): +In order to put your configuration on GitHub, you must install the git package on your Home Assistant server (instructions below will work on Raspberry Pi, Ubunutu, or any Debian-based system) *note: this isn't required in Hass.io, it's included as default so proceed to step 2*: ```bash $ sudo apt-get update $ sudo apt-get install git ``` -### {% linkable_title Step 2: Creating %} `.gitignore` +### {% linkable_title Step 2: Creating %} `.gitignore`

Before creating and pushing your Home Assistant configuration to GitHub, please make sure to follow the `secrets.yaml` best practice mentioned above and scrub your configuration for any passwords or sensitive information. diff --git a/source/_docs/ecosystem/backup/backup_usb.markdown b/source/_docs/ecosystem/backup/backup_usb.markdown index 6bd6276883..cc07a0b079 100644 --- a/source/_docs/ecosystem/backup/backup_usb.markdown +++ b/source/_docs/ecosystem/backup/backup_usb.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Configuration Backup to USB drive" -description: "Instructions how backup your Home Assistant configuration to USB drive" +description: "Instructions on how backup your Home Assistant configuration to USB drive" date: 2017-04-29 08:00 sidebar: true comments: false @@ -9,11 +9,12 @@ sharing: true footer: true --- -Backing up your Home Assistant configuration to USB drive. A good plus side is that you don't need to mask all your passwords since the backup is locally at your home/residence. +This will step you through the process of setting up a backup of your Home Assistant configuration to a USB device. This is a good method if you don't want to mask all of your passwords since the backup is kept locally at your home/residence. ### {% linkable_title Requirements %} -First you need a USB drive. Once you have one you need to prepare it to be used on your device. -Once connected you want to format/work with the drive. To know what path it is in, you can check with `dmesg`. + +First, you need a USB drive. It should be formatted properly for your device and connected to your device before beginning. Any type of partition will work, but Linux filesystems are preferred so that you can set permissions. +Once connected you want to mount the drive. To find the path where it is located, you can use the `dmesg` command. ```bash # dmesg | grep sd @@ -32,16 +33,17 @@ Once connected you want to format/work with the drive. To know what path it is i [726259.209004] sd 0:0:0:0: [sda] Attached SCSI removable disk ``` -Here we see we have a drive on `/dev/sda1`. We assume you created a partition on the drive to start with. This can be any type of partition. Preferred is a Linux filesystem type so you can set permissions! +The device here is `sda` and our partition is `sda1`. So our partition is located here `/dev/sda1`. Mount the drive (as root) to `/media` ```bash -# mount /dev/sda1 /media/ +# sudo mount /dev/sda1 /media/ ``` -### {% linkable_title Prepare USB Stick %} -Change into it and create a folder called `hassbackup` and change the ownership to the user that runs Home Assistant. In my case group and user are both `homeassistant`. +### {% linkable_title Prepare the USB Device %} + +Change to the `/media` directory and create a folder called `hassbackup`. Change the ownership to the user that runs Home Assistant. In this example case, the user and group are both `homeassistant`. ```bash # cd /media/ @@ -54,11 +56,10 @@ drwxr-xr-x 22 root root 4096 Mar 22 18:37 .. drwxr-xr-x 2 homeassistant homeassistant 4096 Apr 29 10:36 hassbackup drwx------ 2 root root 16384 Apr 29 10:18 lost+found ``` -You can ignore 'lost+found'. ### {% linkable_title Install Dependency %} -In order to preserve space on your drive we use zip. Install that too. +The script in the next section uses zip to preserve space on your drive. So we will install zip next. ```bash /media# apt-get install zip @@ -68,9 +69,9 @@ Building dependency tree Setting up zip (3.0-8) ... ``` -### {% linkable_title Install and run script %} +### {% linkable_title Download and Run Script %} -Become the `homeassistant` user and place the following [script](https://gist.github.com/riemers/041c6a386a2eab95c55ba3ccaa10e7b0) to a place of your liking. +Become the `homeassistant` user (or whatever user runs Home Assistant). Change to whatever directory you would like the [script](https://gist.github.com/riemers/041c6a386a2eab95c55ba3ccaa10e7b0) placed into and run the following command. ```bash # wget https://gist.githubusercontent.com/riemers/041c6a386a2eab95c55ba3ccaa10e7b0/raw/86727d4e72e9757da4f68f1c9d784720e72d0e99/usb_backup.sh @@ -82,7 +83,7 @@ Make the downloaded script executable. # chmod +x usb_backup.sh ``` -Open up the file and change the paths you want to use, then simply run the `./usb_backup.sh`. +Edit the script file using your preferred text editor (use nano if you are not advanced). Change the paths to reflect your configuration, then simply run `./usb_backup.sh`. ```bash $ .homeassistant/extraconfig/shell_code/usb_backup.sh @@ -91,26 +92,27 @@ $ .homeassistant/extraconfig/shell_code/usb_backup.sh [i] Keeping all files no prunning set ``` -### {% linkable_title Crontab %} -In order for this to automatically make a backup every night at 3 am, you can add a crontab for it as the `homeassistant` user. -Change below path to where you placed the `usb_backup.sh` and run the following line. +### {% linkable_title Set Up Crontab %} + +To automatically backup your configuration on a schedule, you can add a crontab for it as the `homeassistant` user. +Change the path below to the directory where you placed the `usb_backup.sh` and run the following line. This will backup every night at 3 am. ```bash (crontab -l 2>/dev/null; echo "0 3 * * * /home/homeassistant/.homeassistant/extraconfig/shell_code/usb_backup.sh") | crontab - ``` -### {% linkable_title Auto mount %} +### {% linkable_title Auto Mount the USB Device %} -This does not automatically mount your USB drive at boot. You need to do that manually or add a line to your `/etc/fstab` file. +NOTE: This does not automatically mount your USB drive at boot. You will need to manually mount your drive after each boot or add a line to your `/etc/fstab` file. -If your drive is on `/dev/sda1`, you could add an entry to your `/etc/fstab` like so: - -```text -/dev/sda1 /media ext4 defaults,noatime 0 1 -``` - -Manual step to mount the USB drive: +To manually mount a USB drive located at `/dev/sda1`, run the following line: ```bash # mount /dev/sda1 /media ``` + +Alternatively, auto-mount the drive by adding the following entry to your `/etc/fstab`: + +```text +/dev/sda1 /media ext4 defaults,noatime 0 1 +``` diff --git a/source/_docs/ecosystem/certificates/lets_encrypt.markdown b/source/_docs/ecosystem/certificates/lets_encrypt.markdown index 7385496ae3..1239eb550a 100644 --- a/source/_docs/ecosystem/certificates/lets_encrypt.markdown +++ b/source/_docs/ecosystem/certificates/lets_encrypt.markdown @@ -10,11 +10,11 @@ footer: true ---

-If you are using Hass.io, do not use this guide. Instead, use the [DuckDNS add-on](/addons/duckdns/) to automatically maintain a subdomain including HTTPS certificates via Let's Encrypt. +If you are using Hass.io or Hassbian, do not use this guide. Instead, use the [DuckDNS add-on](/addons/duckdns/) for Hass.io or the [DuckDNS suite](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/duckdns.md) for Hassbian to automatically maintain a subdomain including HTTPS certificates via Let's Encrypt.

-

-Before exposing your Home Assistant instance to the outside world it is ESSENTIAL that you have set a password following the advice on the [http](https://home-assistant.io/docs/configuration/basic/) page. +

+Before exposing your Home Assistant instance to the outside world it is ESSENTIAL that you have set a password following the advice on the [http](/docs/configuration/basic/) page.

@@ -22,16 +22,16 @@ This guide was added by mf_social on 16/03/2017 and was valid at the time of wri * You can access your Home Assistant instance across your local network, and access the device that it is on via SSH from your local network. * You know the internal IP address of your router and can access your router's configuration pages. - * You have already set up a password for your Home Assistant instance, following the advice on this page: [http](https://home-assistant.io/docs/configuration/basic/) + * You have already set up a password for your Home Assistant instance, following the advice on this page: [http](/docs/configuration/basic/) * You want to access your Home Assistant instance when you are away from home (ie, not connected to your local network) and secure it with a TLS/SSL certificate. * You have a basic understanding of the phrases I have used so far. * You are not currently running anything on port 80 on your network (you'd know if you were). * If you are not using Home Assistant on a Debian/Raspian/Hassbian system you will be able to convert any of the terminology I use in to the correct syntax for your system. * You understand that this is a 'guide' covering the general application of these things to the general masses and there are things outside of the scope of it, and it does not cover every eventuality (although I have made some notes where people may stumble). Also, I have used some turns of phrase to make it easier to understand for the novice reader which people of advanced knowledge may say is innacurate. My goal here is to get you through this guide with a satisfactory outcome and have a decent understanding of what you are doing and why, not to teach you advanced internet communication protocols. * Each step presumes you have fully completed the previous step successfully, so if you did an earlier step following a different guide, please ensure that you have not missed anything out that may affect the step you have jumped to, and ensure that you adapt any commands to take in to account different file placements from other guides. - + Steps we will take: - + - 0 - Gain a basic level of understanding around IP addresses, port numbers and port forwarding - 1 - Set your device to have a static IP address - 2 - Set up port forwarding without TLS/SSL and test connection @@ -42,48 +42,48 @@ Steps we will take: - 7 - Set up a sensor to monitor the expiry date of the certificate - 8 - Set up an automatic renewal of the TLS/SSL certificate - 9 - Set up an alert to warn us if something went wrong - + ### {% linkable_title 0 - Gain a basic level of understanding around IP addresses, port numbers and port forwarding %} - + An IP address is a bit like a phone number. When you access your Home Assistant instance you type something similar to 192.168.0.200:8123 in to your address bar of your browser. The bit before the colon is the IP address (in this case 192.168.0.200) and the bit after is the port number (in this case 8123). When you SSH in to the device running Home Assistant you will use the same IP address, and you will use port 22. You may not be aware that you are using port 22, but if you are using Putty look in the box next to where you type the IP address, you will see that it has already selected port 22 for you. - + So, if an IP address is like a phone number, a port number is like an extension number. An analogy would be if you phone your local doctors on 192-1680-200 and the receptionist answers, you ask to speak to Dr. Smith and she will put you through to extension 8123, which is the phone Dr. Smith is sitting at. The doctors surgery is the device your Home Assistant is running on, Dr. Smith is your Home Assistant. Thusly, your Home Assistant instance is 'waiting for your call' on port 8123, at the device IP 192.168.0.200 . - + Now, to speak to the outside world your connection goes through a router. Your router will have two IP addresses. One is the internal network number, most likely 192.168.0.1 in my example, and an external IP address that incoming traffic is sent to. In the example of calling the doctors, the external IP is your telephone number's area code. - + So, when we want to connect to our Home Assistant instance from outside our network we will need to call the correct extension number, at the correct phone number, in the correct area code. - + We will be looking for a system to run like this (in this example I will pretend our external IP is 12.12.12.12): - + ```text Outside world -> 12.12.12.12:8123 -> your router -> 192.168.0.200:8123 ``` Sounds simple? It really is except for two small, but easy to overcome, complications: - + * IP addresses are often dynamically allocated, so they can change. * Because of the way the internet works you cannot chain IP addresses together to get from where you are, to where you want to go. - + To get around the issue of changing IP addresses we must remember that there are two IP addresses affected. Your external one (which we will 'call' to get on to your network from the internet) and your internal one (192.168.0.200 in the example I am currently using). - + So, we can use a static IP to ensure that whenever our device running Home Assistant connects to our router it always uses the same address. This way our internal IP never changes. This is covered in step 1 below. - + We then have no control over our external IP, as our Service Provider will give us a new one at random intervals. To fix this we will use a service called DuckDNS which will give us a name for our connection (something like examplehome.duckdns.org) and behind the scenes will continue to update your external IP. So no matter how many times the IP address changes, typing examplehome.duckdns.org in to our browser will convert to the correct, up-to-date, IP address. This is covered in step 3 below. - + To get around the issue of not being able to chain the IP addresses together (I can't say I want to call 12:12:12:12 and be put through to 192.168.0.200, and then be put through to extension 8123) we use port forwarding. Port forwarding is the process of telling your router which device to allow the outside connection to speak to. In the doctors surgery example, port forwarding is the receptionist. This takes a call from outside, and forwards it to the correct extension number inside. It is important to note that port forwarding can forward an incoming request for one port to a different port on your internal network if you so choose, and we will be doing this later on. The end result being that when we have our TSL/SSL certificate our incoming call will be requesting port 443 (because that is the SSL port, like the SSH port is always 22), but our port forwarding rule will forward this to our HA instance on port 8123. When this guide is completed we will run something like this: - + ```text Outside world -> https://examplehome.duckdns.org -> 12.12.12.12:443 -> your router -> 192.168.0.200:8123 ``` So, let's make it happen... ### {% linkable_title 1 - Set your device to have a static IP address %} - + Whenever a device is connected to a network it has an IP address. This IP address is often dynamically assigned to the device on connection. This means there are occasions where the IP address you use to access Home Assistant, or SSH in to the device running Home Assistant, may change. Setting a static IP address means that the device will always be on the same address. - + SSH in to your system running Home Assistant and login. - + Type the following command to list your network interfaces: - + ```bash $ ifconfig ``` @@ -94,17 +94,17 @@ You will receive an output similar to the image below: Screenshot

- + Make a note of the interface name and the IP address you are currently on. In the picture it is the wireless connection that is highlighted, but with your setup it may be the wired one (eth0 or similar), make sure you get the correct information. - + Then type the following command to open the text file that controls your network connection: -```bash +```bash $ sudo nano /etc/dhcpcd.conf ``` At the bottom of the file add the following lines: - + ```text interface wlan0 <----- or the interface you just wrote down. @@ -195,13 +195,17 @@ In the domains section pick a name for your subdomain, this can be anything you The URL you will be using later to access your Home Assistant instance from outside will be the subdomain you picked, followed by duckdns.org . For our example we will say our URL is examplehome.duckdns.org -On the top left of duckdns.org select the install option. Then pick your operating system from the list. In our example we will use a Raspberry Pi. In the dropdown box select the URL you just created. +Set up Home Assistant to keep your DuckDNS URL and external IP address in sync. In your `configuration.yaml` file add the following: -Duckdns.org will now generate personalised instructions for you to follow so that your device can update their website every time your IP address changes. Carefully follow the instructions given on duckdns.org to set up your device. +```yaml +duckdns: + domain: examplehome + access_token: abcdefgh-1234-abcd-1234-abcdefgh +``` -At the end of the instructions DuckDNS will suggest you set up port forwarding. No need, we have already done this in step 2. +The access token is available on your DuckDNS page. Restart Home Assistant after the change. -What you have now done is set up DuckDNS so that whenever you type examplehome.duckdns.org in to your browser it will convert that to your router's external IP address. Your external IP address will always be up to date because your device running Home Assistant will update DuckDNS every time it changes. +What you have now done is set up DuckDNS so that whenever you type examplehome.duckdns.org in to your browser it will convert that to your router's external IP address. Your external IP address will always be up to date because Homeassistant will update DuckDNS every time it changes. Now type your new URL in to your address bar on your browser with port 8123 on the end: @@ -251,7 +255,7 @@ $ sudo adduser hass sudo If you did not already log in as the user that currently runs Home Assistant, change to that user (usually `hass` or `homeassistant` - you may have used a command similar to this in the past): ```bash -$ sudo su -s /bin/bash hass +$ sudo su -s /bin/bash hass ``` Make sure you are in the home directory for the Home Assistant user: @@ -272,7 +276,7 @@ $ chmod a+x certbot-auto You might need to stop Home Assistant before continuing with the next step. You can do this via the Web-UI or use the following command if you are running on Hassbian: ```text -$ sudo systemctl stop home-assistant@homeassistant.service +$ sudo systemctl stop home-assistant@homeassistant.service ``` You can restart Home Assistant after the next step using the same command and replacing `stop` with `start`. @@ -336,8 +340,8 @@ http: ssl_key: /etc/letsencrypt/live/examplehome.duckdns.org/privkey.pem base_url: examplehome.duckdns.org ``` - -You may wish to set up other options for the [http](https://home-assistant.io/components/http/) component at this point, these extra options are beyond the scope of this guide. + +You may wish to set up other options for the [http](/components/http/) component at this point, these extra options are beyond the scope of this guide. Save the changes to configuration.yaml. Restart Home Assistant. @@ -363,11 +367,7 @@ https://YOUR-HA-IP:8123 Some cases such as this are where your router does not allow 'loopback' or where there is a problem with incoming connections due to technical failure. In these cases you can still use your internal connection and safely ignore the warnings. -If you were previously using a webapp on your phone/tablet to access your Home Assistant you should delete the old one and create a new one with the new address. The old one will no longer work as it is not keyed to your new, secure URL. Instructions for creating your new webapp can be found here: - -```text -https://home-assistant.io/docs/frontend/mobile/ -``` +If you were previously using a webapp on your phone/tablet to access your Home Assistant you should delete the old one and create a new one with the new address. The old one will no longer work as it is not keyed to your new, secure URL. Instructions for creating your new webapp can be found [here](/docs/frontend/mobile/). All done? Accessing your Home Assistant from across the world with your DuckDNS URL and a lovely secure logo on your browser? Ace! Now let's clean up our port forwards so that we are only exposing the parts of our network that are absolutely necessary to the outside world. @@ -387,11 +387,11 @@ You are now part of one of two groups: * If you have BOTH rules you are able to set up auto renewals of your certificates using port 80 and the standard http challenge, as performed above. * If you only have one, you are still able to set up auto renewals of your certificates, but will have to specify additional options when renewing that will temporarily stop Home Assistant and use port 8123 for certificate renewal. - + Please remember whether you are a ONE-RULE person or a BOTH-RULE person for step 8! - + Let's Encrypt certificates only last for 90 days. When they have less than 30 days left they can be renewed. Renewal is a simple process. - + Move on to step 7 to see how to monitor your certificates expiry date, and be ready to renew your certificate when the time comes. ### {% linkable_title 7 - Set up a sensor to monitor the expiry date of the certificate %} @@ -402,9 +402,9 @@ Setting a sensor to read the number of days left on your TLS/SSL certificate bef * You can set automations based on the number of days left * You can set alerts to notify you if your certificate has not been renewed and is coming close to expiry. * If you cannot set up automatic renewals due to your ISP blocking port 80, you will have timely reminders to complete the process manually. - + If you do not wish to set up a sensor you can skip straight to step 8 to learn how to update your certificates. - + The sensor will rely on a command line program that needs to be installed on your device running Home Assistant. SSH in to the device and run the following commands: ```bash @@ -442,33 +442,33 @@ If you are a ONE-RULE person (from step 6), you can automatically renew your cer If you are a TWO-RULE person (from step 6), you can automatically renew your certificate using a `http-01` challenge and port 80. There are a number of options for automating the renewal process: - + #### Option 1: Your certificate can be renewed as a 'cron job' - cron jobs are background tasks run by the computer at specified intervals (and are totally independent of Home Assistant). Defining cron is outside of the scope of this guide but you will have had dealings with `crontab` when setting up DuckDNS in step 3 - + To set a cron job to run the script at regular intervals: - + * SSH in to your device running Home Assistant. * Change to your Home Assistant user (command similar to): - + ```bash $ sudo su -s /bin/bash hass ``` - + * Open the crontab: - + ```bash $ crontab -e ``` - + * If you are a TWO-RULE Person: Scroll to the bottom of the file and paste in the following line - + ```text 30 2 * * 1 ~/certbot/certbot-auto renew --quiet --no-self-upgrade --standalone --preferred-challenges http-01 ``` * If you are a ONE-RULE Person: Scroll to the bottom of the file and paste in the following line - + ```text 30 2 * * 1 ~/certbot/certbot-auto renew --quiet --no-self-upgrade --standalone --preferred-challenges tls-sni-01 --tls-sni-01-port 8123 --pre-hook "sudo systemctl stop home-assistant@homeassistant.service" --post-hook "sudo systemctl start home-assistant@homeassistant.service" ``` @@ -478,17 +478,17 @@ $ crontab -e 3. We define pre-hooks and post-hooks that stop our Home Assistant service before certbot runs, freeing port 8123 for certificate renewal, and restart Home Assistant after renewal is complete. * Save the file and exit - - + + #### Option 2: You can set an automation in Home Assistant to run the certbot renewal script. - + Add the following sections to your configuration.yaml if you are a TWO-RULE person -```yaml -shell_command: +```yaml +shell_command: renew_ssl: ~/certbot/certbot-auto renew --quiet --no-self-upgrade --standalone --preferred-challenges http-01 - + automation: - alias: 'Auto Renew SSL Cert' trigger: @@ -502,34 +502,34 @@ If you are a ONE-RULE person, replace the `certbot-auto` command above with `~/c #### Option 3: You can manually update the certificate when your certificate is less than 30 days to expiry. - -To manually update: - + +To manually update: + * SSH in to your device running Home Assistant. * Change to your Home Assistant user (command similar to): - + ```bash $ su - s /bin/bash hass ``` - + * Change to your certbot folder - + ```bash $ cd ~/certbot/ ``` * Run the renewal command - + ```bash $ ./certbot-auto renew --quiet --no-self-upgrade --standalone --preferred-challenges http-01 ``` * If you are a ONE-RULE person, replace the `certbot-auto` command above with `~/certbot/certbot-auto renew --quiet --no-self-upgrade --standalone --preferred-challenges tls-sni-01 --tls-sni-01-port 8123 --pre-hook "sudo systemctl stop home-assistant@homeassistant.service" --post-hook "sudo systemctl start home-assistant@homeassistant.service"` - + So, now were all set up. We have our secured, remotely accessible Home Assistant instance and we're on track for keeping our certificates up to date. But what if something goes wrong? What if the automation didn't fire? What if the cron job forgot to run? What if the dog ate my homework? Read on to set up an alert so you can be notified in plenty of time if you need to step in and sort out any failures. - + ### {% linkable_title 9 - Set up an alert to warn us if something went wrong. %} - + We set up our automatic renewal of our certificates and whatever method we used the certificate should be renewed on or around 30 days before it expires. But what if a week later it still hasn't been? This alert will go off if the expiry time on the certificate gets down to 21 days. This will give you 3 weeks to fix the problem, get your new certificate installed and get another 90 days of secure Home Assistant connections in play. In your `configuration.yaml` add the following automation, adding your preferred notification platform where appropriate: @@ -546,7 +546,7 @@ automation: data: message: 'Warning - SSL certificate expires in 21 days and has not been automatically renewed' ``` - + If you receive this warning notification, follow the steps for a manual update from step 8. Any error messages received at that point can be googled and resolved. If the manual update goes without a hitch there may be something wrong with your chosen method for automatic updates, and you can start troubleshooting from there. So, that's it. We've taken a Home Assistant instance that was only reachable on the local network, made it accessible from the internet, secured it, and set up a system to ensure that it always stays secure. Well done, go and treat yourself to a cookie! diff --git a/source/_docs/ecosystem/certificates/tls_self_signed_certificate.markdown b/source/_docs/ecosystem/certificates/tls_self_signed_certificate.markdown index d7c145fe8b..2aab9deb6d 100644 --- a/source/_docs/ecosystem/certificates/tls_self_signed_certificate.markdown +++ b/source/_docs/ecosystem/certificates/tls_self_signed_certificate.markdown @@ -11,7 +11,7 @@ redirect_from: /cookbook/tls_self_signed_certificate/ --- If your Home Assistant instance is only accessible from your local network you can still protect the communication between your browsers and the frontend with SSL/TLS. -[Let's encrypt]({{site_root}}/blog/2015/12/13/setup-encryption-using-lets-encrypt/) will only work if you have a DNS entry and remote access is allowed. +[Let's encrypt]({{site_root}}/blog/2017/09/27/effortless-encryption-with-lets-encrypt-and-duckdns/) will only work if you have a DNS entry and remote access is allowed. The solution is to use a self-signed certificate. As you most likely don't have a certification authority (CA) your browser will complain about the security. If you have a CA then this will not be an issue. To create a certificate locally, you need the [OpenSSL](https://www.openssl.org/) command-line tool. diff --git a/source/_docs/ecosystem/hadashboard.markdown b/source/_docs/ecosystem/hadashboard.markdown index 226b6906d9..87c06d166d 100755 --- a/source/_docs/ecosystem/hadashboard.markdown +++ b/source/_docs/ecosystem/hadashboard.markdown @@ -10,7 +10,7 @@ footer: true redirect_from: /ecosystem/hadashboard/ --- -HADashboard is a modular, skinnable dashboard for [Home Assistant](https://home-assistant.io/) that is intended to be wall mounted, and is optimized for distance viewing. +HADashboard is a modular, skinnable dashboard for [Home Assistant](/) that is intended to be wall mounted, and is optimized for distance viewing.

diff --git a/source/_docs/ecosystem/hass-configurator.markdown b/source/_docs/ecosystem/hass-configurator.markdown index 1d07bf163d..3087d6b6b2 100644 --- a/source/_docs/ecosystem/hass-configurator.markdown +++ b/source/_docs/ecosystem/hass-configurator.markdown @@ -12,7 +12,7 @@ redirect_from: /ecosystem/hass-configurator/ ### {% linkable_title Configuration UI for Home Assistant %} -Since there currently is no nice way to edit the yaml-files Home Assistant is using through the frontend, here is a small webapp that hopefully makes the configuration easier. It is a customized and embedded [Ace editor](https://ace.c9.io/), which has syntax highlighting for yaml, the format used for Home Assistants configuration files. There is an integrated file browser to select whatever file you want to edit. When you're done with editing the file, click the save-button and it will replace the original. +Since there currently is no nice way to edit the yaml-files Home Assistant is using through the frontend, here is a small webapp that hopefully makes the configuration easier. It is a customized and embedded [Ace editor](https://ace.c9.io/), which has syntax highlighting for yaml, the format used for Home Assistants configuration files. There is an integrated file browser to select whatever file you want to edit. When you're done with editing the file, click the save-button and it will replace the original. Essentially this is a browser-based alternative to modifying your configuration through SSH, Windows + SMB, Github etc..

@@ -38,7 +38,7 @@ This tool allows you to browse your filesystem and modify files. So be careful w Consider running the configurator as a user with limited privileges to limit possible damage.

### {% linkable_title Installation (Linux, OS X) %} -There are no dependencies on Python modules that are not part of the standard library. And all the fancy JavaScript libraries are loaded from CDN (which means this doesn't work when you're offline). +There are no dependencies on Python modules that are not part of the standard library. And all the fancy JavaScript libraries are loaded from CDN (which means this doesn't work when you're offline). - Copy [configurator.py](https://github.com/danielperna84/hass-configurator/blob/master/configurator.py) to your Home Assistant configuration directory (e.g `/home/homeassistant/.homeassistant`): `wget https://raw.githubusercontent.com/danielperna84/hass-configurator/master/configurator.py` - Make it executable: `sudo chmod 755 configurator.py` - (Optional) Set the `GIT` variable in configurator.py to `True` if [GitPython](https://gitpython.readthedocs.io/) is installed on your system. This is required if you want to make use of the Git integration. @@ -46,8 +46,8 @@ There are no dependencies on Python modules that are not part of the standard li - To terminate the process do the usual `CTRL+C`, maybe once or twice ### {% linkable_title Configuration %} -Near the top of the `configurator.py`-file you will find some global variables you can change to customize the configurator. If you are unfamiliar with Python: when setting variables of the type _string_, you have to write that within quotation marks. The default settings are fine for just checking out the configurator quickly. With more customized setups you should change some settings though. -To keep your settings across updates it is also possible to save settings in an external file. In that case copy [settings.conf](https://github.com/danielperna84/hass-configurator/blob/master/settings.conf) wherever you like and append the full path to the file to the command when starting the configurator. E.g. `sudo .configurator.py /home/homeassistant/.homeassistant/mysettings.conf`. This file is in JSON format. So make sure it has a valid syntax (you can set the editor to JSON to get syntax highlighting for the settings). The major difference to the settings in the py-file is, that `None` becomes `null`. +Near the top of the `configurator.py`-file you will find some global variables you can change to customize the configurator. If you are unfamiliar with Python: when setting variables of the type _string_, you have to write that within quotation marks. The default settings are fine for just checking out the configurator quickly. With more customized setups you should change some settings though. +To keep your settings across updates it is also possible to save settings in an external file. In that case copy [settings.conf](https://github.com/danielperna84/hass-configurator/blob/master/settings.conf) wherever you like and append the full path to the file to the command when starting the configurator. e.g., `sudo .configurator.py /home/homeassistant/.homeassistant/mysettings.conf`. This file is in JSON format. So make sure it has a valid syntax (you can set the editor to JSON to get syntax highlighting for the settings). The major difference to the settings in the py-file is, that `None` becomes `null`. #### LISTENIP (string) The IP the service is listening on. By default it is binding to `0.0.0.0`, which is every interface on the system. @@ -66,22 +66,22 @@ Set credentials in the form of `"username:password"` if authentication should be #### ALLOWED_NETWORKS (list) Limit access to the configurator by adding allowed IP addresses / networks to the list, e.g `ALLOWED_NETWORKS = ["192.168.0.0/24", "172.16.47.23"]` #### BANNED_IPS (list) -List of statically banned IP addresses, e.g. `BANNED_IPS = ["1.1.1.1", "2.2.2.2"]` +List of statically banned IP addresses, e.g., `BANNED_IPS = ["1.1.1.1", "2.2.2.2"]` #### BANLIMIT (integer) Ban IPs after `n` failed login attempts. Restart the service to reset banning. The default of `0` disables this feature. `CREDENTIALS` has to be set for this to work. #### IGNORE_PATTERN (list) -Files and folders to ignore in the UI, e.g. `IGNORE_PATTERN = [".*", "*.log", "__pycache__"]`. +Files and folders to ignore in the UI, e.g., `IGNORE_PATTERN = [".*", "*.log", "__pycache__"]`. #### DIRSFIRST (bool) If set to `True`, directories will be displayed at the top of the filebrowser. #### GIT (bool) Set this variable to `True` to enable Git integration. This feature requires [GitPython](https://gitpython.readthedocs.io) to be installed on the system that is running the configurator. For technical reasons this feature can not be enabled with the static settings file. - -__Note regarding `ALLOWED_NETWORKS`, `BANNED_IPS` and `BANLIMIT`__: + +__Note regarding `ALLOWED_NETWORKS`, `BANNED_IPS` and `BANLIMIT`__: The way this is implemented works in the following order: 1. (Only if `CREDENTIALS` is set) Check credentials - - Failure: Retry `BANLIMIT` times, after that return error 420 (unless you try again without any authentication headers set, e.g. private tab of your browser) + - Failure: Retry `BANLIMIT` times, after that return error 420 (unless you try again without any authentication headers set, e.g., private tab of your browser) - Success: Continue 2. Check if client IP address is in `BANNED_IPS` - Yes: Return error 420 @@ -91,7 +91,7 @@ The way this is implemented works in the following order: - Yes: Continue and display UI of configurator ### {% linkable_title Embedding into Home Assistant %} -Home Assistant has the [panel_iframe](https://home-assistant.io/components/panel_iframe/) component. With this it is possible to embed the configurator directly into Home Assistant, allowing you to modify your configuration through the Home Assistant frontend. +Home Assistant has the [panel_iframe](/components/panel_iframe/) component. With this it is possible to embed the configurator directly into Home Assistant, allowing you to modify your configuration through the Home Assistant frontend. An example configuration would look like this: ```yaml @@ -107,11 +107,11 @@ Be careful when setting up port forwarding to the configurator while embedding i ### {% linkable_title Daemonizing / Keeping the configurator running %} Since the configurator script on its own is no service, you will have to take some extra steps to keep it running. Here are five options (for Linux), but there are more, depending on your usecase. -1. Fork the process into the background with the command: +1. Fork the process into the background with the command: `nohup sudo ./configurator.py &` -2. If your system is using systemd (that's usually what you'll find on a Raspberry Pi), there's a [template file](https://github.com/danielperna84/hass-configurator/blob/master/hass-configurator.systemd) you can use and then apply the same process to integrate it as mentioned in the [Home Assistant documentation](https://home-assistant.io/docs/autostart/systemd/). If you use this method you have to set the `BASEPATH` variable according to your environment. +2. If your system is using systemd (that's usually what you'll find on a Raspberry Pi), there's a [template file](https://github.com/danielperna84/hass-configurator/blob/master/hass-configurator.systemd) you can use and then apply the same process to integrate it as mentioned in the [Home Assistant documentation](/docs/autostart/systemd/). If you use this method you have to set the `BASEPATH` variable according to your environment. 3. If you have [supervisor](http://supervisord.org/) running on your system, [hass-poc-configurator.supervisor](https://github.com/danielperna84/hass-configurator/blob/master/hass-configurator.supervisor) would be an example configuration you could use to control the configurator. -4. A tool called [tmux](https://tmux.github.io/), which should be pre-installed with [HASSbian](https://home-assistant.io/docs/hassbian/). +4. A tool called [tmux](https://tmux.github.io/), which should be pre-installed with [HASSbian](/docs/hassbian/). 5. A tool called [screen](http://ss64.com/bash/screen.html) (alternative to tmux). If it's not already installed on your system, you can do `sudo apt-get install screen` or `sudo yum install screen` to get it. When it's installed, start a screen session by executing `screen`. Then navigate to your Home Assistant directory and start the configurator like described above. Put the screen session into the background by pressing `CTRL+A` and then `CTRL+D`. It is now safe to disconnect from your SSH session. To resume the screen session, log in to your machine and execute `screen -r`. diff --git a/source/_docs/ecosystem/ios.markdown b/source/_docs/ecosystem/ios.markdown index 82ba667eec..027fe50323 100644 --- a/source/_docs/ecosystem/ios.markdown +++ b/source/_docs/ecosystem/ios.markdown @@ -8,7 +8,6 @@ comments: false sharing: true footer: true redirect_from: /ecosystem/ios/ -redirect_from: /components/ios/ --- The Home Assistant for iOS app offers a companion app for iOS which is deeply integrated into both Home Assistant and iOS. Its basic features include: @@ -22,7 +21,7 @@ The app is available on the iOS App Store in every country that Apple supports.

-## Basic requirements +## {% linkable_title Basic requirements %} * iOS device running at least iOS 9, but iOS 10 is greatly preferred. * Home Assistant 0.42.4 or higher for push notification support. @@ -34,7 +33,7 @@ Loading the `ios` component will also load the [`device_tracker`][device-tracker ## {% linkable_title Setup %} -### Automated Setup +### {% linkable_title Automated Setup %} The `ios` component will automatically be loaded under the following circumstances: @@ -45,7 +44,7 @@ Automated discovery and component loading only happens at first install of the a After the first automated setup you need to add `ios:` to your configuration so that the component loads by default even after restarting Home Assistant. -### Manual Setup +### {% linkable_title Manual Setup %} You may also manually load the `ios` component by adding the following to your configuration: diff --git a/source/_docs/ecosystem/ios/integration.markdown b/source/_docs/ecosystem/ios/integration.markdown index 3bd3791ebb..b6c27dd437 100644 --- a/source/_docs/ecosystem/ios/integration.markdown +++ b/source/_docs/ecosystem/ios/integration.markdown @@ -18,7 +18,7 @@ Query parameters are passed as a dictionary in the call. Example: `homeassistant://call_service/device_tracker.see?entity_id=device_tracker.entity` ## Fire event -You can create an [event trigger](https://home-assistant.io/docs/automation/trigger/#event-trigger) and fire the event. +You can create an [event trigger](/docs/automation/trigger/#event-trigger) and fire the event. Example: `homeassistant://fire_event/custom_event?entity_id=MY_CUSTOM_EVENT` diff --git a/source/_docs/ecosystem/ios/notifications.markdown b/source/_docs/ecosystem/ios/notifications.markdown index a4a025907c..c1eee576e3 100644 --- a/source/_docs/ecosystem/ios/notifications.markdown +++ b/source/_docs/ecosystem/ios/notifications.markdown @@ -12,7 +12,7 @@ redirect_from: /ecosystem/ios/notifications/ The `ios` notify platform enables sending push notifications to the Home Assistant iOS app. -The 'ios' component will automatically load the notify service. +The 'ios' component will automatically load the notify service. The service component can be called using `service: notify.ios_`. Your device ID can be found in the `ios.conf` file in your configuration folder. The file is compressed JSON. You can view it easier by copying the file contents and pasting them into [JSONLint](http://jsonlint.com). @@ -21,4 +21,4 @@ In this example, the device ID is `robbiet480_7plus`, so the notify service to u {"devices":{"robbiet480_7plus":{"app":{"bundleIdentifer":"io.robbie.HomeAssistant","versionNumber":1,"buildNumber":53},"pushSounds":[],"permissions":["location"],"deviceId":"robbiet480_7plus","device":{"type":"iPhone 7 Plus","systemName":"iOS","systemVersion":"10.3","permanentID":"AB9F02FE-6AC6-47B8-ADEB-5DD87B489156","localizedModel":"iPhone","name":"Robbie's iPhone 7 Plus","model":"iPhone"},"battery":{"state":"Full","level":100},"pushToken":"SECRET","pushId":"SECRET"}}} ``` -You can find more information in the [Basic Notifications](https://home-assistant.io/docs/ecosystem/ios/notifications/basic/) documentation and the [Actionable Notifications](https://home-assistant.io/docs/ecosystem/ios/notifications/actions/) documentation. +You can find more information in the [Basic Notifications](/docs/ecosystem/ios/notifications/basic/) documentation and the [Actionable Notifications](/docs/ecosystem/ios/notifications/actions/) documentation. diff --git a/source/_docs/ecosystem/ios/notifications/basic.markdown b/source/_docs/ecosystem/ios/notifications/basic.markdown index 5f8d723745..7e0a5e9288 100644 --- a/source/_docs/ecosystem/ios/notifications/basic.markdown +++ b/source/_docs/ecosystem/ios/notifications/basic.markdown @@ -36,6 +36,7 @@ automation: action: service: notify.ios_ data: + title: "Smart Home Alerts" message: "Something happened at home!" data: push: @@ -53,13 +54,14 @@ automation action: service: notify.ios_ data: + title: "Smart Home Alerts" message: "Something happened at home!" data: subtitle: "Subtitle goes here" ``` ### {% linkable_title Sending notifications to multiple phones %} -To send notifications to multiple phones, create a [notification group](https://home-assistant.io/components/notify.group/): +To send notifications to multiple phones, create a [notification group](/components/notify.group/): ```yaml notify: - name: NOTIFIER_NAME diff --git a/source/_docs/ecosystem/scenegen.markdown b/source/_docs/ecosystem/scenegen.markdown index 3cf1e1b03c..37d2534b08 100644 --- a/source/_docs/ecosystem/scenegen.markdown +++ b/source/_docs/ecosystem/scenegen.markdown @@ -10,7 +10,7 @@ footer: true redirect_from: /ecosystem/scenegen/ --- -Scenegen is a scene generation tool for [Home Assistant](https://home-assistant.io/) home automation software. It creates scenes by example, by reading the current states of devices and outputting a corresponding scene. Scenegen is written in python using Home Assistant's RESTFul API so can be run from anywhere. It currently supports lights and switches only. +Scenegen is a scene generation tool for [Home Assistant](/) home automation software. It creates scenes by example, by reading the current states of devices and outputting a corresponding scene. Scenegen is written in python using Home Assistant's RESTFul API so can be run from anywhere. It currently supports lights and switches only. ## {% linkable_title Installation %} diff --git a/source/_docs/ecosystem/synology.markdown b/source/_docs/ecosystem/synology.markdown index 099ea41ef0..c5c436da58 100644 --- a/source/_docs/ecosystem/synology.markdown +++ b/source/_docs/ecosystem/synology.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Synology" -description: "Instructions how to get Home Assistant up and running on Synology" +description: "Instructions on how to get Home Assistant up and running on Synology" release_date: 2016-12-07 15:00:00 -0500 sidebar: true comments: false diff --git a/source/_docs/frontend/browsers.markdown b/source/_docs/frontend/browsers.markdown index 611b8586ae..2454f5989a 100644 --- a/source/_docs/frontend/browsers.markdown +++ b/source/_docs/frontend/browsers.markdown @@ -37,7 +37,7 @@ We would appreciate if you help to keep this page up-to-date and add feedback. | Browser | Release | State | Comments | | :-------------------- |:---------------|:-----------|:-------------------------| -| [Firefox] | 57.0 | works | | +| [Firefox] | 59.0 | works | | | [Midori] | 0.5.11 | works | | | [Chromium] | 63.0.3239.108 | works | | | [Conkeror] | 1.0.2 | works | | diff --git a/source/_docs/frontend/mobile.markdown b/source/_docs/frontend/mobile.markdown index 3a2c1af740..d7342115b7 100644 --- a/source/_docs/frontend/mobile.markdown +++ b/source/_docs/frontend/mobile.markdown @@ -10,7 +10,7 @@ footer: true redirect_from: /getting-started/mobile/ --- -Home Assistant has [a companion app for iOS](https://home-assistant.io/docs/ecosystem/ios/). +Home Assistant has [a companion app for iOS](/docs/ecosystem/ios/). On both Android and iOS, you can add the Home Assistant "web app" to your homescreen as if it was native (Home Assistant leverages the W3C [manifest.json](https://w3c.github.io/manifest/) support). diff --git a/source/_docs/installation.markdown b/source/_docs/installation.markdown index bb51e93863..16380e6837 100644 --- a/source/_docs/installation.markdown +++ b/source/_docs/installation.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Installation of Home Assistant" -description: "Instructions how to install Home Assistant to launch on start." +description: "Instructions on how to install Home Assistant to launch on start." date: 2017-02-15 08:00 sidebar: true comments: false diff --git a/source/_docs/installation/centos.markdown b/source/_docs/installation/centos.markdown index d1d29402a3..aadd8dbf93 100644 --- a/source/_docs/installation/centos.markdown +++ b/source/_docs/installation/centos.markdown @@ -35,13 +35,13 @@ $ python --version Python 3.6.3 ``` -You will be in a command shell set up with Python 3.6 as your default version. The virtualenv and pip commands will be correct for this version, so you can now create a virtual environment and install Home Assistant following the main [instructions](https://home-assistant.io/docs/installation/virtualenv/#step-4-set-up-the-virtualenv). +You will be in a command shell set up with Python 3.6 as your default version. The virtualenv and pip commands will be correct for this version, so you can now create a virtual environment and install Home Assistant following the main [instructions](/docs/installation/virtualenv/#step-4-set-up-the-virtualenv). You will need to enable the software collection each time you log on before you activate your virtual environment. ### {% linkable_title Systemd with Software Collections %} -To autostart Home Assistant using systemd follow the main [instructions](https://home-assistant.io/docs/autostart/systemd/) and adjust the template as follows: +To autostart Home Assistant using systemd follow the main [instructions](/docs/autostart/systemd/) and adjust the template as follows: ``` [Unit] diff --git a/source/_docs/installation/docker.markdown b/source/_docs/installation/docker.markdown index ba89ccbf46..4245f1069c 100644 --- a/source/_docs/installation/docker.markdown +++ b/source/_docs/installation/docker.markdown @@ -10,7 +10,7 @@ footer: true redirect_from: /getting-started/installation-docker/ --- -Installation with Docker is straightforward. Adjust the following command so that `/path/to/your/config/` points at the folder where you want to store your config and run it: +Installation with Docker is straightforward. Adjust the following command so that `/path/to/your/config/` points at the folder where you want to store your configuration and run it: ### {% linkable_title Linux %} @@ -18,9 +18,18 @@ Installation with Docker is straightforward. Adjust the following command so tha $ docker run -d --name="home-assistant" -v /path/to/your/config:/config -v /etc/localtime:/etc/localtime:ro --net=host homeassistant/home-assistant ``` +### {% linkable_title Raspberry Pi 3 (Raspbian) %} + +```bash +$ docker run -d --name="home-assistant" -v /path/to/your/config:/config -v /etc/localtime:/etc/localtime:ro --net=host homeassistant/raspberrypi3-homeassistant:0.XX.x +``` + +The Docker container for Raspberry Pi 3 does not have a 'latest' tag so the version number must be specified explicitly, i.e. 0.68.0. This goes for both CLI and Docker Compose. + + ### {% linkable_title macOS %} -When using `docker-ce` (or `boot2docker`) on macOS, you are unable to map the local timezone to your Docker container ([Docker issue](https://github.com/docker/for-mac/issues/44)). Instead of `-v /etc/localtime:/etc/localtime:ro`, just pass in the timezone environment variable when you launch the container, ex: `-e "TZ=America/Los_Angeles"`. Replace "America/Los_Angeles" with [your timezone](http://en.wikipedia.org/wiki/List_of_tz_database_time_zones). +When using `docker-ce` (or `boot2docker`) on macOS, you are unable to map the local timezone to your Docker container ([Docker issue](https://github.com/docker/for-mac/issues/44)). Instead of `-v /etc/localtime:/etc/localtime:ro`, just pass in the timezone environment variable when you launch the container, e.g, `-e "TZ=America/Los_Angeles"`. Replace "America/Los_Angeles" with [your timezone](http://en.wikipedia.org/wiki/List_of_tz_database_time_zones). If you wish to browse directly to `http://localhost:8123` from your macOS host, meaning forward ports directly to the container, replace the `--net=host` switch with `-p 8123:8123`. More detail can be found in [the docker forums](https://forums.docker.com/t/should-docker-run-net-host-work/14215/10). @@ -28,7 +37,7 @@ If you wish to browse directly to `http://localhost:8123` from your macOS host, $ docker run -d --name="home-assistant" -v /path/to/your/config:/config -e "TZ=America/Los_Angeles" -p 8123:8123 homeassistant/home-assistant ``` -Alternatively, `docker-compose` works with any recent release of `docker-ce` on macOS. Note that (further down this page) we provide an example `docker-compose.yml` however it differs from the `docker run` example above. To make the .yml directives match, you would need to make _two_ changes: first add the equivalent `ports:` directive, then _remove_ the `network_mode: host` section. This is because `Port mapping is incompatible with network_mode: host:`. More details can be found at [Docker networking docs] (https://docs.docker.com/engine/userguide/networking/#default-networks). Note also the `/dev/tty*` device name used by your Arduino etc. devices will differ from the Linux example, so the compose `mount:` may require updates. +Alternatively, `docker-compose` works with any recent release of `docker-ce` on macOS. Note that (further down this page) we provide an example `docker-compose.yml` however it differs from the `docker run` example above. To make the .yml directives match, you would need to make _two_ changes: first add the equivalent `ports:` directive, then _remove_ the `network_mode: host` section. This is because `Port mapping is incompatible with network_mode: host:`. More details can be found at [Docker networking docs](https://docs.docker.com/engine/userguide/networking/#default-networks). Note also the `/dev/tty*` device name used by your Arduino etc. devices will differ from the Linux example, so the compose `mount:` may require updates. ### {% linkable_title Windows %} @@ -51,7 +60,7 @@ The steps would be: * Wait for some time until your NAS has pulled the image * Move to the "Image"-section of the Docker-app * Click on "Launch" -* Choose a container-name you want (e.g. "homeassistant") +* Choose a container-name you want (e.g., "homeassistant") * Click on "Advanced Settings" * Set "Enable auto-restart" if you like * Within "Volume" click on "Add Folder" and choose either an existing folder or add a new folder. The "mount point" has to be "/config", so that Home Assistant will use it for the configs and logs. @@ -80,35 +89,28 @@ If you want to use a USB Bluetooth adapter or Z-Wave USB Stick with Home Assista ### {% linkable_title QNAP NAS %} -As QNAP within QTS now supports Docker (with a neat UI), you can simply install Home Assistant using docker without the need for command-line. For details about the package (including compatability-information, if your NAS is supported), see https://www.qnap.com/solution/container_station/en/index.php +As QNAP within QTS now supports Docker (with a neat UI), you can simply install Home Assistant using docker without the need for command-line. For details about the package (including compatibility-information, if your NAS is supported), see https://www.qnap.com/solution/container_station/en/index.php The steps would be: - - Install “Container Station” package on your Qnap NAS - - Launch Container Station and move to “Create Container”-section - - Search image “homeassistant/home-assistant” with - docker hub and click on “Install” + - Install "Container Station" package on your Qnap NAS + - Launch Container Station and move to "Create Container"-section + - Search image "homeassistant/home-assistant" with Docker hub and click on "Install" - Choose "latest" version and click next - - Choose a container-name you want (e.g. - “homeassistant”) - - Click on “Advanced Settings” - - Within “Shared Folders” click on "Volume from host" > "Add" and - choose either an existing folder or add a new folder. The “mount - point” has to be “/config”, so that Home Assistant will use it for - the configs and logs. - - Within “Network” and select Network Mode to “Host” - - To ensure that Home Assistant displays the correct - timezone go to the “Environment” tab and click the plus sign then add - `variable` = `TZ` & `value` = `Europe/London` choosing [your correct timezone](http://en.wikipedia.org/wiki/List_of_tz_database_time_zones) - - Click on “Create” + - Choose a container-name you want (e.g., "homeassistant") + - Click on "Advanced Settings" + - Within "Shared Folders" click on "Volume from host" > "Add" and choose either an existing folder or add a new folder. The "mount point has to be `/config`, so that Home Assistant will use it for the configuration and logs. + - Within "Network" and select Network Mode to "Host" + - To ensure that Home Assistant displays the correct timezone go to the "Environment" tab and click the plus sign then add `variable` = `TZ` & `value` = `Europe/London` choosing [your correct timezone](http://en.wikipedia.org/wiki/List_of_tz_database_time_zones) + - Click on "Create" - Wait for some time until your NAS has created the container - Your Home Assistant within Docker should now run and will serve the web interface from port 8123 on your Docker host (this will be your Qnap NAS IP address - for example `http://192.xxx.xxx.xxx:8123`) -Remark: to update your Home Assistant on your Docker within Qnap NAS, you just remove container and image and do steps again (Don't remove "config" folder) +Remark: To update your Home Assistant on your Docker within Qnap NAS, you just remove container and image and do steps again (Don't remove "config" folder). -If you want to use a USB Bluetooth adapter or Z-Wave USB Stick with Home Assistant on Qnap Docker, Fallow this step: +If you want to use a USB Bluetooth adapter or Z-Wave USB stick with Home Assistant on Qnap Docker, follow those steps: -**Z-wave:** +#### {% linkable_title Z-Wave %} - Connect to your NAS over SSH - Load cdc-acm kernel module(when nas restart need to run this command) @@ -123,16 +125,16 @@ If you want to use a USB Bluetooth adapter or Z-Wave USB Stick with Home Assista `-v` is your config path `-e` is set timezone - - Edit configuration.yaml + - Edit `configuration.yaml` -``` +```yaml zwave: usb_path: /dev/ttyACM0 ``` That will tell Home Assistant where to look for our Z-wave radio. -**Bluetooth:** +#### {% linkable_title Bluetooth %} - Connect to your NAS over SSH - Run Docker command: @@ -141,9 +143,9 @@ That will tell Home Assistant where to look for our Z-wave radio. First `-v` is your config path `-e` is set timezone - - Edit configuration.yaml + - Edit the `configuration.yaml` file -``` +```yaml device_tracker: - platform: bluetooth_tracker ``` @@ -180,10 +182,12 @@ $ docker-compose up -d ### {% linkable_title Exposing Devices %} -In order to use z-wave, zigbee or other components that require access to devices, you need to map the appropriate device into the container. Ensure the user that is running the container has the correct privileges to access the `/dev/tty*` file, then add the device mapping to your docker command: +In order to use Z-Wave, ZigBbee or other components that require access to devices, you need to map the appropriate device into the container. Ensure the user that is running the container has the correct privileges to access the `/dev/tty*` file, then add the device mapping to your docker command: ```bash -$ docker run -d --name="home-assistant" -v /path/to/your/config:/config -v /etc/localtime:/etc/localtime:ro --device /dev/ttyUSB0:/dev/ttyUSB0 --net=host homeassistant/home-assistant +$ docker run -d --name="home-assistant" -v /path/to/your/config:/config \ + -v /etc/localtime:/etc/localtime:ro --device /dev/ttyUSB0:/dev/ttyUSB0 \ + --net=host homeassistant/home-assistant ``` or in a `docker-compose.yml` file: diff --git a/source/_docs/installation/hassbian.markdown b/source/_docs/installation/hassbian.markdown index a9177f3ab1..bc20ad6359 100644 --- a/source/_docs/installation/hassbian.markdown +++ b/source/_docs/installation/hassbian.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Hassbian" -description: "Instructions to flash the Home Assistant HASSbian image on a Raspberry Pi." +description: "Instructions to flash the Home Assistant Hassbian image on a Raspberry Pi." date: 2016-09-26 21:00 sidebar: true comments: false @@ -10,7 +10,7 @@ footer: true redirect_from: /getting-started/hassbian/ --- -Hassbian is our customized operating system for the Raspberry Pi 3. It is the easiest way of installing Home Assistant. +Hassbian is our customized operating system for the Raspberry Pi Zero, 2,3 and 3B+. It is one of the easiest ways of installing Home Assistant. - [Install Hassbian][install] - [Customize your installation][customize] diff --git a/source/_docs/installation/hassbian/common-tasks.markdown b/source/_docs/installation/hassbian/common-tasks.markdown index 6fddcd360b..edf92d8ace 100644 --- a/source/_docs/installation/hassbian/common-tasks.markdown +++ b/source/_docs/installation/hassbian/common-tasks.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Common tasks on Hassbian" -description: "Instructions how to do common tasks on Hassbian." +description: "Instructions on how to do common tasks on Hassbian." date: 2016-09-26 21:00 sidebar: true comments: false @@ -11,7 +11,7 @@ redirect_from: /docs/hassbian/common-tasks/ --- ### {% linkable_title Login to the Raspberry Pi %} -To login to your Raspberry Pi running HASSbian you're going to be using a ssh client. Depending on your platform there are several alternatives for doing this. Linux and Max OS generally have a ssh client installed. Windows users are recommended to download and install the ssh client [Putty][ssh-putty]. +To login to your Raspberry Pi running Hassbian you're going to be using a ssh client. Depending on your platform there are several alternatives for doing this. Linux and Max OS generally have a ssh client installed. Windows users are recommended to download and install the ssh client [Putty][ssh-putty]. Connect to the Raspberry Pi over ssh. Default user name is `pi` and password is `raspberry`. Linux and Mac OS users execute the following command in a terminal. @@ -28,22 +28,22 @@ Optionally, starting with Windows 10 anniversary update, you can use the built-i Log in as the `pi` account and execute the following commands: ```bash -$ sudo systemctl stop home-assistant@homeassistant.service +$ sudo systemctl stop home-assistant@homeassistant.service ``` Replace `stop` with `start` or `restart` to get the desired functionality. -To get the current state of the `homeassistant.service` replace `stop` with `status`. +To get the current state of the `homeassistant.service` replace `stop` with `status`. ### {% linkable_title Update Home Assistant %}

-You can also use `hassbian-config` to automate the process by running `sudo hassbian-config upgrade home-assistant` +You can use `hassbian-config` to automate the process by running `sudo hassbian-config upgrade homeassistant`

Log in as the `pi` account and execute the following commands: ```bash -$ sudo systemctl stop home-assistant@homeassistant.service +$ sudo systemctl stop home-assistant@homeassistant.service $ sudo su -s /bin/bash homeassistant $ source /srv/homeassistant/bin/activate $ pip3 install --upgrade homeassistant @@ -53,12 +53,12 @@ $ sudo systemctl start home-assistant@homeassistant.service This will in order do the following: -- Stop the Home Assistant service running on HASSbian +- Stop the Home Assistant service running on Hassbian - Open a shell as the `homeassistant` user running the Homeassistant service and that has ownership over the Home Assistant installation. - Change into the virtual Python environment at `/srv/homeassistant/` containing the Home Assistant installation. - Upgrade the Home Assistant installation to the latest release. - Exit the shell and return to the `pi` user. -- Restart the Home Assistant service. +- Start the Home Assistant service. ### {% linkable_title Manually launch Home Assistant %} Log in as the `pi` account and execute the following commands: diff --git a/source/_docs/installation/hassbian/customization.markdown b/source/_docs/installation/hassbian/customization.markdown index adc479f6d4..e1c968a0c4 100644 --- a/source/_docs/installation/hassbian/customization.markdown +++ b/source/_docs/installation/hassbian/customization.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Customization" -description: "Instructions to flash the Home Assistant HASSbian image on a Raspberry Pi." +description: "Instructions to flash the Home Assistant Hassbian image on a Raspberry Pi." date: 2016-09-26 21:00 sidebar: true comments: false @@ -10,26 +10,34 @@ footer: true redirect_from: /docs/hassbian/customization/ --- -To allow you to customize your installation further, we have included a tool called `hassbian-config`. This tool comes with a set of packages that can easily be installed or upgraded for easier customization of your Home Assistant installation. -The tool is available by running `hassbian-config`. +To allow you to customize your installation further, we have included a tool called `hassbian-config`. This tool comes with a set of suites that can easily be installed or upgraded for easier customization of your Home Assistant installation. +The tool is available by running `hassbian-config`. ### Install scripts -To view the available packages run `hassbian-config show` and `sudo hassbian-config install PACKAGENAME`. - - Install Hue. Configures the Python executable to allow usage of low numbered ports for use with Emulated Hue component that's used with Amazon Echo, Google Home and Mycroft.ai. - - Install MariaDB. This script installs MariaDB and it's dependencies for use with the recorder component in Home Assistant. No database or database user is created during this setup and will need to be created manually. - - Install Mosquitto MQTT server. Installs the latest Mosquitto package and client tools from the Mosquitto projects official repository. Now includes websocket support. - - Install Libcec. Adds local [HDMI CEC support][cec]. *This scipt is currently brooken upstream since it currently doesn't build properly for Python >3.4* - - Install Samba. Allows anyone on your network to edit your configuration from any computer. This share is unsecured and it's usage is not recommended if you share your network with others. - - Install Tradfri. Installs dependencies for using IKEA Trådfri. - - Install Duck DNS auto renewal. This script adds a cron job to auto update the WAN IP address for the defined domain. Before running this script you should already have an Duck DNS account. During the installation you will be asked to supply your domain name and the token for your account. - - Install a web terminal for easy access to ssh in any web browser. This script installs a web terminal called 'shellinabox' on your system that gives you SSH access in your web browser. +To view the available suites run `hassbian-config show` or have a look at the [hassbian-scripts repository][hassbian-repo]. +These are some of the available suites: + - [AppDaemon](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/appdaemon.md) + - [Duck DNS](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/duckdns.md) _This can also be configured to generate Let's Encrypt SSL certificates_ + - [Homebridge](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/homebridge.md) + - [Mosquitto](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/mosquitto.md) + - [Samba](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/samba.md) + - [Webterminal](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/webterminal.md) + - Various database engines. + - [MariaDB](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/mariadb.md) + - [PostgreSQL](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/postgresql.md) + - [MS SQL](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/mssql.md) -#### Upgrade scripts -To view the available packages run `hassbian-config show` and `sudo hassbian-config upgrade PACKAGENAME`. -- Upgrade your Home Assistant installation. -- Upgrade your HASSbian installation. -- Upgrade HASSbian-scripts. -- Upgrade HASSbian-scripts from dev branch. + To install any of them simply run `sudo hassbian-config install SUITE`. + +### Upgrade scripts +To view the available suites run `hassbian-config show` or have a look at the [hassbian-scripts repository][hassbian-repo]. +These are some of the available suites: +- [AppDaemon](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/appdaemon.md) +- [Hassbian](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/hassbian.md) +- [Home Assistant](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/homeassistant.md) +- [hassbian-config (hassbian-sctipts)](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/hassbian_config.md) + +To upgrade any of them simply run `sudo hassbian-config upgrade SUITE`. For more information about this tool have a look at the [hassbian-scripts repository][hassbian-repo]. diff --git a/source/_docs/installation/hassbian/installation.markdown b/source/_docs/installation/hassbian/installation.markdown index 8ed803699e..c6e73879ef 100644 --- a/source/_docs/installation/hassbian/installation.markdown +++ b/source/_docs/installation/hassbian/installation.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Installing Hassbian" -description: "Instructions to flash the Home Assistant HASSbian image on a Raspberry Pi." +description: "Instructions to flash the Home Assistant Hassbian image on a Raspberry Pi." date: 2016-09-26 21:00 sidebar: true comments: false @@ -10,22 +10,23 @@ footer: true redirect_from: /docs/hassbian/installation/ --- -The easiest way to install Home Assistant on your Raspberry Pi is by using HASSbian: a Raspberry Pi image with Home Assistant built-in. The image will install the latest version of Home Assistant on initial boot (~10 minutes). +One of the easiest ways to install Home Assistant on your Raspberry Pi Zero, 2 ,3 and 3B+ is by using Hassbian: a Raspberry Pi image with Home Assistant built-in. The image will install the latest version of Home Assistant on initial boot (~10 minutes). 1. [Download the Hassbian image][image-download] 2. Use [Etcher][etcher] to flash the image to your SD card - 3. Ensure your Raspberry Pi has wired access to the internet for the entire process or configure your wireless network settings **before proceeding to step 4**. - 4. Insert SD card to Raspberry Pi and turn it on. Initial installation of Home Assistant will take about 5 minutes. + 3. Ensure your Raspberry Pi has wired access to the internet for the entire process or configure your [wireless network settings](#wireless-network) **before proceeding to step 4**. + 4. Insert SD card to Raspberry Pi and turn it on. Initial installation of Home Assistant will take about 10 minutes.

Please remember to ensure you're using an [appropriate power supply](https://www.raspberrypi.org/help/faqs/#powerReqs) with your Pi. Mobile chargers may not be suitable, since some are designed to only provide the full power with that manufacturer's handsets.

-These instructions are also available as a [video](https://www.youtube.com/watch?v=iIz6XqDwHEk). Additional information is available in this [video](https://www.youtube.com/watch?v=tCGlQSsQ-Mc). +These instructions are also available as a [video](https://www.youtube.com/watch?v=iIz6XqDwHEk). +Additional information is available in this [video](https://www.youtube.com/watch?v=tCGlQSsQ-Mc). -After initial boot an installer will run in the background and takes around 15 minutes to complete, after it has finished, you will be prompted to login: `hassbian login:`. Installation is complete at this point. The default username is `pi` and the password is `raspberry`. +After initial boot an installer will run in the background, this will download and install the newest version of [hassbian-config](https://github.com/home-assistant/hassbian-scripts) and Home-Assistant, this takes around 10 minutes to complete, after it has finished, you will be prompted to login: `hassbian login:`. Installation is complete at this point. The default username is `pi` and the password is `raspberry`. -Open a browser on a device that's connected to the same WiFi network as your Raspberry Pi and point it to Home Assistant at [http://hassbian.local:8123]. If you want to login via SSH, the default username is `pi` and password is `raspberry` (please change this by running `passwd`). The Home Assistant configuration is located at `/home/homeassistant/.homeassistant/`. +Open a browser on a device that's connected to the same network as your Raspberry Pi and point it to Home Assistant at [http://hassbian.local:8123]. If you want to login via SSH, the default username is `pi` and password is `raspberry` (please change this by running `passwd`). The Home Assistant configuration is located at `/home/homeassistant/.homeassistant/`. If you find that the web page is not reachable after 30 minutes or so, check that you have files in `/home/homeassistant/.homeassistant/`, if there are no files in this location then run the installer manually using this command: `sudo systemctl start install_homeassistant.service`. @@ -35,7 +36,7 @@ The following extras are included on the image: - GPIO pins are ready to use. - Bluetooth is ready to use (supported models only, no Bluetooth LE). - SSH server is enabled. - - A tool called [`hassbian-config`](https://github.com/home-assistant/hassbian-scripts#hassbian-config-hassbian-config). + - A tool called [`hassbian-config`](https://github.com/home-assistant/hassbian-scripts#hassbian-scripts). ### {% linkable_title Wireless Network %} @@ -63,4 +64,3 @@ You may need to adjust the country code depending upon where you are. A list of [etcher]: https://etcher.io/ [http://hassbian.local:8123]: http://hassbian.local:8123 [wifi-setup]: https://www.raspberrypi.org/documentation/configuration/wireless/wireless-cli.md - diff --git a/source/_docs/installation/hassbian/integrations.markdown b/source/_docs/installation/hassbian/integrations.markdown index 5658ce712e..d6f7a3fd0c 100644 --- a/source/_docs/installation/hassbian/integrations.markdown +++ b/source/_docs/installation/hassbian/integrations.markdown @@ -26,11 +26,11 @@ For more details about the GPIO layout, visit the [documentation](https://www.ra Permission have been given to the `homeassistant` user to use the GPIO pins and all of the following components should require no underlying changes to work. Just follow the component pages for each on how to add them to your Home Assistant installation. - - [DHT Sensor](/components/sensor.dht/). - - [Raspberry Pi Cover](/components/cover.rpi_gpio/). - - [Raspberry Pi GPIO Binary Sensor](/components/binary_sensor.rpi_gpio/). - - [Raspberry Pi GPIO Switch](/components/switch.rpi_gpio/). - - [Raspberry Pi RF Switch](/components/switch.rpi_rf/). + - [DHT Sensor](/components/sensor.dht/) + - [Raspberry Pi Cover](/components/cover.rpi_gpio/) + - [Raspberry Pi GPIO Binary Sensor](/components/binary_sensor.rpi_gpio/) + - [Raspberry Pi GPIO Switch](/components/switch.rpi_gpio/) + - [Raspberry Pi RF Switch](/components/switch.rpi_rf/) ### {% linkable_title Raspberry Pi Camera %} diff --git a/source/_docs/installation/hassbian/upgrading.markdown b/source/_docs/installation/hassbian/upgrading.markdown index 7ef479edcb..d7e094c16a 100644 --- a/source/_docs/installation/hassbian/upgrading.markdown +++ b/source/_docs/installation/hassbian/upgrading.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Upgrading Hassbian" -description: "Instructions how to upgrade Hassbian to the latest version." +description: "Instructions on how to upgrade Hassbian to the latest version." date: 2016-09-26 21:00 sidebar: true comments: false @@ -10,7 +10,7 @@ footer: true redirect_from: /docs/hassbian/upgrading/ --- -HASSbian is based on Raspbian and uses the same repositories. Any changes to Raspbian will be reflected in HASSbian. To update and upgrade system packages and installed software (excluding Home Assistant) do the following. +Hassbian is based on Raspbian and uses the same repositories. Any changes to Raspbian will be reflected in Hassbian. To update and upgrade system packages and installed software (excluding Home Assistant) do the following. Log in as the `pi` account and execute the following commands: ```bash @@ -18,10 +18,9 @@ $ sudo apt-get update $ sudo apt-get -y upgrade ``` - #### {% linkable_title Updating Home Assistant %}

-You can also use `hassbian-config` to automate the process by running `sudo hassbian-config upgrade home-assistant` +You can use `hassbian-config` to automate the process by running `sudo hassbian-config upgrade homeassistant`

To update the Home Assistant installation execute the following command as the `pi` user. diff --git a/source/_docs/installation/raspberry-pi-all-in-one.markdown b/source/_docs/installation/raspberry-pi-all-in-one.markdown index 6039ffed44..f983bb9d0b 100644 --- a/source/_docs/installation/raspberry-pi-all-in-one.markdown +++ b/source/_docs/installation/raspberry-pi-all-in-one.markdown @@ -9,5 +9,5 @@ redirect_from: /getting-started/installation-raspberry-pi-all-in-one/ ---

- The All-In-One Installer is deprecated, you will have problems updating Home Assistant in 2018. Please move to another [installation method](https://home-assistant.io/getting-started/). + The All-In-One Installer is deprecated, you will have problems updating Home Assistant in 2018. Please move to another [installation method](/getting-started/).

diff --git a/source/_docs/installation/raspberry-pi.markdown b/source/_docs/installation/raspberry-pi.markdown index b0cb1b8a4a..c272e97dbf 100644 --- a/source/_docs/installation/raspberry-pi.markdown +++ b/source/_docs/installation/raspberry-pi.markdown @@ -49,10 +49,10 @@ $ sudo apt-get install python3 python3-venv python3-pip ``` Add an account for Home Assistant called `homeassistant`. -Since this account is only for running Home Assistant the extra arguments of `-rm` is added to create a system account and create a home directory. +Since this account is only for running Home Assistant the extra arguments of `-rm` is added to create a system account and create a home directory. The arguments `-G dialout` adds the user to the `dialout` group. This is required for using Z-Wave and Zigbee controllers. ```bash -$ sudo useradd -rm homeassistant +$ sudo useradd -rm homeassistant -G dialout ``` Next we will create a directory for the installation of Home Assistant and change the owner to the `homeassistant` account. diff --git a/source/_docs/installation/synology.markdown b/source/_docs/installation/synology.markdown index fee65366be..454dcd8858 100644 --- a/source/_docs/installation/synology.markdown +++ b/source/_docs/installation/synology.markdown @@ -10,6 +10,10 @@ footer: true redirect_from: /getting-started/installation-synology/ --- +

+Synology only provide Python 3.5.1, which is not compatible with Home Assistant 0.65.0 or later. Until Synology offer an updated version of Python, Home Assistant 0.64 is the most recent version that will be able to be installed. You can manually specify the version of Home Assistant to install, for example to install version 0.64.3 you would do `./python3 -m pip install homeassistant==0.64.3` +

+ There are 2 alternatives, when using Home Assistant on Synology NAS: 1. using Docker 2. directly running on DSM @@ -26,7 +30,7 @@ Running these commands will: Using the Synology webadmin: - - Install python3 using the Synology Package Center (be aware, this provides 3.5.1, which is not compatible with Home Assistant 0.65.0 or later) + - Install python3 using the Synology Package Center - Create homeassistant user and add to the "users" group SSH onto your synology & login as admin or root @@ -51,16 +55,12 @@ Install PIP (Python's package management system) # ./python3 -m ensurepip ``` -Use PIP to install Homeassistant package +Use PIP to install Homeassistant package 0.64.3 ```bash -# ./python3 -m pip install homeassistant +# ./python3 -m pip install homeassistant==0.64.3 ``` -

-Until Synology offer an updated version of Python, Home Assistant 0.64 is the most recent version that will be able to be installed. You can manually specify the version of Home Assistant to install, for example to install version 0.64.3 you would do `./python3 -m pip install homeassistant==0.64.3` -

- Create homeassistant config directory & switch to it ```bash @@ -69,7 +69,7 @@ Create homeassistant config directory & switch to it # chmod 755 /volume1/homeassistant # cd /volume1/homeassistant ``` -Hint: alternatively you can also create a "Shared Folder" via Synology WebUI (e.g. via "File Station") - this has the advantage that the folder is visible via "File Station". +Hint: alternatively you can also create a "Shared Folder" via Synology WebUI (e.g., via "File Station") - this has the advantage that the folder is visible via "File Station". Create hass-daemon file using the following code (edit the variables in uppercase if necessary) diff --git a/source/_docs/installation/updating.markdown b/source/_docs/installation/updating.markdown index 012a5a5c08..a9884322b6 100644 --- a/source/_docs/installation/updating.markdown +++ b/source/_docs/installation/updating.markdown @@ -11,10 +11,14 @@ redirect_from: /getting-started/updating/ ---

-The upgrade process differs depending on the installation you have, so please review the documentation that is specific to your install [Hass.io](/hassio/), [HASSbian](/docs/hassbian/common-tasks/#update-home-assistant), [Vagrant](/docs/installation/vagrant/), or [Virtualenv](/docs/installation/virtualenv/#upgrading-home-assistant). +The upgrade process differs depending on the installation you have, so please review the documentation that is specific to your install [Hass.io](/hassio/), [Hassbian](/docs/installation/hassbian/common-tasks/#update-home-assistant), [Vagrant](/docs/installation/vagrant/), or [Virtualenv](/docs/installation/virtualenv/#upgrading-home-assistant).

-Check what's new in the latest version and potentially impacts your system in [Home Assistant release notes](https://github.com/home-assistant/home-assistant/releases). It is good practice to review these release notes and pay close attention to the **Breaking Changes** that are listed there. If you haven't done an update for a while, you should also check previous release notes as they can also contain relevant **Breaking Changes**. **Breaking Changes** may require configuration updates for your components. If you missed this and Home Assistant refuses to start, check `/home-assistant.log` for details about broken components. +Check what's new in the latest version and potentially impacts your system in [Home Assistant release notes](https://github.com/home-assistant/home-assistant/releases). It is good practice to review these release notes and pay close attention to the **Breaking Changes** that are listed there. If you haven't done an update for a while, you should also check previous release notes as they can also contain relevant **Breaking Changes**. **Breaking Changes** may require configuration updates for your components. If you missed this and Home Assistant refuses to start, check the log file in the [configuration](/docs/configuration/) directory, e.g., `.homeassistant/home-assistant.log`, for details about broken components. + +

+To avoid permission errors, the upgrade must be run as the same user as the installation was completed, again review the documentation specific to your install [Hass.io](/hassio/), [Hassbian](/docs/hassbian/installation/), [Vagrant](/docs/installation/vagrant/), or [Virtualenv](/docs/installation/virtualenv). +

The default way to update Home Assistant to the latest release, when available, is: @@ -22,11 +26,13 @@ The default way to update Home Assistant to the latest release, when available, $ pip3 install --upgrade homeassistant ``` -After updating, you must restart Home Assistant for the changes to take effect. This means that you will have to restart `hass` itself or the [autostarting](/docs/autostart/) daemon (if applicable). Startup can take considerable amount of time (i.e. minutes) depending on your device. This is because all requirements are updated as well. +For a Docker container, simply pull the latest one: -

-To avoid permission errors, the upgrade must be run as the same user as the installation was completed, again review the documentation specific to your install [Hass.io](/hassio/), [HASSbian](/docs/hassbian/installation/), [Vagrant](/docs/installation/vagrant/), or [Virtualenv](/docs/installation/virtualenv). -

+```bash +$ sudo docker pull homeassistant/home-assistant:latest +``` + +After updating, you must start/restart Home Assistant for the changes to take effect. This means that you will have to restart `hass` itself or the [autostarting](/docs/autostart/) daemon (if applicable). Startup can take considerable amount of time (i.e. minutes) depending on your device. This is because all requirements are updated as well. [BRUH automation](http://www.bruhautomation.com) has created [a tutorial video](https://www.youtube.com/watch?v=tuG2rs1Cl2Y) explaining how to upgrade Home Assistant. @@ -40,7 +46,7 @@ $ pip3 install homeassistant==0.XX.X #### {% linkable_title Run the development version %} -If you want to stay on the bleeding-edge Home Assistant development branch, you can upgrade to `dev`. +If you want to stay on the bleeding-edge Home Assistant development branch, you can upgrade to `dev`.

The "dev" branch is likely to be unstable. Potential consequences include loss of data and instance corruption. diff --git a/source/_docs/installation/virtualenv.markdown b/source/_docs/installation/virtualenv.markdown index 386adbc7bf..7c56772af7 100644 --- a/source/_docs/installation/virtualenv.markdown +++ b/source/_docs/installation/virtualenv.markdown @@ -17,7 +17,7 @@ It's recommended when installing Python packages that you use a [virtual environ _(If you're on a Debian based system, you will need to install Python virtual environment support using `apt-get install python3-pip python3-venv`.)_

-It is recommended to use the [advanced guide](/docs/installation/raspberry-pi/) which allows for the installation to run as a `homeassistant` user. The steps below may be shorter but some users find difficulty when applying updates and may run into issues. +It is recommended to use the [advanced guide](/docs/installation/raspberry-pi/) which allows for the installation to run as a `homeassistant` user. The steps below may be shorter but some users find difficulty when applying updates and may run into issues.

### {% linkable_title Install %} @@ -74,3 +74,12 @@ It is recommended to use the [advanced guide](/docs/installation/raspberry-pi/)

Looking for more advanced guides? Check our [Rasbian guide](/docs/installation/raspberry-pi/) or the [other installation guides](/docs/installation/).

+ +### {% linkable_title After upgrading Python %} + +If you've upgraded Python (for example, you were running 3.5.2 and now you've installed 3.5.4) then you'll need to build a new virtual environment. Simply rename your existing virtual environment directory: + +```bash +$ mv homeassistant homeassistant.old +``` +Then follow the [Install](/docs/installation/virtualenv/#install) steps again, being sure to use the newly installed version of Python. diff --git a/source/_docs/mqtt/birth_will.markdown b/source/_docs/mqtt/birth_will.markdown index afce8a592f..8ba1aa593a 100644 --- a/source/_docs/mqtt/birth_will.markdown +++ b/source/_docs/mqtt/birth_will.markdown @@ -1,7 +1,7 @@ --- layout: page title: "MQTT Birth and Last will" -description: "Instructions how to setup MQTT birth and last will messages within Home Assistant." +description: "Instructions on how to setup MQTT birth and last will messages within Home Assistant." date: 2015-08-07 18:00 sidebar: true comments: false diff --git a/source/_docs/mqtt/broker.markdown b/source/_docs/mqtt/broker.markdown index 47ea1bb73e..87406a5873 100644 --- a/source/_docs/mqtt/broker.markdown +++ b/source/_docs/mqtt/broker.markdown @@ -1,7 +1,7 @@ --- layout: page title: "MQTT Brokers" -description: "Instructions how to setup MQTT brokers for Home Assistant." +description: "Instructions on how to setup MQTT brokers for Home Assistant." date: 2015-08-07 18:00 sidebar: true comments: false @@ -62,7 +62,7 @@ mqtt: {% configuration %} broker: required: false - description: The IP address or hostname of your MQTT broker, e.g. 192.168.1.32. + description: The IP address or hostname of your MQTT broker, e.g., 192.168.1.32. type: string port: required: false @@ -109,7 +109,7 @@ If you get this error `AttributeError: module 'ssl' has no attribute 'PROTOCOL_T

-If you are running a Mosquitto instance on the same server as Home Assistant then you must ensure that the Mosquitto service starts before Home Assistant. For a Linux instance running Systemd (Raspberry Pi, Debian, Ubuntu and others) then you should edit the file /etc/systemd/system/home-assistant@homeassistant.service as root (e.g. sudo nano /etc/systemd/system/home-assistant@homeassistant.service) and add the mosquitto service: +If you are running a Mosquitto instance on the same server as Home Assistant then you must ensure that the Mosquitto service starts before Home Assistant. For a Linux instance running Systemd (Raspberry Pi, Debian, Ubuntu and others) then you should edit the file /etc/systemd/system/home-assistant@homeassistant.service as root (e.g., sudo nano /etc/systemd/system/home-assistant@homeassistant.service) and add the mosquitto service: ``` [Unit] Description=Home Assistant diff --git a/source/_docs/mqtt/certificate.markdown b/source/_docs/mqtt/certificate.markdown index bf410b916a..252e0a5160 100644 --- a/source/_docs/mqtt/certificate.markdown +++ b/source/_docs/mqtt/certificate.markdown @@ -1,7 +1,7 @@ --- layout: page title: "MQTT Certificate" -description: "Instructions how to setup MQTT with a certificate in Home Assistant." +description: "Instructions on how to setup MQTT with a certificate in Home Assistant." date: 2015-08-07 18:00 sidebar: true comments: false diff --git a/source/_docs/mqtt/discovery.markdown b/source/_docs/mqtt/discovery.markdown index 3242a5f86d..27b588f015 100644 --- a/source/_docs/mqtt/discovery.markdown +++ b/source/_docs/mqtt/discovery.markdown @@ -1,7 +1,7 @@ --- layout: page title: "MQTT Discovery" -description: "Instructions how to setup MQTT Discovery within Home Assistant." +description: "Instructions on how to setup MQTT Discovery within Home Assistant." date: 2015-08-07 18:00 sidebar: true comments: false @@ -15,6 +15,7 @@ The discovery of MQTT devices will enable one to use MQTT devices with only mini Supported by MQTT discovery: - [Binary sensors](/components/binary_sensor.mqtt/) +- [Cameras](/components/camera.mqtt/) - [Covers](/components/cover.mqtt/) - [Fans](/components/fan.mqtt/) - [Lights](/components/light.mqtt/) @@ -42,8 +43,8 @@ The discovery topic need to follow a specific format: ``` - ``: One of the supported components, eg. `binary_sensor`. -- ``: (*Optional*) id of the node providing the topic. -- ``: "The ID of the device. This is only to allow for separate topics for each device and is not used for the `entity_id`." +- `` (*Optional*): ID of the node providing the topic. +- ``: The ID of the device. This is only to allow for separate topics for each device and is not used for the `entity_id`. - `<>`: The topic `config` or `state` which defines the current action. The payload will be checked like an entry in your `configuration.yaml` file if a new device is added. This means that missing variables will be filled with the platform's default values. All configuration variables which are *required* must be present in the initial payload send to `/config`. @@ -55,7 +56,7 @@ The `` level can be used by clients to only subscribe to their own (com The following firmware for ESP8266, ESP32 and Sonoff unit has built-in support for MQTT discovery: - [Sonoff-Tasmota](https://github.com/arendst/Sonoff-Tasmota) (starting with 5.11.1e) -- [esphomelib](https://github.com/OttoWinter/esphomelib) +- [esphomeyaml](https://esphomelib.com/esphomeyaml/index.html) - [ESPurna](https://github.com/xoseperez/espurna) - [Arilux AL-LC0X LED controllers](https://github.com/mertenats/Arilux_AL-LC0X) diff --git a/source/_docs/mqtt/logging.markdown b/source/_docs/mqtt/logging.markdown index 999e24988f..d4deaf4f48 100644 --- a/source/_docs/mqtt/logging.markdown +++ b/source/_docs/mqtt/logging.markdown @@ -1,7 +1,7 @@ --- layout: page title: "MQTT Logging" -description: "Instructions how to setup MQTT Logging within Home Assistant." +description: "Instructions on how to setup MQTT Logging within Home Assistant." date: 2015-08-07 18:00 sidebar: true comments: false diff --git a/source/_docs/mqtt/processing_json.markdown b/source/_docs/mqtt/processing_json.markdown index 552dd08167..8afb951f8e 100644 --- a/source/_docs/mqtt/processing_json.markdown +++ b/source/_docs/mqtt/processing_json.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Processing JSON" -description: "Instructions how to process the MQTT payload." +description: "Instructions on how to process the MQTT payload." date: 2015-08-07 18:00 sidebar: true comments: false diff --git a/source/_docs/mqtt/service.markdown b/source/_docs/mqtt/service.markdown index d751856fe4..941d79e7b7 100644 --- a/source/_docs/mqtt/service.markdown +++ b/source/_docs/mqtt/service.markdown @@ -1,7 +1,7 @@ --- layout: page title: "MQTT Publish service" -description: "Instructions how to setup the MQTT Publish service within Home Assistant." +description: "Instructions on how to setup the MQTT Publish service within Home Assistant." date: 2015-08-07 18:00 sidebar: true comments: false diff --git a/source/_docs/mqtt/testing.markdown b/source/_docs/mqtt/testing.markdown index f71ac52e2f..e6c87bdbfc 100644 --- a/source/_docs/mqtt/testing.markdown +++ b/source/_docs/mqtt/testing.markdown @@ -1,7 +1,7 @@ --- layout: page title: "MQTT Testing" -description: "Instructions how to test your MQTT setup." +description: "Instructions on how to test your MQTT setup." date: 2015-08-07 18:00 sidebar: true comments: false diff --git a/source/_docs/scripts.markdown b/source/_docs/scripts.markdown index 5c39a604ab..ef490f4de2 100644 --- a/source/_docs/scripts.markdown +++ b/source/_docs/scripts.markdown @@ -21,7 +21,8 @@ script: sequence: # This is written using the Script Syntax - service: light.turn_on - entity_id: light.ceiling + data: + entity_id: light.ceiling - service: notify.notify data: message: 'Turned on the ceiling light!' @@ -32,11 +33,11 @@ script: The most important one is the action to call a service. This can be done in various ways. For all the different possibilities, have a look at the [service calls page]. ```yaml -alias: Bedroom lights on -service: light.turn_on -data: - entity_id: group.bedroom - brightness: 100 +- alias: Bedroom lights on + service: light.turn_on + data: + entity_id: group.bedroom + brightness: 100 ``` ### {% linkable_title Test a Condition %} @@ -44,9 +45,9 @@ data: While executing a script you can add a condition to stop further execution. When a condition does not return `true`, the script will finish. There are many different conditions which are documented at the [conditions page]. ```yaml -condition: state -entity_id: device_tracker.paulus -state: 'home' +- condition: state + entity_id: device_tracker.paulus + state: 'home' ``` ### {% linkable_title Delay %} @@ -55,46 +56,53 @@ Delays are useful for temporarily suspending your script and start it at a later ```yaml # Waits 1 hour -delay: 01:00 +- delay: '01:00' ``` ```yaml # Waits 1 minute, 30 seconds -delay: 00:01:30 +- delay: '00:01:30' ``` ```yaml # Waits 1 minute -delay: - # supports milliseconds, seconds, minutes, hours, days - minutes: 1 +- delay: + # supports milliseconds, seconds, minutes, hours, days + minutes: 1 ``` +{% raw %} ```yaml # Waits however many minutes input_number.minute_delay is set to # Valid formats include HH:MM and HH:MM:SS -delay: {% raw %}'00:{{ states.input_number.minute_delay.state | int }}:00'{% endraw %} +- delay: "00:{{ states('input_number.minute_delay')|int }}:00" ``` +{% endraw %} + ### {% linkable_title Wait %} Wait until some things are complete. We support at the moment `wait_template` for waiting until a condition is `true`, see also on [Template-Trigger](/docs/automation/trigger/#template-trigger). It is possible to set a timeout after which the script will abort its execution if the condition is not satisfied. Timeout has the same syntax as `delay`. +{% raw %} ```yaml # wait until media player have stop the playing -wait_template: {% raw %}"{{ states.media_player.floor.state == 'stop' }}"{% endraw %} +- wait_template: "{{ is_state('media_player.floor', 'stop') }}" ``` +{% endraw %} +{% raw %} ```yaml -# wait until a valve is < 10 or abort after 1 minutes. -wait_template: {% raw %}"{{ states.climate.kitchen.attributes.valve < 10 }}"{% endraw %} -timeout: 00:01:00 +# wait until a valve is < 10 or abort after 1 minute. +- wait_template: "{{ states.climate.kitchen.attributes.valve|int < 10 }}" + timeout: '00:01:00' ``` +{% endraw %} When using `wait_template` within an automation `trigger.entity_id` is supported for `state`, `numeric_state` and `template` triggers, see also [Available-Trigger-Data](/docs/automation/templating/#available-trigger-data). {% raw %} ```yaml -wait_template: "{{ is_state(trigger.entity_id, 'on') }}" +- wait_template: "{{ is_state('trigger.entity_id', 'on') }}" ``` {% endraw %} @@ -102,13 +110,13 @@ It is also possible to use dummy variables, e.g., in scripts, when using `wait_t {% raw %} ```yaml -# Service call, e.g. from an automation. -service: script.do_something -data_template: - dummy: "{{ input_boolean.switch }}" +# Service call, e.g., from an automation. +- service: script.do_something + data_template: + dummy: input_boolean.switch # Inside the script -wait_template: "{{ is_state(dummy, 'off') }}" +- wait_template: "{{ is_state(dummy, 'off') }}" ``` {% endraw %} @@ -117,12 +125,12 @@ wait_template: "{{ is_state(dummy, 'off') }}" This action allows you to fire an event. Events can be used for many things. It could trigger an automation or indicate to another component that something is happening. For instance, in the below example it is used to create an entry in the logbook. ```yaml -event: LOGBOOK_ENTRY -event_data: - name: Paulus - message: is waking up - entity_id: device_tracker.paulus - domain: light +- event: LOGBOOK_ENTRY + event_data: + name: Paulus + message: is waking up + entity_id: device_tracker.paulus + domain: light ``` You can also use event_data_template to fire an event with custom data. This could be used to pass data to another script awaiting @@ -130,10 +138,10 @@ an event trigger. {% raw %} ```yaml -event: MY_EVENT -event_data_template: - name: myEvent - customData: "{{ myCustomVariable }}" +- event: MY_EVENT + event_data_template: + name: myEvent + customData: "{{ myCustomVariable }}" ``` {% endraw %} @@ -145,13 +153,13 @@ The following automation shows how to raise a custom event called `event_light_s ```yaml - alias: Fire Event trigger: - platform: state - entity_id: switch.kitchen - to: 'on' + - platform: state + entity_id: switch.kitchen + to: 'on' action: - event: event_light_state_changed - event_data: - state: "on" + - event: event_light_state_changed + event_data: + state: 'on' ``` {% endraw %} @@ -161,8 +169,8 @@ The following automation shows how to capture the custom event `event_light_stat ```yaml - alias: Capture Event trigger: - platform: event - event_type: event_light_state_changed + - platform: event + event_type: event_light_state_changed action: - service: notify.notify data_template: diff --git a/source/_docs/scripts/conditions.markdown b/source/_docs/scripts/conditions.markdown index a9e0b8c564..5ca5b9c756 100644 --- a/source/_docs/scripts/conditions.markdown +++ b/source/_docs/scripts/conditions.markdown @@ -119,13 +119,13 @@ condition: The sun condition can test if the sun has already set or risen when a trigger occurs. The `before` and `after` keys can only be set to `sunset` or `sunrise`. They have a corresponding optional offset value (`before_offset`, `after_offset`) that can be added, similar to the [sun trigger][sun_trigger]. -[sun_trigger]: /getting-started/automation-trigger/#sun-trigger +[sun_trigger]: /docs/automation/trigger/#sun-trigger ```yaml condition: condition: sun after: sunset - # Optional offset value + # Optional offset value - in this case it must from -1 hours relative to sunset, or after after_offset: "-1:00:00" ``` diff --git a/source/_docs/scripts/service-calls.markdown b/source/_docs/scripts/service-calls.markdown index b1b1833340..ab73aad529 100644 --- a/source/_docs/scripts/service-calls.markdown +++ b/source/_docs/scripts/service-calls.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Service Calls" -description: "Instructions how to call services in Home Assistant." +description: "Instructions on how to call services in Home Assistant." date: 2016-03-12 12:00 -0800 sidebar: true comments: false diff --git a/source/_docs/tools/check_config.markdown b/source/_docs/tools/check_config.markdown index f9a31e0374..b09ea5b17c 100644 --- a/source/_docs/tools/check_config.markdown +++ b/source/_docs/tools/check_config.markdown @@ -15,3 +15,23 @@ Test any changes to your `configuration.yaml` file before launching Home Assista $ hass --script check_config ``` +The script has further options like checking configuration files which are not located in the default directory or showing your secrets for debugging. + +```bash +$ hass --script check_config -h +usage: hass [-h] [--script {check_config}] [-c CONFIG] [-i [INFO]] [-f] [-s] + +Check Home Assistant configuration. + +optional arguments: + -h, --help show this help message and exit + --script {check_config} + -c CONFIG, --config CONFIG + Directory that contains the Home Assistant + configuration + -i [INFO], --info [INFO] + Show a portion of the config + -f, --files Show used configuration files + -s, --secrets Show secret information +``` + diff --git a/source/_docs/tools/dev-tools.markdown b/source/_docs/tools/dev-tools.markdown index 88e282683c..99ce3e7cf7 100644 --- a/source/_docs/tools/dev-tools.markdown +++ b/source/_docs/tools/dev-tools.markdown @@ -9,7 +9,7 @@ sharing: true footer: true --- -The frontend contains a section called "Developer Tools". +The frontend contains a section called "Developer Tools".

@@ -63,7 +63,7 @@ For ex: Changing the `light.bedroom` state from `off` to `on` does not turn on t This Events section is as basic as it can get. It does only one thing – fires events on the event bus. To fire an event, simply type the name of the event, and pass the event data in JSON format. -For ex: To fire a custom event, enter the `event_type` as `event_light_state_changed` and the event data JSON as +For ex: To fire a custom event, enter the `event_type` as `event_light_state_changed` and the event data JSON as ```json { "state":"on" } @@ -83,19 +83,20 @@ If there is an automation that handles that event, it will be automatically trig {% linkable_title Template Editor %} -The Template Editor provides a way to test the template code quickly. When the Template Editor page is loaded, it comes with a sample template code that illustrates how the code can be written and tested. +The Template Editor provides a way to test the template code quickly. When the Template Editor page is loaded, it comes with a sample template code that illustrates how the code can be written and tested. -It has two sections, code goes on the left hand side, and the output is shown on the right hand side. The code can be removed and replaced, and when the page is loaded/refreshed, the default sample code will be loaded back. +It has two sections, code goes on the left hand side, and the output is shown on the right hand side. The code can be removed and replaced, and when the page is loaded/refreshed, the default sample code will be loaded back. It is a good practice to test the template code in the template editor prior to putting it in automations and scripts. -For more information about jinja2, visit [jinja2 documentation](http://jinja.pocoo.org/docs/dev/templates/), and also read templating document [here](https://home-assistant.io/topics/templating/) +For more information about jinja2, visit [jinja2 documentation](http://jinja.pocoo.org/docs/dev/templates/), and also read templating document [here](/topics/templating/) {% linkable_title mqtt %} -This section is only visible if the MQTT is configured. To configure MQTT, add `mqtt:` to the `configuration.yaml` file. For more information, refer to [mqtt]( https://home-assistant.io/components/mqtt/) -Even though MQTT in general provides deeper functionality, the developer tools section of MQTT is limited to publishing messages to a given topic. It supports templates for the payload. To publish a message, simply specify the topic name and the payload and click “PUBLISH” button. +This section is only visible if the MQTT component is configured. To configure MQTT, add `mqtt:` to the `configuration.yaml` file. For more information, refer to the [mqtt](/components/mqtt/) component. + +Even though MQTT in general provides deeper functionality, the developer tools section of MQTT is limited to publishing messages to a given topic. It supports templates for the payload. To publish a message, simply specify the topic name and the payload and click “PUBLISH” button. {% linkable_title Info %} diff --git a/source/_docs/tools/hass.markdown b/source/_docs/tools/hass.markdown index 3ba0896f35..73e0bd68cd 100644 --- a/source/_docs/tools/hass.markdown +++ b/source/_docs/tools/hass.markdown @@ -39,6 +39,7 @@ optional arguments: specified days --log-file LOG_FILE Log file to write to. If not set, CONFIG/home- assistant.log is used + --log-no-color Disable color logs --runner On restart exit with code 100 --script ... Run one of the embedded scripts --daemon Run Home Assistant as daemon diff --git a/source/_docs/z-wave.markdown b/source/_docs/z-wave.markdown index c6a68fb3c6..6ee6a284fa 100644 --- a/source/_docs/z-wave.markdown +++ b/source/_docs/z-wave.markdown @@ -37,3 +37,9 @@ There are 12 different regions for Z-Wave devices, which relates to the frequenc You'll now need to connect your [controller](/docs/z-wave/controllers/), [configure](/docs/z-wave/installation) the Z-Wave component, then [add some devices](/docs/z-wave/adding) using the [control panel](/docs/z-wave/control-panel). [This explains](/docs/z-wave/devices/) about devices, and how [entities are named](/docs/z-wave/entities). You can get more information on the [available services](/docs/z-wave/services/) and [events](/docs/z-wave/events/), what the [query stages](/docs/z-wave/query-stage) of battery powered devices are, as well as details on configuring [specific devices](/docs/z-wave/device-specific/). + +## {% linkable_title Instant status updates %} + +When you toggle a switch or control a light locally you may find that it takes some time for that to be reflected in Home Assistant. That's because Lutron had patents on the status updates using the *Hail* command class, the traditional way of allowing devices to tell the controller that something happened locally. The same result can be achieved through the *Association* command class, or *Central Scene* command class (though, *Central Scene* isn't [fully supported](https://github.com/OpenZWave/open-zwave/pull/1125) in OpenZWave). + +If you search [the Z-Wave products database](http://products.z-wavealliance.org/) for your product and it lists one of those in the **Controlled** command classes (not the **Supported** command classes), then your device will be able to report state changes when they happen. If it doesn't then updates may either happen eventually, or you may need to (carefully) [enable polling](https://www.home-assistant.io/docs/z-wave/control-panel/#entities-of-this-node). diff --git a/source/_docs/z-wave/adding.markdown b/source/_docs/z-wave/adding.markdown index e2a34934ba..b6fb1f7b3d 100644 --- a/source/_docs/z-wave/adding.markdown +++ b/source/_docs/z-wave/adding.markdown @@ -18,7 +18,7 @@ To add (include) a non-secure Z-Wave [device](/docs/z-wave/devices/) to your sys 3. Activate your device to be included by following the instructions provided with the device 4. With the device in its final location, run a *Heal Network* -Don't use this for [secure devices](https://home-assistant.io/docs/z-wave/adding/#adding-secure-devices), since this is likely to limit the features the device supports. +Don't use this for [secure devices](/docs/z-wave/adding/#adding-secure-devices), since this is likely to limit the features the device supports.

Don't use the OpenZWave control panel (OZWCP), **or the physical button on a controller**, to add or remove devices. Many devices will only send the information about their capabilities at the time you include them. If you use the OpenZWave control panel, or the button on a device, then Home Assistant won't have that information. Using the physical button on a controller will also result in a non-security inclusion being performed, which may limit the features the device supports. diff --git a/source/_docs/z-wave/control-panel.markdown b/source/_docs/z-wave/control-panel.markdown index 400a6b6d4c..ee08d772d8 100644 --- a/source/_docs/z-wave/control-panel.markdown +++ b/source/_docs/z-wave/control-panel.markdown @@ -32,21 +32,21 @@ Here is where you [include and exclude](/docs/z-wave/adding/) Z-Wave devices fro ## {% linkable_title Z-Wave Node Management %} +

+Since 0.63 and the new experimental [entity registry](/docs/configuration/entity-registry/) **Rename Node** no longer changes the entity id for anything other than the `zwave.` entity for the node (it does change the default *friendly_name* attribute for all the entities). See [this issue](https://github.com/home-assistant/home-assistant/issues/12430). +

+ * **Refresh Node** refreshes the information on the node and its entities. If used on a battery powered device, the device will first need to wake for this to work. * **Remove Failed Node** will remove a failed node from the network. The node needs to be on the controller's Failed Node List (marked as `is_failed: true`), otherwise this command will fail. * **Replace Failed Node** will replace a failed device with another. If the node is not in the controller's Failed Node List, or the node responds, this command will fail. * **Print Node** prints all state of Z-Wave node to the console log -* **Rename Node** sets a node's name - this won't happen immediately, and requires you to restart Home Assistant (not reboot) to set the new name +* **Rename Node** sets the name of the `zwave` entity - this won't happen immediately, and requires you to restart Home Assistant (not reboot) to set the new name. Other entities of a device are renamed using the [entity registry](/docs/configuration/entity-registry/). * **Heal Node** starts healing of the node.(Update neighbor list and update return routes) * **Test Node** sends no_op test messages to the node. This could in theory bring back a dead node. -

-Since 0.63 and the new experimental [entity registry](https://home-assistant.io/docs/configuration/entity-registry/) **Rename Node** no longer changes the entity id for anything other than the `zwave.` entity for the node (it does change, the default *friendly_name* and *old_entity_id* and *new_entity_id* attributes for all the entities). See [this issue](https://github.com/home-assistant/home-assistant/issues/12430). -

-

Battery powered devices need to be awake before you can use the Z-Wave control panel to update their settings. How to wake your device is device specific, and some devices will stay awake for only a couple of seconds. Please refer to the manual of your device for more details.

@@ -82,10 +82,8 @@ This will display the Z-Wave related information about the node: * **lastResponseRTT** The Round Trip Time of the response to the last request * **manufacturer_name** The name of the manufacturer, as supplied by OpenZWave * **max_baud_rate** The maximum bandwidth the device supports, most modern devices will support 40,000 or higher -* **new_entity_id** In 0.47, Home Assistant introduced a new naming convention for entities, this shows the new naming convention * **node_id** The unique node ID of this node * **node_name** The base name of this node, this is used to build the entity ID of all entities of this node -* **old_entity_id** If `new_entity_ids: false` has been configured, then this is the entity_id that will be used. Support for this will be removed in the future * **product_name** The product name of the device, as supplied by OpenZWave * **query_stage** The query stage for this device (see [here](/docs/z-wave/query-stage/) for details) * **receivedCnt** The number of messages received from the device @@ -110,6 +108,16 @@ You can use this to enable one device to directly control another. This is prima There may be multiple groups, that are used for different purposes. The manual of your device will explain what each group is for. +#### {% linkable_title Broadcast group %} + +Some Z-Wave devices may associate themselves with the broadcast group (group 255). You'll be able to tell if this has happened if opening a door (or triggering a motion sensor) causes lights to come on, and closing the door (or the motion sensor going clear) causes lights to run off. There's no way to clear this from the control panel, but you can use the `zwave.change_association` service: + +```json +{"association": "remove", "node_id": 3, "group": 1, "target_node_id": 255} +``` + +That would remove the broadcast group from association group 1 of the device with node_id 3. + ### {% linkable_title Node config options %} You can set the *wakeup* interval (in seconds) of the device, this is shown for all devices that can be battery powered, even if they are currently mains powered. The wakeup interval only applies when those devices are battery powered. diff --git a/source/_docs/z-wave/installation.markdown b/source/_docs/z-wave/installation.markdown index 5974c16a20..b3fc38d817 100644 --- a/source/_docs/z-wave/installation.markdown +++ b/source/_docs/z-wave/installation.markdown @@ -77,11 +77,6 @@ debug: required: false type: boolean default: False -new_entity_ids: - description: Switch to new entity_id generation. - required: false - type: boolean - default: True device_config / device_config_domain / device_config_glob: description: This attribute contains node-specific override values. (For releases prior to 0.39 this variable is called **customize**) See [Customizing devices and services](/docs/configuration/customizing-devices/) for the format. required: false @@ -140,7 +135,7 @@ Or, if there is no result, try to find detailed USB connection info with: $ dmesg | grep USB ``` -If Home Assistant (`hass`) runs with another user (e.g. *homeassistant* on Hassbian) give access to the stick with: +If Home Assistant (`hass`) runs with another user (e.g., *homeassistant* on Hassbian) give access to the stick with: ```bash $ sudo usermod -a -G dialout homeassistant @@ -210,7 +205,7 @@ The first run after adding a device is when the `zwave` component will take time ### {% linkable_title Component could not be set up %} -Sometimes the device may not be accessible and you'll get an error message upon startup about not being able to set up Z-Wave. Run the following command for your device path: +Sometimes the device may not be accessible and you'll get an error message upon startup about not being able to set up Z-Wave. Run the following command for your device path (here we're using `/dev/ttyAMA0` for our Razberry board): ```bash $ ls -l /dev/ttyAMA0 @@ -229,6 +224,18 @@ $ sudo chgrp dialout /dev/ttyAMA0 $ sudo chmod g+rw /dev/ttyAMA0 ``` +Check too that the account you're running Home Assistant as is in the `dialout` group. For instance, if you're using `homeassistant`: + +```bash +$ groups homeassistant +``` + +That should include `dialout`, if it doesn't then: + +```bash +$ sudo usermod -G dialout homeassistant +``` + ### {% linkable_title Device path changes %} If your device path changes when you restart, see [this guide](http://hintshop.ludvig.co.nz/show/persistent-names-usb-serial-devices/) on fixing it. diff --git a/source/_docs/z-wave/query-stage.markdown b/source/_docs/z-wave/query-stage.markdown index 2037963e45..7112cd055b 100644 --- a/source/_docs/z-wave/query-stage.markdown +++ b/source/_docs/z-wave/query-stage.markdown @@ -9,6 +9,10 @@ sharing: true footer: true --- +When the Z-Wave mesh is first started, the controller will go through all the following stages for every device on the mesh. This is a slow process, and to complete requires that the devices be awake. While devices that are mains or USB powered are always awake, battery-powered devices spend most of their time asleep. Because of this, you can expect that after startup your battery powered devices will spend time in `Initializing (CacheLoad)` - how long depends on the device. + +Your devices will still function normally while marked as `Initializing`. + | Stage | Description | |------------------------|--------------------------------------------------------------------| | None | Query process hasn't started for this node | @@ -17,7 +21,7 @@ footer: true | WakeUp | Start wake up process if a sleeping node | | ManufacturerSpecific1 | Retrieve manufacturer name and product ids if ProtocolInfo lets us | | NodeInfo | Retrieve info about supported, controlled command classes | -| NodePlusInfo | Retrieve ZWave+ info and update device classes | +| NodePlusInfo | Retrieve Z-Wave+ info and update device classes | | SecurityReport | Retrieve a list of Command Classes that require Security | | ManufacturerSpecific2 | Retrieve manufacturer name and product ids | | Versions | Retrieve version information | diff --git a/source/_docs/z-wave/services.markdown b/source/_docs/z-wave/services.markdown index 0a6499d2d4..b6c420a91b 100644 --- a/source/_docs/z-wave/services.markdown +++ b/source/_docs/z-wave/services.markdown @@ -29,7 +29,7 @@ The `zwave` component exposes multiple services to help maintain the network. Al | remove_failed_node | Remove a failed node from the network. The Node should be on the controller's Failed Node List, otherwise this command will fail. | | replace_failed_node | Replace a failed device with another. If the node is not in the controller's Failed Node List, or the node responds, this command will fail. | | reset_node_meters | Reset a node's meter values. Only works if the node supports this. | -| set_config_parameter | Lets the user set a config parameter to a node. NOTE: Use the parameter option's `label` string as the `value` for list parameters (e.g. `"value": "Off"`). For all other parameters use the relevant integer `value` (e.g. `"value": 1`). | +| set_config_parameter | Lets the user set a config parameter to a node. NOTE: Use the parameter option's `label` string as the `value` for list parameters (e.g., `"value": "Off"`). For all other parameters use the relevant integer `value` (e.g., `"value": 1`). | | soft_reset | Tells the controller to do a "soft reset." This is not supposed to lose any data, but different controllers can behave differently to a "soft reset" command. | | start_network | Starts the Z-Wave network. | | stop_network | Stops the Z-Wave network. | diff --git a/source/_includes/asides/developers_navigation.html b/source/_includes/asides/developers_navigation.html deleted file mode 100644 index 2d770cb7a1..0000000000 --- a/source/_includes/asides/developers_navigation.html +++ /dev/null @@ -1,142 +0,0 @@ -
- {% include edit_github.html %} - -
-

Development Guide

-
    -
  • - {% active_link /developers/ Introduction %} -
      -
    • {% active_link /developers/architecture/ Architecture %}
      • -
    • {% active_link /developers/architecture_components/ Components %}
      • -
    -
    • -
  • - {% active_link /developers/development/ Starting with Development %} -
      -
    • {% active_link /developers/development_environment/ Setting up Environment %}
      • -
    • {% active_link /developers/development_submitting/ Submit your Work %}
      • -
    • {% active_link /developers/development_checklist/ Checklist %}
      • -
    • {% active_link /developers/development_guidelines/ Style guidelines %}
      • -
    • {% active_link /developers/development_testing/ Testing %}
      • -
    • {% active_link /developers/development_catching_up/ Catching up with Reality %}
      • -
    • {% active_link /developers/development_validation/ Validation %}
      • -
    -
    • -
  • - {% active_link /developers/development_101/ Development 101 %} -
      -
    • {% active_link /developers/development_hass_object/ Hass object %}
      • -
    • {% active_link /developers/development_events/ Events %}
      • -
    • {% active_link /developers/development_states/ States %}
      • -
    • {% active_link /developers/development_services/ Services %}
      • -
    • {% active_link /developers/development_config/ Config %}
      • -
    -
    • -
  • - {% active_link /developers/add_new_platform/ Creating a new platform (to support a new device) %} -
      -
    • {% active_link /developers/code_review_platform/ Checklist creating a platform %}
      • -
    • {% active_link /developers/platform_example_sensor/ Example sensor platform %}
      • -
    • {% active_link /developers/platform_example_light/ Example light platform %}
      • -
    -
    • -
  • - {% active_link /developers/creating_components/ Adding a new component %} -
      -
    • {% active_link /developers/code_review_component/ Checklist creating a component %}
      • -
    • {% active_link /developers/component_loading/ Loading components %}
      • -
    • {% active_link /developers/component_deps_and_reqs/ Requirements & Dependencies %}
      • -
    • {% active_link /developers/component_events/ Handling events %}
      • -
    • {% active_link /developers/component_states/ States %}
      • -
    • {% active_link /developers/component_visibility/ Visibility %}
      • -
    • {% active_link /developers/component_generic_discovery/ Loading Platforms %}
      • -
    • {% active_link /developers/component_discovery/ Component Discovery %}
      • -
    -
    • -
  • - {% active_link /developers/intent/ Intents (handling voice responses) %} -
      -
    • {% active_link /developers/intent/firing/ Firing intents %}
      • -
    • {% active_link /developers/intent/handling/ Handling intents %}
      • -
    • {% active_link /developers/intent/conversation/ Registering sentences %}
      • -
    -
    • -
  • - {% active_link /developers/asyncio/ Asynchronous Programming %} -
      -
    • {% active_link /developers/asyncio_101/ Introduction to asyncio %}
      • -
    • {% active_link /developers/asyncio_categorizing_functions/ Categorizing Functions %}
      • -
    • {% active_link /developers/asyncio_working_with_async/ Working with Async %}
      • -
    • {% active_link /developers/asyncio_misc/ Miscellaneous %}
      • -
    -
    • -
  • - {% active_link /developers/frontend/ Frontend Development %} -
      -
    • {% active_link /developers/frontend_add_card/ Add State Card %}
      • -
    • {% active_link /developers/frontend_add_more_info/ Add More Info Dialog %}
      • -
    • {% active_link /developers/frontend_creating_custom_panels/ Add Custom Panels %}
      • -
    • {% active_link /developers/frontend_creating_custom_ui/ Add Custom UI %}
      • -
    -
    • -
  • - {% active_link /developers/internationalization/ Internationalization %} -
      -
    • {% active_link /developers/internationalization/backend_localization/ Backend Localization %}
      • -
    • {% active_link /developers/internationalization/custom_component_localization/ Custom Component Localization %}
      • -
    • {% active_link /developers/internationalization/translation/ Translation %}
      • -
    -
    • -
  • - {% active_link /developers/hassio/architecture/ Hass.io architecture %} -
      -
    • {% active_link /developers/hassio/debugging/ Debugging Hass.io %}
      • -
    -
    • -
  • - {% active_link /developers/hassio/addon_development/ Hass.io Add-on Development %} -
      -
    • {% active_link /developers/hassio/addon_tutorial/ Tutorial: Making your first add-on %}
      • -
    • {% active_link /developers/hassio/addon_config/ Configuration %}
      • -
    • {% active_link /developers/hassio/addon_communication/ Communication %}
      • -
    • {% active_link /developers/hassio/addon_testing/ Local Testing %}
      • -
    • {% active_link /developers/hassio/addon_publishing/ Publishing %}
      • -
    • {% active_link /developers/hassio/addon_presentation/ Presentation %}
      • -
    • {% active_link /developers/hassio/addon_repository/ Repositories %}
      • -
    -
    • -
  • - {% active_link /developers/api/ API %} -
      -
    • {% active_link https://dev-docs.home-assistant.io/en/dev/ Python API %}
      • -
    • {% active_link /developers/websocket_api/ Websocket API %}
      • -
    • {% active_link /developers/rest_api/ REST API %}
      • -
    • {% active_link /developers/python_api/ Python REST API %}
      • -
    • {% active_link /developers/server_sent_events/ Server-sent events %}
      • -
    -
    • -
  • - {% active_link /developers/documentation/ Website/Documentation %} -
      -
    • {% active_link /developers/documentation/standards/ Standards %}
      • -
    • {% active_link /developers/documentation/create_page/ Create a new page %}
      • -
    -
    • -
  • {% active_link /developers/helpers/ Online helpers %}
    • -
  • {% active_link /developers/releasing/ Releasing %}
    • -
  • {% active_link /developers/maintenance/ Maintenance %}
    • -
  • - Governance -
      -
    • {% active_link /developers/cla/ Contributor License Agreement %}
      • -
    • {% active_link /privacy/ Privacy Policy %}
      • -
    • {% active_link /tos/ Terms of Service %}
      • -
    • {% active_link /code_of_conduct/ Code of Conduct %}
      • -
    • {% active_link /developers/credits/ Credits %}
      • -
    • {% active_link /developers/license/ License %}
      • -
    -
    • -
-
-
diff --git a/source/_includes/asides/help_navigation.html b/source/_includes/asides/help_navigation.html new file mode 100644 index 0000000000..458a6a9385 --- /dev/null +++ b/source/_includes/asides/help_navigation.html @@ -0,0 +1,33 @@ +
+ {% include edit_github.html %} + +
+

 

+
    +
  • + {% active_link /help/ Help %} +
    • +
  • + Developer documentation +
    • +
  • + {% active_link /developers/documentation/ Website/Documentation %} +
      +
    • {% active_link /developers/documentation/standards/ Standards %}
      • +
    • {% active_link /developers/documentation/create_page/ Create a new page %}
      • +
    +
    • +
  • + Governance +
      +
    • {% active_link /developers/cla/ Contributor License Agreement %}
      • +
    • {% active_link /privacy/ Privacy Policy %}
      • +
    • {% active_link /tos/ Terms of Service %}
      • +
    • {% active_link /code_of_conduct/ Code of Conduct %}
      • +
    • {% active_link /developers/credits/ Credits %}
      • +
    • {% active_link /developers/license/ License %}
      • +
    +
    • +
+
+
diff --git a/source/_includes/custom/footer.html b/source/_includes/custom/footer.html index b07ee5bcf8..1a2e590320 100644 --- a/source/_includes/custom/footer.html +++ b/source/_includes/custom/footer.html @@ -1,13 +1,27 @@ -
- - - - +
+
+
+ Home Assistant +
+
+ + + + +
+
-
- Contact us at hello@home-assistant.io (no support!).
- Website powered by Jekyll and the Oscalite theme.
+
+ +
+ +
+ Website powered by Jekyll and the + Oscalite theme. Hosted by Netlify.
- Creative Commons License
home-assistant.io is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.
diff --git a/source/_includes/custom/navigation.html b/source/_includes/custom/navigation.html index 1179c86bef..6af93d4b49 100644 --- a/source/_includes/custom/navigation.html +++ b/source/_includes/custom/navigation.html @@ -13,7 +13,6 @@
  • Components
  • Docs
  • Examples
    • -
  • Developers
  • Blog
  • Need help?
    • diff --git a/source/_includes/edit_github.html b/source/_includes/edit_github.html index f599869c81..b5fa2329b8 100644 --- a/source/_includes/edit_github.html +++ b/source/_includes/edit_github.html @@ -1,4 +1,4 @@ {% assign url_parts = page.url | split: '/' %} {% if page.hide_github_edit != true %} -
    Edit this page on GitHub
    +
    Edit this page on GitHub
    {% endif %} diff --git a/source/_includes/site/head.html b/source/_includes/site/head.html index b78976a342..e45b34cb78 100644 --- a/source/_includes/site/head.html +++ b/source/_includes/site/head.html @@ -1,6 +1,6 @@ {% capture fb_description %}{% if page.description %}{{ page.description }}{% endif %}{% endcapture %} {% capture description %}{% if page.description %}{{ page.description }}{% else site.description %}{{ site.description }}{% endif %}{% endcapture %} -{% capture social_image %}{% if page.og_image %}{{ page.og_image | prepend: site.url }}{% else %}https://home-assistant.io/images/default-social.png{% endif %}{% endcapture %} +{% capture social_image %}{% if page.og_image %}{{ page.og_image | prepend: site.url }}{% else %}https://www.home-assistant.io/images/default-social.png{% endif %}{% endcapture %} diff --git a/source/_includes/site/sidebar.html b/source/_includes/site/sidebar.html index 9e2417d29a..6ee8aaf444 100644 --- a/source/_includes/site/sidebar.html +++ b/source/_includes/site/sidebar.html @@ -4,8 +4,8 @@ {% include asides/component_navigation.html | compact_newlines %} {% elsif url_parts[1] == 'cookbook' %} {% include asides/cookbook_navigation.html | compact_newlines %} - {% elsif url_parts[1] == 'developers' %} - {% include asides/developers_navigation.html | compact_newlines %} + {% elsif url_parts[1] == 'developers' or url_parts[1] == 'help' %} + {% include asides/help_navigation.html | compact_newlines %} {% elsif url_parts[1] == 'getting-started' %} {% include asides/getting_started_navigation.html | compact_newlines %} {% elsif url_parts[1] == 'docs' %} diff --git a/source/_layouts/page.html b/source/_layouts/page.html index 946ab88522..cc6ca95b78 100644 --- a/source/_layouts/page.html +++ b/source/_layouts/page.html @@ -7,6 +7,7 @@ layout: default {% if url_parts[1] != 'components' and url_parts[1] != 'cookbook' and url_parts[1] != 'developers' and + url_parts[1] != 'help' and url_parts[1] != 'getting-started' %} {% include edit_github.html %} {% endif %} diff --git a/source/_posts/2015-02-24-streaming-updates.markdown b/source/_posts/2015-02-24-streaming-updates.markdown index 1ade9874f5..88589cc870 100644 --- a/source/_posts/2015-02-24-streaming-updates.markdown +++ b/source/_posts/2015-02-24-streaming-updates.markdown @@ -20,7 +20,7 @@ A new toggle has been added to the sidebar to turn streaming updates on and off. Streaming updates has been implemented using the HTML5 `EventSource` tag. Implementation is pretty straight forward as all the reconnection logic will be handled by the event source tag. The [server-side code](https://github.com/home-assistant/home-assistant/blob/master/homeassistant/components/api.py#L90) is 50 lines and the [client-side code](https://github.com/home-assistant/home-assistant-js/blob/master/src/actions/stream.js) is 80 lines of code. -All events that happen on the server will now also be sent to the browser. This turns any browser running the UI into a fully functioning [slave instance](https://home-assistant.io/developers/architecture/#multiple-connected-instances) of Home Assistant. This opens up new possibilities for Home Assistant components that live completely client-side. +All events that happen on the server will now also be sent to the browser. This turns any browser running the UI into a fully functioning [slave instance](/developers/architecture/#multiple-connected-instances) of Home Assistant. This opens up new possibilities for Home Assistant components that live completely client-side. Implementing EventSource was not without challenges. Here are some of the issues that had to be solved: diff --git a/source/_posts/2015-08-09-mqtt-raspberry-pi-squeezebox-asuswrt-support.markdown b/source/_posts/2015-08-09-mqtt-raspberry-pi-squeezebox-asuswrt-support.markdown index 14d83f6202..2707b3e7f0 100644 --- a/source/_posts/2015-08-09-mqtt-raspberry-pi-squeezebox-asuswrt-support.markdown +++ b/source/_posts/2015-08-09-mqtt-raspberry-pi-squeezebox-asuswrt-support.markdown @@ -104,7 +104,7 @@ sensor: device: PATH_TO_DEVICE ``` -The path to your device, e.g. `/dev/serial/by-id/usb-RFXCOM_RFXtrx433_A1Y0NJGR-if00-port0` +The path to your device, e.g., `/dev/serial/by-id/usb-RFXCOM_RFXtrx433_A1Y0NJGR-if00-port0` __TEMPer temperature sensor support__ Support for Temper temperature sensors has been contributed by [@rkabadi](https://github.com/rkabadi). diff --git a/source/_posts/2015-08-26-laundry-automation-with-moteino-mqtt-and-home-assistant.markdown b/source/_posts/2015-08-26-laundry-automation-with-moteino-mqtt-and-home-assistant.markdown index c904e60a8f..f063627b0f 100644 --- a/source/_posts/2015-08-26-laundry-automation-with-moteino-mqtt-and-home-assistant.markdown +++ b/source/_posts/2015-08-26-laundry-automation-with-moteino-mqtt-and-home-assistant.markdown @@ -49,7 +49,7 @@ Materials used: - [Moteino](https://lowpowerlab.com/moteino/) - [2 x Accelerometers](http://www.amazon.com/gp/product/B008BOPN40) - [2 x Reed switch](http://www.amazon.com/gp/product/B004PARDRO) - - [Home Assistant](https://home-assistant.io/) + - [Home Assistant](/) [Sketch for the Moteino is available here.](https://codebender.cc/sketch:144743) diff --git a/source/_posts/2015-08-31-version-7-revamped-ui-and-improved-distribution.markdown b/source/_posts/2015-08-31-version-7-revamped-ui-and-improved-distribution.markdown index 19ab9e50a6..37178a2d66 100644 --- a/source/_posts/2015-08-31-version-7-revamped-ui-and-improved-distribution.markdown +++ b/source/_posts/2015-08-31-version-7-revamped-ui-and-improved-distribution.markdown @@ -61,12 +61,12 @@ __MQTT Sensors and Switches__ [mqtt-switch]: /components/switch.mqtt/ ```yaml -# Example configuration.yml entr +# Example configuration.yaml entry sensor: platform: mqtt name: "MQTT Sensor" state_topic: "home/bedroom/temperature" - unit_of_measurement: "ºC" + unit_of_measurement: "°C" switch: platform: mqtt diff --git a/source/_posts/2015-09-11-different-ways-to-use-mqtt-with-home-assistant.markdown b/source/_posts/2015-09-11-different-ways-to-use-mqtt-with-home-assistant.markdown index 54b9c76e49..77491b0d0a 100644 --- a/source/_posts/2015-09-11-different-ways-to-use-mqtt-with-home-assistant.markdown +++ b/source/_posts/2015-09-11-different-ways-to-use-mqtt-with-home-assistant.markdown @@ -12,9 +12,9 @@ og_image: /images/blog/2015-09-mqtt/arduino.png {::options coderay_line_numbers="table" /} - [MQTT](https://en.wikipedia.org/wiki/MQTT) support was added to Home Assistant recently. The [MQTT component](https://home-assistant.io/components/mqtt/) will enable you to do all sort of things. Most likely you will use it to communicate with your devices. But Home Assistant doesn't care where the data is coming from or is limited to real hardware as long as there is MQTT support. This means that it doesn't matter if the data is coming from a human, a web service, or a device. + [MQTT](https://en.wikipedia.org/wiki/MQTT) support was added to Home Assistant recently. The [MQTT component](/components/mqtt/) will enable you to do all sort of things. Most likely you will use it to communicate with your devices. But Home Assistant doesn't care where the data is coming from or is limited to real hardware as long as there is MQTT support. This means that it doesn't matter if the data is coming from a human, a web service, or a device. -A great example is shown in a [Laundry Automation](https://home-assistant.io/blog/2015/08/26/laundry-automation-with-moteino-mqtt-and-home-assistant/) post in this blog. +A great example is shown in a [Laundry Automation](/blog/2015/08/26/laundry-automation-with-moteino-mqtt-and-home-assistant/) post in this blog. This post will give you a small overview of some other possibilities on how to use MQTT with Home Assistant. @@ -34,7 +34,7 @@ sensor: state_topic: "home-assistant/fabian/mood" ``` -After a restart of Home Assistant the "Mood" sensor will show up in the frontend. For more details about the configuration of MQTT itself and the sensor, please refer to the [MQTT component](https://home-assistant.io/components/mqtt/) or the [MQTT sensor](https://home-assistant.io/components/sensor.mqtt/) documentation. +After a restart of Home Assistant the "Mood" sensor will show up in the frontend. For more details about the configuration of MQTT itself and the sensor, please refer to the [MQTT component](/components/mqtt/) or the [MQTT sensor](/components/sensor.mqtt/) documentation. Now we can set the mood. The commandline tool (`mosquitto_pub`) which is shipped with `mosquitto` is used to send an MQTT message. diff --git a/source/_posts/2015-11-22-survey-november-2015.markdown b/source/_posts/2015-11-22-survey-november-2015.markdown index 09efee533d..38a84c00a3 100644 --- a/source/_posts/2015-11-22-survey-november-2015.markdown +++ b/source/_posts/2015-11-22-survey-november-2015.markdown @@ -21,7 +21,7 @@ Of course most users are running with the [automation](/getting-started/automati The [Alarm control panels](/components/alarm_control_panel/) and the [camera component](/components/camera/) are both used by around one third of the participants of the survey. It's safe to say that they cover a niche, but they will gain momentum when people discover how they can build alarm systems with Home Assistant. -[Philips Hue](/components/light.hue/) is the "winner" in the light category closely followed by [MQTT lights](components/light.mqtt/). [Google Cast](/components/media_player.cast/) and [ Plex](/components/media_player.plex/) are the top media player platforms. [Pushbullet](/components/notify.pushbullet/) is by far the most-used [notification platform](https://home-assistant.io/components/notify/). If you followed the recent efforts to improve this platform it's comprehensible. +[Philips Hue](/components/light.hue/) is the "winner" in the light category closely followed by [MQTT lights](components/light.mqtt/). [Google Cast](/components/media_player.cast/) and [ Plex](/components/media_player.plex/) are the top media player platforms. [Pushbullet](/components/notify.pushbullet/) is by far the most-used [notification platform](/components/notify/). If you followed the recent efforts to improve this platform it's comprehensible. It's interesting to see that most of the sensor, switch, and thermostat platforms are used. A lot of people seem to be interested in the weather data provided by the [Forecast sensor](/components/sensor.forecast/). The MQTT sensors and switches are deployed in almost 50% of all Home Assistant setups. @@ -86,6 +86,6 @@ It's interesting to see that most of the sensor, switch, and thermostat platform Thermostats

    -The conclusion is that [MQTT](http://mqtt.org/) is popular in almost every section from Alarm Control Panel, presence detection with [owntracks](http://owntracks.org/), sensors and switches, and now even for lights. +The conclusion is that [MQTT](http://mqtt.org/) is popular in almost every section from Alarm Control Panel, presence detection with [owntracks](http://owntracks.org/), sensors and switches, and now even for lights. The interpretation of the data is up to you. Again, thanks for participating in this survey. diff --git a/source/_posts/2016-02-09-Smarter-Smart-Things-with-MQTT-and-Home-Assistant.markdown b/source/_posts/2016-02-09-Smarter-Smart-Things-with-MQTT-and-Home-Assistant.markdown index 2420da0399..a9deb4a4d1 100644 --- a/source/_posts/2016-02-09-Smarter-Smart-Things-with-MQTT-and-Home-Assistant.markdown +++ b/source/_posts/2016-02-09-Smarter-Smart-Things-with-MQTT-and-Home-Assistant.markdown @@ -169,7 +169,7 @@ homeassistant: - mqtt ``` -This will start home-assistant, MQTT, and the Bridge, in dependency order. All config can reference the name of the docker container instead of using IP addresses (e.g. mqtt for the broker host in Home Assistant). +This will start home-assistant, MQTT, and the Bridge, in dependency order. All config can reference the name of the docker container instead of using IP addresses (e.g., mqtt for the broker host in Home Assistant). ### How it works diff --git a/source/_posts/2016-02-28-steam-d-link-smart-plugs-and-neurio-energy-sensors.markdown b/source/_posts/2016-02-28-steam-d-link-smart-plugs-and-neurio-energy-sensors.markdown index 767045c1ab..3822349f8b 100644 --- a/source/_posts/2016-02-28-steam-d-link-smart-plugs-and-neurio-energy-sensors.markdown +++ b/source/_posts/2016-02-28-steam-d-link-smart-plugs-and-neurio-energy-sensors.markdown @@ -69,7 +69,7 @@ It's been another two weeks which means it's time for release: 0.14! [rollershutter.command_line]: /components/rollershutter.command_line/ [Steam]: /components/sensor.steam_online/ [Wink]: /components/binary_sensor.wink/ -[the cookbook]: https://home-assistant.io/cookbook/python_component_simple_alarm/ +[the cookbook]: /cookbook/python_component_simple_alarm/ [script]: /components/script/ [Wemo component]: /components/wemo/ [switch.cmd]: /components/switch.command_line/ diff --git a/source/_posts/2016-04-17-updated-documentation.markdown b/source/_posts/2016-04-17-updated-documentation.markdown index e3ef6cf9a0..ae1c4371f2 100644 --- a/source/_posts/2016-04-17-updated-documentation.markdown +++ b/source/_posts/2016-04-17-updated-documentation.markdown @@ -14,7 +14,7 @@ One of the main complaints that we receive is something along the lines "I read Our documentation has been going through various phases. Initially it was just the README in our GitHub repository. I discovered Jekyll and GitHub pages in December 2014 and created home-assistant.io. I more or less broke the README in 5 pages and [called it a website]. Back then we had a whopping [11 components](https://github.com/home-assistant/home-assistant.io/blob/86bb2df430ce267ab2123d51592d3f068ae509b5/source/components/index.markdown). -As Home Assistant grew, so did our documentation. [Fabian Affolter](https://github.com/fabaff) does an amazing job in making sure there is at least a documentation stub for each new feature that lands. And that's quite a feat given our [frequent releases](https://home-assistant.io/blog/categories/release-notes/)! But despite all the efforts, the documentation outgrew our existing documentation organization. +As Home Assistant grew, so did our documentation. [Fabian Affolter](https://github.com/fabaff) does an amazing job in making sure there is at least a documentation stub for each new feature that lands. And that's quite a feat given our [frequent releases](/blog/categories/release-notes/)! But despite all the efforts, the documentation outgrew our existing documentation organization. Today it has been almost 1.5 years since we started the website. We now have [264 components and platforms] under our belt and have been honored with 1.5 million page views ✨. And hopefully we now also have documentation that our community deserves. diff --git a/source/_posts/2016-04-30-ibeacons-part-1-making-presence-detection-work-better.markdown b/source/_posts/2016-04-30-ibeacons-part-1-making-presence-detection-work-better.markdown index 465e5278a2..8a1a8dae12 100644 --- a/source/_posts/2016-04-30-ibeacons-part-1-making-presence-detection-work-better.markdown +++ b/source/_posts/2016-04-30-ibeacons-part-1-making-presence-detection-work-better.markdown @@ -26,7 +26,7 @@ Luckily, OwnTracks supports iBeacons so I could use them to make presence detect ### {% linkable_title Getting Started %} -To do this you first need to set up [MQTT] and [OwnTracks] in Home assistant - and make sure that HA can track your phone. +To do this you first need to set up [MQTT] and [OwnTracks] in Home Assistant - and make sure that HA can track your phone. [MQTT]: /components/mqtt/#picking-a-broker [OwnTracks]: /components/device_tracker.owntracks/ @@ -57,7 +57,7 @@ Once you’ve created the zone - you need to restart HA. The next step is:- 1. Go to the OwnTracks app on your phone 2. Touch the `Regions` menu at the bottom of the screen 3. Touch the `+` symbol at the top right of the screen -4. Give the beacon a name e.g. `-drive` ’(start the name with a `-` see below for the reason) +4. Give the beacon a name e.g., `-drive` ’(start the name with a `-` see below for the reason) 5. Turn Share to `On` 6. Skip the `Circular Region` section 7. Enter the `UUID` of your beacon - this may be written on your beacon - or you can copy it from the management app that came with your iBeacon device. It’s a long number – so it’s easier to copy if you can! @@ -120,7 +120,7 @@ Presence tracking sounds easy - and it's an important part of Home Automation. T You can find out more about configuring the OwnTracks application and beacons [here](http://owntracks.org/booklet/features/beacons/) -There is information about configuring Homeassistant to use beacons [here](https://home-assistant.io/components/device_tracker.owntracks/) +There is information about configuring Homeassistant to use beacons [here](/components/device_tracker.owntracks/) #### {% linkable_title Connections and disconnecting %} diff --git a/source/_posts/2016-05-18-why-we-use-polymer.markdown b/source/_posts/2016-05-18-why-we-use-polymer.markdown index 8f198665c1..68ff5f74c3 100644 --- a/source/_posts/2016-05-18-why-we-use-polymer.markdown +++ b/source/_posts/2016-05-18-why-we-use-polymer.markdown @@ -40,5 +40,5 @@ So there it is, the reason why we use Polymer. [ha-rn]: https://github.com/balloob/home-assistant-react-native-ios [tools-js]: https://github.com/home-assistant/home-assistant-polymer#building-the-app [material design for free]: https://elements.polymer-project.org/browse?package=paper-elements -[demo]: https://home-assistant.io/demo +[demo]: /demo diff --git a/source/_posts/2016-06-23-usb-webcams-and-home-assistant.markdown b/source/_posts/2016-06-23-usb-webcams-and-home-assistant.markdown index e2d4a191b4..f5bc3669e6 100644 --- a/source/_posts/2016-06-23-usb-webcams-and-home-assistant.markdown +++ b/source/_posts/2016-06-23-usb-webcams-and-home-assistant.markdown @@ -12,7 +12,7 @@ og_image: /images/blog/2016-06-cranberry/social.png --- -In the past month I was thinking about ways to integrate USB webcams into Home Assistant again. The main reason was that this would give those devices a second life and enable one to benefit from low-cost video surveillance. There are a couple of options available like [pygame](http://www.pygame.org/hifi.html) or [SimpleCV](http://www.simplecv.org/) but I never finished something. With the [Local File camera platform](https://home-assistant.io/components/camera.local_file/) by [Landrash](https://github.com/Landrash) and [motion](http://lavrsen.dk/foswiki/bin/view/Motion/WebHome) you could integrate a local USB webcam with a few very easy steps. +In the past month I was thinking about ways to integrate USB webcams into Home Assistant again. The main reason was that this would give those devices a second life and enable one to benefit from low-cost video surveillance. There are a couple of options available like [pygame](http://www.pygame.org/hifi.html) or [SimpleCV](http://www.simplecv.org/) but I never finished something. With the [Local File camera platform](/components/camera.local_file/) by [Landrash](https://github.com/Landrash) and [motion](http://lavrsen.dk/foswiki/bin/view/Motion/WebHome) you could integrate a local USB webcam with a few very easy steps. In this blog post I am using a Fedora 24 (will most likely work on other distributions too) installation with Home Assistant 0.22.1 on a Foxconn nT-330i with an old [Logitech QuickCam Orbit AF](http://support.logitech.com/en_us/product/quickcam-sphere-af) and a [Logitech HD Webcam C270](http://support.logitech.com/en_us/product/hd-webcam-c270). As a start only the Quickcam is used. No multi-camera setup for now. @@ -93,7 +93,7 @@ $ sudo motion [0] [NTC] [ALL] motion_startup: Logging to file (/var/log/motion.log) ``` -Your `target_dir` will start filling up with images from your camera. `motion` will create a symlink called `lastsnap.jpg` which always point to the latest snapshot. We will setup the [Local File camera platform](https://home-assistant.io/components/camera.local_file/) to use this file. +Your `target_dir` will start filling up with images from your camera. `motion` will create a symlink called `lastsnap.jpg` which always point to the latest snapshot. We will setup the [Local File camera platform](/components/camera.local_file/) to use this file. ```yaml camera: @@ -109,7 +109,7 @@ camera: The machine with the attached USB camera will become a webcam server as well because `motion`'s built-in HTTP server is enabled by default. This means that you could connect your USB webcams to a different machine in your network, run `motion` there, adjust your firewall rules, and use Home Assistant to display the videos. Just check http://[IP of your webcam host]:8081/ to see the stream. This required more powerful hardware than using snapshots, of course. -In a scenario like this needs a [Generic MJPEG IP Camera ](https://home-assistant.io/components/camera.mjpeg/) in your `configuration.yaml` file. +In a scenario like this needs a [Generic MJPEG IP Camera ](/components/camera.mjpeg/) in your `configuration.yaml` file. ```yaml camera: diff --git a/source/_posts/2016-07-01-envisalink-homematic-hdmi-cec-and-sony-bravia-tv.markdown b/source/_posts/2016-07-01-envisalink-homematic-hdmi-cec-and-sony-bravia-tv.markdown index 31b5ff35bc..2fa8b44326 100644 --- a/source/_posts/2016-07-01-envisalink-homematic-hdmi-cec-and-sony-bravia-tv.markdown +++ b/source/_posts/2016-07-01-envisalink-homematic-hdmi-cec-and-sony-bravia-tv.markdown @@ -104,4 +104,4 @@ On the config side, you can now [store your passwords][secrets] in your OS keyri [reload core config service]: /getting-started/customizing-devices/#reloading-customize [Sony Bravia TV]: /components/media_player.braviatv/ [Raspberry Pi GPIO pins]: /components/garage_door.rpi_gpio/ -[elevation]: https://home-assistant.io/getting-started/basic/ +[elevation]: /getting-started/basic/ diff --git a/source/_posts/2016-07-06-pocketchip-running-home-assistant.markdown b/source/_posts/2016-07-06-pocketchip-running-home-assistant.markdown index 64ff15761c..266dcda25d 100644 --- a/source/_posts/2016-07-06-pocketchip-running-home-assistant.markdown +++ b/source/_posts/2016-07-06-pocketchip-running-home-assistant.markdown @@ -27,13 +27,13 @@ If you start using a PocketCHIP you will definitely look like a Blackberry or a First a couple of tweaks like setting up `sudo`, upgrading the existing installation, change passwords, enabling ssh, and removal of the annoying stuff then installation of Home Assistant. There is not much to tell...it's straight-forward. For the sake of completeness below the notes about what I did. -A Debian installation is available by default. This means that some dependencies for Home Assistant are missing. I haven't checked if a new build for the PocketCHIP would include them. So, after a `$ sudo apt-get update` installing those dependencies take a minute or two. +A Debian installation is available by default. This means that some dependencies for Home Assistant are missing. I haven't checked if a new build for the PocketCHIP would include them. So, after a `$ sudo apt-get update` installing those dependencies take a minute or two. ```bash $ sudo apt-get install python3-dev python3-pip python3-venv ``` -As usual I run Python applications in a [venv](https://docs.python.org/3/library/venv.html). +As usual I run Python applications in a [venv](https://docs.python.org/3/library/venv.html). ```bash $ pvenv ha @@ -46,14 +46,14 @@ $ cd ha $ source bin/activate ``` -If you haven't seen the next two commands already then you should visit our [frontsite](https://home-assistant.io/). +If you haven't seen the next two commands already then you should visit our [frontsite](/). ```bash $ pip3 install homeassistant $ hass --open-ui ``` -With `surf` the browsing experience on the low-resolution display is not that great. Most smartphones, even very cheap ones, have touchscreens with higher resolutions. Nevermind, [`midori`](https://twitter.com/fabaff/status/748852317047418880) is not better. +With `surf` the browsing experience on the low-resolution display is not that great. Most smartphones, even very cheap ones, have touchscreens with higher resolutions. Nevermind, [`midori`](https://twitter.com/fabaff/status/748852317047418880) is not better.

    diff --git a/source/_posts/2016-07-23-internet-of-things-data-exploration-with-jupyter-notebooks.markdown b/source/_posts/2016-07-23-internet-of-things-data-exploration-with-jupyter-notebooks.markdown index d9d17ba37b..2a7b6c8eef 100644 --- a/source/_posts/2016-07-23-internet-of-things-data-exploration-with-jupyter-notebooks.markdown +++ b/source/_posts/2016-07-23-internet-of-things-data-exploration-with-jupyter-notebooks.markdown @@ -27,7 +27,7 @@ One of the graphs created with this tutorial. _TL; DR: Use [this Jupyter Notebook][nb-prev] to visualize of your data_ -[blog post by Fabian]: https://home-assistant.io/blog/2016/07/19/visualizing-your-iot-data/ +[blog post by Fabian]: /blog/2016/07/19/visualizing-your-iot-data/ [DB Browser for SQLite]: http://sqlitebrowser.org/ [Pandas]: http://pandas.pydata.org/ [matplotlib]: http://matplotlib.org/ diff --git a/source/_posts/2016-08-03-laundry-automation-update.markdown b/source/_posts/2016-08-03-laundry-automation-update.markdown index 983f706279..041659c80d 100644 --- a/source/_posts/2016-08-03-laundry-automation-update.markdown +++ b/source/_posts/2016-08-03-laundry-automation-update.markdown @@ -12,7 +12,7 @@ og_image: /images/blog/2016-07-laundry-automation/protoboard.jpg _This is a guest post by Home Assistant user and contributor [Nolan Gilley](https://github.com/nkgilley)._ -Today I'll show you how I used Home Assistant, a NodeMCU (ESP8266), and a couple of accelerometers to automate our laundry room. This is a rewrite of an [old post](https://home-assistant.io/blog/2015/08/26/laundry-automation-with-moteino-mqtt-and-home-assistant/) where I did the same thing using a Moteino & Raspberry Pi. This version only requires a NodeMCU. +Today I'll show you how I used Home Assistant, a NodeMCU (ESP8266), and a couple of accelerometers to automate our laundry room. This is a rewrite of an [old post](/blog/2015/08/26/laundry-automation-with-moteino-mqtt-and-home-assistant/) where I did the same thing using a Moteino & Raspberry Pi. This version only requires a NodeMCU. We have an older washer and dryer which doesn't have any form of notification when cycles complete. Home Assistant was the obvious solution, I just needed to create sensors for the washer and dryer. I tried using sound sensors but found them unreliable. I ended up using an accelerometer attached to the back of each appliance. I also added magnetic reed switches on the doors of the washer and dryer to detect whether they're open or closed. I connected the accelerometers and reed switches to an NodeMCU which will relay the data to my MQTT broker. diff --git a/source/_posts/2016-08-07-optimizing-the-home-assistant-mobile-web-app.markdown b/source/_posts/2016-08-07-optimizing-the-home-assistant-mobile-web-app.markdown index 3633c42b50..fcb1d762a1 100644 --- a/source/_posts/2016-08-07-optimizing-the-home-assistant-mobile-web-app.markdown +++ b/source/_posts/2016-08-07-optimizing-the-home-assistant-mobile-web-app.markdown @@ -159,7 +159,7 @@ A lot of optimizations have been applied but this journey will never be over. Th - Reduce size of initial bundle by moving out all things that are not visible for initial paint. For example the dialogs that show more info about entities. - Prefetch the other pages using `` -[demo]: https://home-assistant.io/demo +[demo]: /demo [hap]: https://github.com/home-assistant/home-assistant-polymer [mantra]: https://www.youtube.com/watch?v=zfQoleQEa4w&feature=youtu.be&t=1380 [sw-precache]: https://github.com/GoogleChrome/sw-precache diff --git a/source/_posts/2016-08-16-we-have-apps-now.markdown b/source/_posts/2016-08-16-we-have-apps-now.markdown index 6edf3f8f4b..00ee02e460 100644 --- a/source/_posts/2016-08-16-we-have-apps-now.markdown +++ b/source/_posts/2016-08-16-we-have-apps-now.markdown @@ -15,7 +15,7 @@ I have been working on a new subsystem to complement Home Assistant's Automation ## {% linkable_title Another Take on Automation %} -If you haven't yet read Paulus' excellent Blog entry on [Perfect Home Automation](https://home-assistant.io/blog/2016/01/19/perfect-home-automation/) I would encourage you to take a look. As a veteran of several Home Automation systems with varying degrees success, it was this article more than anything else that convinced me that Home Assistant had the right philosophy behind it and was on the right track. One of the most important points made is that being able to control your lights from your phone, 9 times out of 10 is harder than using a lightswitch - where Home Automation really comes into its own is when you start removing the need to use a phone or the switch - the "Automation" in Home Automation. A surprisingly large number of systems out there miss this essential point and have limited abilities to automate anything which is why a robust and open system such as Home Assistant is such an important part of the equation to bring this all together in the vast and chaotic ecosystem that is the "Internet of Things". +If you haven't yet read Paulus' excellent Blog entry on [Perfect Home Automation](/blog/2016/01/19/perfect-home-automation/) I would encourage you to take a look. As a veteran of several Home Automation systems with varying degrees success, it was this article more than anything else that convinced me that Home Assistant had the right philosophy behind it and was on the right track. One of the most important points made is that being able to control your lights from your phone, 9 times out of 10 is harder than using a lightswitch - where Home Automation really comes into its own is when you start removing the need to use a phone or the switch - the "Automation" in Home Automation. A surprisingly large number of systems out there miss this essential point and have limited abilities to automate anything which is why a robust and open system such as Home Assistant is such an important part of the equation to bring this all together in the vast and chaotic ecosystem that is the "Internet of Things". So given the importance of Automation, what should Automation allow us to do? I am a pragmatist at heart so I judge individual systems by the ease of accomplishing a few basic but representative tasks: @@ -32,7 +32,7 @@ So why `AppDaemon`? `AppDaemon` is not meant to replace Home Assistant Automatio - New paradigm - some problems require a procedural and/or iterative approach, and `AppDaemon` Apps are a much more natural fit for this. Recent enhancements to Home Assistant scripts and templates have made huge strides, but for the most complex scenarios, Apps can do things that Automations can't - Ease of use - `AppDaemon`'s API is full of helper functions that make programming as easy and natural as possible. The functions and their operation are as "Pythonic" as possible, experienced Python programmers should feel right at home. -- Reuse - write a piece of code once and instantiate it as an app as many times as you need with different parameters e.g. a motion light program that you can use in 5 different places around your home. The code stays the same, you just dynamically add new instances of it in the config file +- Reuse - write a piece of code once and instantiate it as an app as many times as you need with different parameters e.g., a motion light program that you can use in 5 different places around your home. The code stays the same, you just dynamically add new instances of it in the config file - Dynamic - `AppDaemon` has been designed from the start to enable the user to make changes without requiring a restart of Home Assistant, thanks to its loose coupling. However, it is better than that - the user can make changes to code and `AppDaemon` will automatically reload the code, figure out which Apps were using it and restart them to use the new code without the need to restart `AppDaemon` itself. It is also possible to change parameters for an individual or multiple apps and have them picked up dynamically, and for a final trick, removing or adding apps is also picked up dynamically. Testing cycles become a lot more efficient as a result. - Complex logic - Python's If/Else constructs are clearer and easier to code for arbitrarily complex nested logic - Durable variables and state - variables can be kept between events to keep track of things like the number of times a motion sensor has been activated, or how long it has been since a door opened @@ -77,12 +77,12 @@ class MotionLights(appapi.AppDaemon): def initialize(self): self.listen_state(self.motion, "binary_sensor.drive", new = "on") - + def motion(self, entity, attribute, old, new, kwargs): if self.sun_down(): self.turn_on("light.drive") self.run_in(self.light_off, 60) - + def light_off(self, kwargs): self.turn_off("light.drive") ``` @@ -98,17 +98,17 @@ class FlashyMotionLights(appapi.AppDaemon): def initialize(self): self.listen_state(self.motion, "binary_sensor.drive", new = "on") - + def motion(self, entity, attribute, old, new, kwargs): if self.self.sun_down(): self.turn_on("light.drive") self.run_in(self.light_off, 60) self.flashcount = 0 self.run_in(self.flash_warning, 1) - + def light_off(self, kwargs): self.turn_off("light.drive") - + def flash_warning(self, kwargs): self.toggle("light.living_room") self.flashcount += 1 diff --git a/source/_posts/2016-10-22-flash-briefing-updater-hacktoberfest.markdown b/source/_posts/2016-10-22-flash-briefing-updater-hacktoberfest.markdown index e102f164bb..b1c417b1a3 100644 --- a/source/_posts/2016-10-22-flash-briefing-updater-hacktoberfest.markdown +++ b/source/_posts/2016-10-22-flash-briefing-updater-hacktoberfest.markdown @@ -204,7 +204,7 @@ This is super annoying, I know, especially since we had said in [0.12][zero-one- - The [HTTP] component now takes a different format for authenticating IPs - Configuration format has changed for [Proximity] - - The [Arduino] platform are now covered by the configuration check. Please check the documentation to see how. + - The [Arduino] platform are now covered by the configuration check. Please check the documentation to see how. - The Z-Wave entity ID change mentioned above ## {% linkable_title If you need help... %} @@ -264,40 +264,40 @@ Thanks for reading all of the above, especially since this week was a pretty lon [@vittoriom]: https://github.com/vittoriom [@wokar]: https://github.com/wokar -[Arduino]: https://home-assistant.io/components/arduino/ -[APNS]: https://home-assistant.io/components/notify.apns/ -[ARWN]: https://home-assistant.io/components/sensor.arwn/ -[Concord232]: https://home-assistant.io/components/alarm_control_panel.concord232/ -[HTTP]: https://home-assistant.io/components/http/ -[HaveIBeenPwned]: https://home-assistant.io/components/sensor.haveibeenpwned/ -[Matrix]: https://home-assistant.io//components/notify.matrix/ -[Neato]: https://home-assistant.io/components/switch.neato/ -[Pilight]: https://home-assistant.io/components/sensor.pilight/ -[Proximity]: https://home-assistant.io/components/proximity/ +[Arduino]: /components/arduino/ +[APNS]: /components/notify.apns/ +[ARWN]: /components/sensor.arwn/ +[Concord232]: /components/alarm_control_panel.concord232/ +[HTTP]: /components/http/ +[HaveIBeenPwned]: /components/sensor.haveibeenpwned/ +[Matrix]: //components/notify.matrix/ +[Neato]: /components/switch.neato/ +[Pilight]: /components/sensor.pilight/ +[Proximity]: /components/proximity/ [PyPi]: https://pypi.python.org/pypi -[Synology]: https://home-assistant.io/components/camera.synology/ -[Telstra]: https://home-assistant.io/components/notify.telstra/ +[Synology]: /components/camera.synology/ +[Telstra]: /components/notify.telstra/ [UUID]: https://en.wikipedia.org/wiki/Universally_unique_identifier -[Verisure]: https://home-assistant.io/components/camera.verisure/ -[WUnderground]: https://home-assistant.io/components/sensor.wunderground/ -[Yamaha]: https://home-assistant.io/components/media_player.yamaha/ -[Zoneminder]: https://home-assistant.io/components/zoneminder/ -[emoncms]: https://home-assistant.io//components/emoncms_history/ -[filtering]: https://home-assistant.io/components/logbook/ -[flash-briefing-docs]: https://home-assistant.io/components/alexa/ +[Verisure]: /components/camera.verisure/ +[WUnderground]: /components/sensor.wunderground/ +[Yamaha]: /components/media_player.yamaha/ +[Zoneminder]: /components/zoneminder/ +[emoncms]: //components/emoncms_history/ +[filtering]: /components/logbook/ +[flash-briefing-docs]: /components/alexa/ [hacktoberfest-blog]: /blog/2016/10/02/hacktoberfest/ [hacktoberfest-ha-prs]: https://github.com/home-assistant/home-assistant/labels/Hacktoberfest [hacktoberfest-site-prs]: https://github.com/home-assistant/home-assistant.github.io/labels/Hacktoberfest [hacktoberfest-website]: https://hacktoberfest.digitalocean.com/ [logo]: /images/blog/2016-10-hacktoberfest/hacktoberfest.png -[min]: https://home-assistant.io/components/sensor.min_max/ -[netatmo-bin]: https://home-assistant.io/components/binary_sensor.netatmo/ -[netatmo-discovery]: https://home-assistant.io/components/netatmo/ -[nmap]: https://home-assistant.io/components/device_tracker.nmap_tracker/ -[pers-notify]: https://home-assistant.io/components/persistent_notification/ +[min]: /components/sensor.min_max/ +[netatmo-bin]: /components/binary_sensor.netatmo/ +[netatmo-discovery]: /components/netatmo/ +[nmap]: /components/device_tracker.nmap_tracker/ +[pers-notify]: /components/persistent_notification/ [runway]: http://runway.is -[scrape]: https://home-assistant.io/components/sensor.scrape/ -[updater]: https://home-assistant.io/components/updater/ +[scrape]: /components/sensor.scrape/ +[updater]: /components/updater/ [z-wave-issue]: https://github.com/home-assistant/home-assistant/pull/3759 [zero-one-two-release]: /blog/2016/01/30/insteon-lifx-twitter-and-zigbee/#backwards-incompatible-changes [zero-two-seven-release]: /blog/2016/08/28/notifications-hue-fake-unification/ diff --git a/source/_posts/2016-11-05-hacktoberfest-influxdb-weather.markdown b/source/_posts/2016-11-05-hacktoberfest-influxdb-weather.markdown index 91d7b7844d..4cc4f06944 100644 --- a/source/_posts/2016-11-05-hacktoberfest-influxdb-weather.markdown +++ b/source/_posts/2016-11-05-hacktoberfest-influxdb-weather.markdown @@ -20,7 +20,7 @@ The [Hacktoberfest] is over now. Home Assistant made the 2nd and the 3rd place o This release has improved the reporting when a config validation error occurs. Thanks to [@kellerza] you will now get a persistent notification added to your UI when this happens. ### {% linkable_title Asynchronous %} -This release contains the first asynchronous sensor and camera platforms. [@pvizeli] and [@fabaff] ported most of the "internal" sensors to async programming. We hope that you will enjoy the new speed. +This release contains the first asynchronous sensor and camera platforms. [@pvizeli] and [@fabaff] ported most of the "internal" sensors to async programming. We hope that you will enjoy the new speed. [@balloob] and [@pvizeli] worked a lot on the improvement of the core itself. @@ -41,7 +41,7 @@ For a long time we have had a bunch of [weather sensors][weather-sensors] but it - Sensor: Monitoring support for [Dovado routers][dovado-sensor] ([@molobrakos]) - Sensor: Support for monitoring [printers][cups-sensor] ([@fabaff]) - Add mochad component ([@mtreinish]) -- Notify: Added support for [Android TV/FireTV](https://home-assistant.io/components/notify.nfandroidtv/) - Sensor: New finance platform [CurrencyLayer][currencylayer] ([@arsaboo]) +- Notify: Added support for [Android TV/FireTV](/components/notify.nfandroidtv/) - Sensor: New finance platform [CurrencyLayer][currencylayer] ([@arsaboo]) - Sensor: Support for [InfluxDB sensors][influx-sensor] ([@bestlibre]) - Sensor: New support [HDDTemp sensors][hddtemp-sensor] ([@fabaff]) ([@danielperna84]) @@ -105,8 +105,8 @@ We've added a warning to 0.32 to catch platforms accidentally slowing down Home Our website has now an additional category called "Ecosystem". This will become the place where tools, apps, and other helper for the Home Assistant ecosystem can store their documentation or guides. -- [iOS](https://home-assistant.io/ecosystem/ios/) -- [SceneGen](https://home-assistant.io/ecosystem/scenegen/) +- [iOS](/ecosystem/ios/) +- [SceneGen](/ecosystem/scenegen/) ### {% linkable_title Breaking changes %} @@ -162,30 +162,30 @@ Our website has now an additional category called "Ecosystem". This will become [@jnewland]: https://github.com/jnewland [@DanielHiversen]: https://github.com/DanielHiversen -[currencylayer]: https://home-assistant.io/components/sensor.currencylayer/ -[yahoo]: https://home-assistant.io/components/sensor.yahoo_finance/ -[mochat]: https://home-assistant.io/components/mochat/ -[firetv]: https://home-assistant.io/components/notify.firetv/ -[Yamaha]: https://home-assistant.io/components/media_player.yamaha/ -[hddtemp-sensor]: https://home-assistant.io/components/sensor.hddtemp/ -[Sonos]: https://home-assistant.io/components/media_player.sonos/ -[weather-sensors]: https://home-assistant.io/components/#weather -[rpi-camera]: https://home-assistant.io/components/camera.rpi_camera/ -[rest-switch]: https://home-assistant.io/components/switch.rest/ -[emby-media]: https://home-assistant.io/components/media_player.emby/ -[random-sensor]: https://home-assistant.io/components/sensor.random/ -[yeelight]: https://home-assistant.io/components/light.yeelight/ -[influx-sensor]: https://home-assistant.io/components/sensor.influxdb/ -[weather-component]: https://home-assistant.io/components/weather/ -[cups-sensor]: https://home-assistant.io/components/sensor.cups/ -[litejet]: https://home-assistant.io/components/litejet/ -[garadget]: https://home-assistant.io/components/garadget/ -[philips_player]: https://home-assistant.io/components/media_player.philips_js/ -[icloud]: https://home-assistant.io/components/device_tracker.icloud/ -[synologydsm]: https://home-assistant.io/components/sensor.synologydsm/ -[dovado-sensor]: https://home-assistant.io/components/sensor.dovado/ -[ios]: https://home-assistant.io/ecosystem/ios/ +[currencylayer]: /components/sensor.currencylayer/ +[yahoo]: /components/sensor.yahoo_finance/ +[mochat]: /components/mochat/ +[firetv]: /components/notify.firetv/ +[Yamaha]: /components/media_player.yamaha/ +[hddtemp-sensor]: /components/sensor.hddtemp/ +[Sonos]: /components/media_player.sonos/ +[weather-sensors]: /components/#weather +[rpi-camera]: /components/camera.rpi_camera/ +[rest-switch]: /components/switch.rest/ +[emby-media]: /components/media_player.emby/ +[random-sensor]: /components/sensor.random/ +[yeelight]: /components/light.yeelight/ +[influx-sensor]: /components/sensor.influxdb/ +[weather-component]: /components/weather/ +[cups-sensor]: /components/sensor.cups/ +[litejet]: /components/litejet/ +[garadget]: /components/garadget/ +[philips_player]: /components/media_player.philips_js/ +[icloud]: /components/device_tracker.icloud/ +[synologydsm]: /components/sensor.synologydsm/ +[dovado-sensor]: /components/sensor.dovado/ +[ios]: /ecosystem/ios/ [Hacktoberfest]: https://hacktoberfest.digitalocean.com/ [req-insteon]: https://github.com/home-assistant/home-assistant/issues/3811 -[updater]: https://home-assistant.io/blog/2016/10/25/explaining-the-updater/ -[thingspeak]: https://home-assistant.io/components/thingspeak/ +[updater]: /blog/2016/10/25/explaining-the-updater/ +[thingspeak]: /components/thingspeak/ diff --git a/source/_posts/2016-12-03-remote-websockets-sonarr.markdown b/source/_posts/2016-12-03-remote-websockets-sonarr.markdown index 64511f0eb0..1c9ca273f8 100644 --- a/source/_posts/2016-12-03-remote-websockets-sonarr.markdown +++ b/source/_posts/2016-12-03-remote-websockets-sonarr.markdown @@ -173,7 +173,7 @@ Experiencing issues introduced by this release? Please report them in our [issue [@joncar]: https://github.com/joncar [@kellerza]: https://github.com/kellerza [@Khabi]: https://github.com/Khabi -[@lichtteil]: https://github.com/lichtteil +[@lichtteil]: https://github.com/lichtteil [@LinuxChristian]: https://github.com/LinuxChristian [@lwis]: https://github.com/lwis [@magicus]: https://github.com/magicus @@ -205,27 +205,27 @@ Experiencing issues introduced by this release? Please report them in our [issue [@vemek]: https://github.com/vemek [@vkorn]: https://github.com/vkorn -[amcrest]: https://home-assistant.io/components/camera.amcrest/ -[boradlink]: https://home-assistant.io/components/sensor.broadlink/ -[dsmr]: https://home-assistant.io/components/sensor.dsmr/ -[dunehd]: https://home-assistant.io/components/media_player.dunehd/ -[efergy]: https://home-assistant.io/components/sensor.efergy/ -[filtering]: https://home-assistant.io/components/http/ -[gpslogger]: https://home-assistant.io/components/device_tracker.gpslogger/ -[harmony]: https://home-assistant.io/components/remote.harmony/ -[homematic]: https://home-assistant.io/components/homematic/ -[hook]: https://home-assistant.io/components/switch.hook/ -[nest-cam]: https://home-assistant.io/components/camera.nest/ -[nest]: https://home-assistant.io/components/nest/ -[nginx]: https://home-assistant.io/ecosystem/nginx/ -[nut]: https://home-assistant.io/components/sensor.nut/ -[philips]: https://home-assistant.io/components/media_player.philips_js/ -[remote]: https://home-assistant.io/components/remote/ -[rfxtrx]: https://home-assistant.io/components/rfxtrx/ -[sonarr]: https://home-assistant.io/components/sensor.sonarr/ -[tellstick]: https://home-assistant.io/components/tellstick/ -[temper]: https://home-assistant.io/components/sensor.temper/ -[threshold]: https://home-assistant.io/components/binary_sensor.threshold/ -[websockets]: https://home-assistant.io/developers/websocket_api/ -[waqi]: https://home-assistant.io/components/sensor.waqi/ +[amcrest]: /components/camera.amcrest/ +[boradlink]: /components/sensor.broadlink/ +[dsmr]: /components/sensor.dsmr/ +[dunehd]: /components/media_player.dunehd/ +[efergy]: /components/sensor.efergy/ +[filtering]: /components/http/ +[gpslogger]: /components/device_tracker.gpslogger/ +[harmony]: /components/remote.harmony/ +[homematic]: /components/homematic/ +[hook]: /components/switch.hook/ +[nest-cam]: /components/camera.nest/ +[nest]: /components/nest/ +[nginx]: /ecosystem/nginx/ +[nut]: /components/sensor.nut/ +[philips]: /components/media_player.philips_js/ +[remote]: /components/remote/ +[rfxtrx]: /components/rfxtrx/ +[sonarr]: /components/sensor.sonarr/ +[tellstick]: /components/tellstick/ +[temper]: /components/sensor.temper/ +[threshold]: /components/binary_sensor.threshold/ +[websockets]: /developers/websocket_api/ +[waqi]: /components/sensor.waqi/ diff --git a/source/_posts/2016-12-17-text-to-speech-aquostv-flic-zamg.markdown b/source/_posts/2016-12-17-text-to-speech-aquostv-flic-zamg.markdown index 2f4697f628..8122118124 100644 --- a/source/_posts/2016-12-17-text-to-speech-aquostv-flic-zamg.markdown +++ b/source/_posts/2016-12-17-text-to-speech-aquostv-flic-zamg.markdown @@ -30,7 +30,7 @@ Let you control [VLC media player][vlc-media] and play sound on connected speak This Broadlink [switch][bl-switch] platform allow to you control Broadlink RM2 Pro and RM mini IR+RF devices. This Broadlink [sensor][bl-sensor] platform adds support for Broadlink RM2 and A1 Devices. -The [GPSLogger](https://home-assistant.io/components/device_tracker.gpslogger/) now also supports attributes as the speed, direction, altitude, provider, and activity. +The [GPSLogger](/components/device_tracker.gpslogger/) now also supports attributes as the speed, direction, altitude, provider, and activity. ## {% linkable_title All changes %} - Media player: Support for Sharp [AquaosTV][aquostv] ([@titilambert]) @@ -86,7 +86,7 @@ http: - Fix async component update on service calls ([@pvizeli]) - Fix async log handle do not close ([@pvizeli]) - Fix nest component with various KeyError exceptions ([@technicalpickles]) - + ### {% linkable_title If you need help... %} ...don't hesitate to use our [Forum](https://community.home-assistant.io/) or join us for a little [chat][discord]. The release notes have comments enabled but it's preferred if you use the former communication channels. Thanks. @@ -141,16 +141,16 @@ Experiencing issues introduced by this release? Please report them in our [issue [@turbokongen]: https://github.com/turbokongen [@w1ll1am23]: https://github.com/w1ll1am23 -[vlc-media]: https://home-assistant.io/components/media_player.vlc/ -[aquostv]: https://home-assistant.io/components/media_player.aquostv/ -[digitalloggers]: https://home-assistant.io/components/switch.digitalloggers/ -[netdata]: https://home-assistant.io/components/sensor.netdata/ -[bl-sensor]: https://home-assistant.io/components/sensor.broadlink/ -[bl-switch]: https://home-assistant.io/components/switch.broadlink/ -[hikvision]: https://home-assistant.io/components/binary_sensor.hikvision/ -[zamg]: https://home-assistant.io/components/sensor.zamg/ -[flic]: https://home-assistant.io/components/binary_sensor.flic/ -[sensehat]: https://home-assistant.io/components/sensor.sensehat/ -[tts]: https://home-assistant.io/components/tts/ +[vlc-media]: /components/media_player.vlc/ +[aquostv]: /components/media_player.aquostv/ +[digitalloggers]: /components/switch.digitalloggers/ +[netdata]: /components/sensor.netdata/ +[bl-sensor]: /components/sensor.broadlink/ +[bl-switch]: /components/switch.broadlink/ +[hikvision]: /components/binary_sensor.hikvision/ +[zamg]: /components/sensor.zamg/ +[flic]: /components/binary_sensor.flic/ +[sensehat]: /components/sensor.sensehat/ +[tts]: /components/tts/ [discord]: https://discord.gg/c5DvZ4e [discord-devs]: https://discord.gg/8X8DTH4 diff --git a/source/_posts/2016-12-19-thank-you.markdown b/source/_posts/2016-12-19-thank-you.markdown index b91eb72494..cbdc2a6d45 100644 --- a/source/_posts/2016-12-19-thank-you.markdown +++ b/source/_posts/2016-12-19-thank-you.markdown @@ -29,7 +29,7 @@ We're taking a well deserved break and we will be back again in 2017 with more a – Paulus -[0.10]: https://home-assistant.io/blog/2015/12/22/amazon-echo-icloud-and-templates/ +[0.10]: /blog/2015/12/22/amazon-echo-icloud-and-templates/ [AppFolio]: http://www.appfolioinc.com/ [GitHub]: https://GitHub.com [TravisCI]: https://Travis-ci.org diff --git a/source/_posts/2017-01-14-iss-usps-images-packages.markdown b/source/_posts/2017-01-14-iss-usps-images-packages.markdown index 11a2b2fe71..3b6623e680 100644 --- a/source/_posts/2017-01-14-iss-usps-images-packages.markdown +++ b/source/_posts/2017-01-14-iss-usps-images-packages.markdown @@ -162,34 +162,34 @@ Experiencing issues introduced by this release? Please report them in our [issue [@webworxshop]: https://github.com/webworxshop [@Zac-HD]: https://github.com/Zac-HD -[apns]: https://home-assistant.io/components/notify.apns/ -[beaglebone]: https://home-assistant.io/components/bbb_gpio/ -[bl-switch]: https://home-assistant.io/components/switch.broadlink/ -[bom]: https://home-assistant.io/components/weather.bom/ -[dublin]: https://home-assistant.io/components/sensor.dublin_public_transport/ -[facebook]: https://home-assistant.io/components/notify.facebook/ -[image]: https://home-assistant.io/components/image_processing/ -[influx]: https://home-assistant.io/components/influxdb/ -[insteon]: https://home-assistant.io/components/insteon_local/ -[iss]: https://home-assistant.io/components/sensor.iss/ -[kankun]: https://home-assistant.io/components/switch.kankun/ -[lannouncer]: https://home-assistant.io/components/notify.lannouncer/ -[mysensors]: https://home-assistant.io/components/notify.mysensors/ -[packages]: https://home-assistant.io/topics/packages/ -[pico]: https://home-assistant.io/components/tts.picotts/ -[ping]: https://home-assistant.io/components/device_tracker.ping/ -[plates]: https://home-assistant.io/components/openalpr/ -[quebec]: https://home-assistant.io/components/sensor.hydroquebec/ -[rest]: https://home-assistant.io/components/rest_command/ -[sma]: https://home-assistant.io/components/sensor.sma/ -[sonarr]: https://home-assistant.io/components/sensor.sonarr/ -[tik]: https://home-assistant.io/components/light.tikteck/ -[trackr]: https://home-assistant.io/components/device_tracker.trackr/ -[upc]: https://home-assistant.io/components/device_tracker.upc_connect/ -[usps]: https://home-assistant.io/components/sensor.usps/ -[wink-fan]: https://home-assistant.io/components/fan.wink/ -[xiaomi]: https://home-assistant.io/components/device_tracker.xiaomi/ -[yandex]: https://home-assistant.io/components/tts.yandextts/ -[yeelight]: https://home-assistant.io/components/light.yeelight/ -[zengge]: https://home-assistant.io/components/light.zengge/ +[apns]: /components/notify.apns/ +[beaglebone]: /components/bbb_gpio/ +[bl-switch]: /components/switch.broadlink/ +[bom]: /components/weather.bom/ +[dublin]: /components/sensor.dublin_public_transport/ +[facebook]: /components/notify.facebook/ +[image]: /components/image_processing/ +[influx]: /components/influxdb/ +[insteon]: /components/insteon_local/ +[iss]: /components/sensor.iss/ +[kankun]: /components/switch.kankun/ +[lannouncer]: /components/notify.lannouncer/ +[mysensors]: /components/notify.mysensors/ +[packages]: /topics/packages/ +[pico]: /components/tts.picotts/ +[ping]: /components/device_tracker.ping/ +[plates]: /components/openalpr/ +[quebec]: /components/sensor.hydroquebec/ +[rest]: /components/rest_command/ +[sma]: /components/sensor.sma/ +[sonarr]: /components/sensor.sonarr/ +[tik]: /components/light.tikteck/ +[trackr]: /components/device_tracker.trackr/ +[upc]: /components/device_tracker.upc_connect/ +[usps]: /components/sensor.usps/ +[wink-fan]: /components/fan.wink/ +[xiaomi]: /components/device_tracker.xiaomi/ +[yandex]: /components/tts.yandextts/ +[yeelight]: /components/light.yeelight/ +[zengge]: /components/light.zengge/ diff --git a/source/_posts/2017-01-28-face-coffee-wink.markdown b/source/_posts/2017-01-28-face-coffee-wink.markdown index 26d05a6d94..4a4f572ebf 100644 --- a/source/_posts/2017-01-28-face-coffee-wink.markdown +++ b/source/_posts/2017-01-28-face-coffee-wink.markdown @@ -15,7 +15,7 @@ og_image: /images/blog/2017-01-0.37/social.png No stats, no numbers, and alike this time. Ok, just one number: 0.37. We are back on track with our bi-weekly release cycle. Beside some organizational changes is this release shipping again cool features and new integrations. Please keep an eye on the "Breaking changes" section because there are also massive improvements for some platforms and components. ### {% linkable_title Governance %} -As announced, the new [Governance][gov] requires for developers to sign the CLA. [Code of Conduct][coc], [Contributor License Agreement][cla], and proper [Licensing][license] will to protect all involved parties in the Home Assistant eco-system from users and community members to contributors. +As announced, the new [Governance][gov] requires for developers to sign the CLA. [Code of Conduct][coc], [Contributor License Agreement][cla], and proper [Licensing][license] will to protect all involved parties in the Home Assistant eco-system from users and community members to contributors. ### {% linkable_title Face recognition using the Microsoft Face API %} [@pvizeli] has been on a roll with the image processing integrations. This time it's the [Microsoft Face API][face]. This means that now it will be possible to train the API with the people you want to recognize and send images from your camera to the API as another source of automation. @@ -34,7 +34,7 @@ Although the old method is not insecure, the new method is a lot more secure. Up ### {% linkable_title Major Wink and HDMI CEC improvements %} [@w1ll1am23] did an amazing job fixing a ton of bugs and issues with the Wink integration. Biggest improvement is that it now is able to automatically refresh the authentication tokens. This means that if you have your email address and password in your `configuration.yaml` file, no `client_id` and `client_secret` are needed, and token which was generated with the generator located in the [Wink][wink] documentation. -The new Wink support will cause renaming of all the binary sensors and will also create new sensors for devices that weren't previously detected or supported in the older version. +The new Wink support will cause renaming of all the binary sensors and will also create new sensors for devices that weren't previously detected or supported in the older version. Thanks to [@konikvranik] the [HDMI CEC][cec] integration got a huge update with a lot of improvements. This update should make it easier to work with HDMI CEC and give you more control. @@ -229,35 +229,35 @@ Experiencing issues introduced by this release? Please report them in our [issue [@mKeRix]: https://github.com/mKeRix [@fakezeta]: https://github.com/fakezeta -[amcrest]: https://home-assistant.io/components/binary_sensor.amcrest/ -[discord]: https://home-assistant.io/components/notify.discord/ -[tado]: https://home-assistant.io/components/device_tracker.tado/ -[sky]: https://home-assistant.io/components/device_tracker.sky_hub/ -[zabbix]: https://home-assistant.io/components/zabbix/ -[avion]: https://home-assistant.io/components/light.avion/ -[anthem]: https://home-assistant.io/components/media_player.anthemav/ -[bb-bin]: https://home-assistant.io/components/binary_sensor.bbb_gpio/ -[piglow]: https://home-assistant.io/components/light.piglow/ -[wsdot]: https://home-assistant.io/components/sensor.wsdot/ -[skybeacon]: https://home-assistant.io/components/sensor.skybeacon/ -[lutron]: https://home-assistant.io/components/lutron/ -[polly]: https://home-assistant.io/components/tts.amazon_polly/ -[linksys]: https://home-assistant.io/components/device_tracker.linksys_ap/ -[emul-hue]: https://home-assistant.io/components/emulated_hue/ -[netatmo]: https://home-assistant.io/components/netatmo/ -[face]: https://home-assistant.io/components/microsoft_face/ -[iss]: https://home-assistant.io/components/binary_sensor.iss/ -[roku]: https://home-assistant.io/components/media_player.roku/ -[openalpr]: https://home-assistant.io/components/#image-processing -[image]: https://home-assistant.io/components/image_processing/ +[amcrest]: /components/binary_sensor.amcrest/ +[discord]: /components/notify.discord/ +[tado]: /components/device_tracker.tado/ +[sky]: /components/device_tracker.sky_hub/ +[zabbix]: /components/zabbix/ +[avion]: /components/light.avion/ +[anthem]: /components/media_player.anthemav/ +[bb-bin]: /components/binary_sensor.bbb_gpio/ +[piglow]: /components/light.piglow/ +[wsdot]: /components/sensor.wsdot/ +[skybeacon]: /components/sensor.skybeacon/ +[lutron]: /components/lutron/ +[polly]: /components/tts.amazon_polly/ +[linksys]: /components/device_tracker.linksys_ap/ +[emul-hue]: /components/emulated_hue/ +[netatmo]: /components/netatmo/ +[face]: /components/microsoft_face/ +[iss]: /components/binary_sensor.iss/ +[roku]: /components/media_player.roku/ +[openalpr]: /components/#image-processing +[image]: /components/image_processing/ [emul_hue]: https://github.com/home-assistant/home-assistant/pull/5549 -[coc]: https://home-assistant.io/developers/code_of_conduct/ -[cla]: https://home-assistant.io/developers/cla/ -[gov]: https://home-assistant.io/blog/2017/01/21/home-assistant-governance/ -[license]: https://home-assistant.io/developers/license/ -[wink]: https://home-assistant.io/components/wink/ -[coffee]: https://home-assistant.io/components/switch.wemo/ -[cec]: https://home-assistant.io/components/hdmi_cec/ -[mysensors]: https://home-assistant.io/components/mysensors/ -[sonos]: https://home-assistant.io/components/media_player.sonos/ -[twilio]: https://home-assistant.io/components/notify.twilio_call/ +[coc]: /developers/code_of_conduct/ +[cla]: /developers/cla/ +[gov]: /blog/2017/01/21/home-assistant-governance/ +[license]: /developers/license/ +[wink]: /components/wink/ +[coffee]: /components/switch.wemo/ +[cec]: /components/hdmi_cec/ +[mysensors]: /components/mysensors/ +[sonos]: /components/media_player.sonos/ +[twilio]: /components/notify.twilio_call/ diff --git a/source/_posts/2017-02-11-alert-appletv-mqtt-yeelight.markdown b/source/_posts/2017-02-11-alert-appletv-mqtt-yeelight.markdown index 89a1b2a1eb..1c71005ad4 100644 --- a/source/_posts/2017-02-11-alert-appletv-mqtt-yeelight.markdown +++ b/source/_posts/2017-02-11-alert-appletv-mqtt-yeelight.markdown @@ -196,36 +196,36 @@ Experiencing issues introduced by this release? Please report them in our [issue [@w1ll1am23]: https://github.com/w1ll1am23 [@Yannic-HAW]: https://github.com/Yannic-HAW -[alert]: https://home-assistant.io/components/alert/ -[apiai]: https://home-assistant.io/components/apiai/ -[apple-tv]: https://home-assistant.io/components/media_player.apple_tv/ -[arwn]: https://home-assistant.io/components/sensor.arwn/ -[custom-ui]: https://home-assistant.io/developers/frontend_creating_custom_ui/ -[discovery]: https://home-assistant.io/components/discovery/ -[face-detect]: https://home-assistant.io/components/image_processing.microsoft_face_detect/ -[ffmpeg-bin]: https://home-assistant.io/components/binary_sensor.ffmpeg/ -[ffmpeg]: https://home-assistant.io/components/ffmpeg/ -[filters]: https://home-assistant.io/topics/templating/#home-assistant-template-extensions -[fritz]: https://home-assistant.io/components/switch.fritzdect/ -[hue]: https://home-assistant.io/components/light.hue/ -[light]: https://home-assistant.io/cookbook/custom_ui_by_andrey-git -[mailgun]: https://home-assistant.io/components/notify.mailgun/ -[media-player]: https://home-assistant.io/components/media_player/ -[moon]: https://home-assistant.io/components/sensor.moon/ -[mqtt-discovery]: https://home-assistant.io/components/mqtt/#discovery -[nuki]: https://home-assistant.io/components/lock.nuki/ -[openevse]: https://home-assistant.io/components/sensor.openevse/ -[orange]: https://home-assistant.io/components/media_player.liveboxplaytv/ -[owm]: https://home-assistant.io/components/sensor.openweathermap/ +[alert]: /components/alert/ +[apiai]: /components/apiai/ +[apple-tv]: /components/media_player.apple_tv/ +[arwn]: /components/sensor.arwn/ +[custom-ui]: /developers/frontend_creating_custom_ui/ +[discovery]: /components/discovery/ +[face-detect]: /components/image_processing.microsoft_face_detect/ +[ffmpeg-bin]: /components/binary_sensor.ffmpeg/ +[ffmpeg]: /components/ffmpeg/ +[filters]: /topics/templating/#home-assistant-template-extensions +[fritz]: /components/switch.fritzdect/ +[hue]: /components/light.hue/ +[light]: /cookbook/custom_ui_by_andrey-git +[mailgun]: /components/notify.mailgun/ +[media-player]: /components/media_player/ +[moon]: /components/sensor.moon/ +[mqtt-discovery]: /components/mqtt/#discovery +[nuki]: /components/lock.nuki/ +[openevse]: /components/sensor.openevse/ +[orange]: /components/media_player.liveboxplaytv/ +[owm]: /components/sensor.openweathermap/ [python-yeelight]: https://gitlab.com/stavros/python-yeelight -[qnap]: https://home-assistant.io/components/sensor.qnap/ -[rflink]: https://home-assistant.io/components/rflink/ -[systemmonitor]: https://home-assistant.io/components/sensor.systemmonitor/ -[webostv]: https://home-assistant.io/components/media_player.webostv/ -[yeelight]: https://home-assistant.io/components/light.yeelight/ +[qnap]: /components/sensor.qnap/ +[rflink]: /components/rflink/ +[systemmonitor]: /components/sensor.systemmonitor/ +[webostv]: /components/media_player.webostv/ +[yeelight]: /components/light.yeelight/ -[event-stream-api]: https://home-assistant.io/developers/server_sent_events/ +[event-stream-api]: /developers/server_sent_events/ [forum]: https://community.home-assistant.io/ [issue]: https://github.com/home-assistant/home-assistant/issues -[websocket-api]: https://home-assistant.io/developers/websocket_api/ +[websocket-api]: /developers/websocket_api/ [discord]: https://discord.gg/c5DvZ4e diff --git a/source/_posts/2017-02-25-config-panel-and-state-restoration.markdown b/source/_posts/2017-02-25-config-panel-and-state-restoration.markdown index e92643be51..846bc1ac4e 100644 --- a/source/_posts/2017-02-25-config-panel-and-state-restoration.markdown +++ b/source/_posts/2017-02-25-config-panel-and-state-restoration.markdown @@ -285,33 +285,33 @@ Experiencing issues introduced by this release? Please report them in our [issue [@kitcorey]: https://github.com/kitcorey [@andersonshatch]: https://github.com/andersonshatch -[telegram]: https://home-assistant.io/componet/telegram_webhooks/ -[pushsafer]: https://home-assistant.io/components/notify.pushsafer/ -[openhome]: https://home-assistant.io/components/media_player.openhome/ -[ups]: https://home-assistant.io/components/sensor.ups/ -[fedex]: https://home-assistant.io/components/sensor.fedex/ -[fido]: https://home-assistant.io/components/sensor.fido/ -[gstreamer]: https://home-assistant.io/components/media_player.gstreamer/ -[clementine]: https://home-assistant.io/components/media_player.clementine/ -[ebox]: https://home-assistant.io/components/sensor.ebox/ -[aurora]: https://home-assistant.io/components/binary_sensor.aurora/ -[netmonitor]: https://home-assistant.io/components/sensor.fritzbox_netmonitor/ -[itach]: https://home-assistant.io/components/remote.itach/ -[sunflowers]: https://home-assistant.io/components/light.yeelightsunflower/ -[kodi]: https://home-assistant.io/components/media_player.kodi/ -[myq]: https://home-assistant.io/components/cover.myq/ -[oemt]: https://home-assistant.io/components/climate.oem/ -[volvo]: https://home-assistant.io/components/volvooncall/ -[pocket]: https://home-assistant.io/components/sensor.pocketcasts/ -[config]: https://home-assistant.io/components/config/ -[history_stats]: https://home-assistant.io/components/sensor.history_stats/ +[telegram]: /componet/telegram_webhooks/ +[pushsafer]: /components/notify.pushsafer/ +[openhome]: /components/media_player.openhome/ +[ups]: /components/sensor.ups/ +[fedex]: /components/sensor.fedex/ +[fido]: /components/sensor.fido/ +[gstreamer]: /components/media_player.gstreamer/ +[clementine]: /components/media_player.clementine/ +[ebox]: /components/sensor.ebox/ +[aurora]: /components/binary_sensor.aurora/ +[netmonitor]: /components/sensor.fritzbox_netmonitor/ +[itach]: /components/remote.itach/ +[sunflowers]: /components/light.yeelightsunflower/ +[kodi]: /components/media_player.kodi/ +[myq]: /components/cover.myq/ +[oemt]: /components/climate.oem/ +[volvo]: /components/volvooncall/ +[pocket]: /components/sensor.pocketcasts/ +[config]: /components/config/ +[history_stats]: /components/sensor.history_stats/ -[docs]: https://home-assistant.io/docs/ -[getting-started]: https://home-assistant.io/getting-started/ +[docs]: /docs/ +[getting-started]: /getting-started/ [docs-issue]: https://github.com/home-assistant/home-assistant.github.io/issues/1603 [forum]: https://community.home-assistant.io/ [issue]: https://github.com/home-assistant/home-assistant/issues -[t-shirt]: https://home-assistant.io/blog/2017/02/22/home-assistant-tshirts-have-arrived/ +[t-shirt]: /blog/2017/02/22/home-assistant-tshirts-have-arrived/ [discord]: https://discord.gg/c5DvZ4e diff --git a/source/_posts/2017-03-11-repurpose-any-android-phone-as-ip-camera.markdown b/source/_posts/2017-03-11-repurpose-any-android-phone-as-ip-camera.markdown index 2f495e99ab..d633146e60 100644 --- a/source/_posts/2017-03-11-repurpose-any-android-phone-as-ip-camera.markdown +++ b/source/_posts/2017-03-11-repurpose-any-android-phone-as-ip-camera.markdown @@ -312,7 +312,7 @@ Hot fix release to fix dependency issues. More detailed information about the is [forum]: https://community.home-assistant.io/ [issue]: https://github.com/home-assistant/home-assistant/issues [EFF]: https://www.eff.org -[hass-shirt]: https://home-assistant.io/blog/2017/02/22/home-assistant-tshirts-have-arrived/ +[hass-shirt]: /blog/2017/02/22/home-assistant-tshirts-have-arrived/ [#6532]: https://github.com/home-assistant/home-assistant/pull/6532 [#6552]: https://github.com/home-assistant/home-assistant/pull/6552 [#6574]: https://github.com/home-assistant/home-assistant/pull/6574 diff --git a/source/_posts/2017-03-25-todo-volumio-workday.markdown b/source/_posts/2017-03-25-todo-volumio-workday.markdown index acac7c9f5f..c0ebd7f9e6 100644 --- a/source/_posts/2017-03-25-todo-volumio-workday.markdown +++ b/source/_posts/2017-03-25-todo-volumio-workday.markdown @@ -11,10 +11,10 @@ categories: Release-Notes og_image: /images/blog/2017-03-0.41/social.png --- -Welcome to 0.41. There was a lot going on in the last two weeks. Not only from the code side but also from the social one of Home Assistant. [Paulus][@balloob] did an [interview] with [OpenSourceCraft], [Fabian][@fabaff] did a [workshop] at the [Chemnitzer Linux Tage][clt], and we are now an award-winning Open source project (I will cover that in a separate blog post). +Welcome to 0.41. There was a lot going on in the last two weeks. Not only from the code side but also from the social one of Home Assistant. [Paulus][@balloob] did an [interview] with [OpenSourceCraft], [Fabian][@fabaff] did a [workshop] at the [Chemnitzer Linux Tage][clt], and we are now an award-winning Open source project (I will cover that in a separate blog post). ## Plex -[@JesseWebDotCom] made massive changes to the [Plex][plex] media player platform. From better metadata support over new configuration options to improved controls and non-controllable clients. +[@JesseWebDotCom] made massive changes to the [Plex][plex] media player platform. From better metadata support over new configuration options to improved controls and non-controllable clients. ## Component overview The [Components][components] overview is now powered by search/filtering feature. This will make it faster to get the component/platform you are looking for more quickly. Thanks again, [@bdurrer] for this. @@ -334,16 +334,16 @@ Experiencing issues introduced by this release? Please report them in our [issue [@wmalgadey]: https://github.com/wmalgadey [@yeralin]: https://github.com/yeralin -[components]: https://home-assistant.io/components/ -[kodi]: https://home-assistant.io/components/notify.kodi/ -[mpd]: https://home-assistant.io/components/media_player.mpd/ -[emby]: https://home-assistant.io/components/media_player.emby/ -[mqtt]: https://home-assistant.io/docs/mqtt/ -[plex]: https://home-assistant.io/components/media_player.plex/ -[tado]: https://home-assistant.io/components/climate.tado/ -[volumio]: https://home-assistant.io//components/media_player.volumio/ -[workday]: https://home-assistant.io/components/binary_sensor.workday/ -[android]: https://home-assistant.io/components/android_ip_webcam/ +[components]: /components/ +[kodi]: /components/notify.kodi/ +[mpd]: /components/media_player.mpd/ +[emby]: /components/media_player.emby/ +[mqtt]: /docs/mqtt/ +[plex]: /components/media_player.plex/ +[tado]: /components/climate.tado/ +[volumio]: //components/media_player.volumio/ +[workday]: /components/binary_sensor.workday/ +[android]: /components/android_ip_webcam/ [shadow]: https://www.w3.org/TR/shadow-dom/ [forum]: https://community.home-assistant.io/ @@ -351,7 +351,7 @@ Experiencing issues introduced by this release? Please report them in our [issue [discord]: https://discord.gg/c5DvZ4e [@bdurrer]: https://github.com/bdurrer -[interview]: https://home-assistant.io/blog/2017/03/23/opensourcecraft-interview-with-founder-paulus-schoutsen/ +[interview]: /blog/2017/03/23/opensourcecraft-interview-with-founder-paulus-schoutsen/ [OpenSourceCraft]: http://codepop.com/open-sourcecraft [clt]: https://chemnitzer.linux-tage.de/2017/en/ [workshop]: https://github.com/home-assistant/home-assistant-assets/tree/master/german/2017-clt-workshop diff --git a/source/_posts/2017-03-28-http-to-mqtt-bridge.markdown b/source/_posts/2017-03-28-http-to-mqtt-bridge.markdown index 8e05ea0fa2..07cc25a196 100644 --- a/source/_posts/2017-03-28-http-to-mqtt-bridge.markdown +++ b/source/_posts/2017-03-28-http-to-mqtt-bridge.markdown @@ -20,7 +20,7 @@ The app could be hosted on any Node.js hosting. I prefer [Heroku: Cloud Applicat ### {% linkable_title Bringing pieces together %} -1. Configure the Home Assistant [MQTT trigger](https://home-assistant.io/docs/automation/trigger/#mqtt-trigger). +1. Configure the Home Assistant [MQTT trigger](/docs/automation/trigger/#mqtt-trigger). 1. Configure [CloudMQTT](https://www.cloudmqtt.com/). Check this [video tutorial](https://www.youtube.com/watch?v=VaWdvVVYU3A) for details. 1. [![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/petkov/http_to_mqtt) HTTP to MQTT bridge app. 1. Add the [Configuration Variables](https://devcenter.heroku.com/articles/config-vars#setting-up-config-vars-for-a-deployed-application) to your Heroku app mentioned here. diff --git a/source/_posts/2017-04-17-ikea-tradfri-internet-of-things-done-right.markdown b/source/_posts/2017-04-17-ikea-tradfri-internet-of-things-done-right.markdown index 60b1ab239f..d44d60a79f 100644 --- a/source/_posts/2017-04-17-ikea-tradfri-internet-of-things-done-right.markdown +++ b/source/_posts/2017-04-17-ikea-tradfri-internet-of-things-done-right.markdown @@ -126,15 +126,15 @@ As it currently stands, this is going to be the perfect companion hardware to wo [tradfri]: http://www.ikea.com/us/en/catalog/categories/departments/lighting/36812/ [mjg59]: http://mjg59.dreamwidth.org/47803.html [hue-support]: https://developers.meethue.com/content/philips-hue-and-ikea-tr%C3%A5dfri#comment-2686 -[perfect]: https://home-assistant.io/blog/2016/01/19/perfect-home-automation/#you-should-not-have-to-adapt-to-technology +[perfect]: /blog/2016/01/19/perfect-home-automation/#you-should-not-have-to-adapt-to-technology [Patrik]: https://github.com/ggravlingen [forums]: https://community.home-assistant.io/t/ikea-tradfri-gateway-zigbee/14788 [pytradfri]: https://github.com/ggravlingen/pytradfri [rumors]: https://github.com/bwssytems/ha-bridge/issues/570#issuecomment-293505087 [Homebridge]: https://github.com/nfarina/homebridge [hb-hass]: https://github.com/home-assistant/homebridge-homeassistant -[emulated_hue]: https://home-assistant.io/components/emulated_hue/ -[apiai]: https://home-assistant.io/components/apiai/ +[emulated_hue]: /components/emulated_hue/ +[apiai]: /components/apiai/ [Haaska]: https://github.com/auchter/haaska [great marketing material]: https://i2.wp.com/blog.smartthings.com/wp-content/uploads/2014/06/summer-vacay-683x405-blog.png?fit=683%2C405&ssl=1 -[classification]: https://home-assistant.io/blog/2016/02/12/classifying-the-internet-of-things/ +[classification]: /blog/2016/02/12/classifying-the-internet-of-things/ diff --git a/source/_posts/2017-04-22-ikea-tradfri--spotify.markdown b/source/_posts/2017-04-22-ikea-tradfri--spotify.markdown index 64f0b02ab0..ea172859d0 100644 --- a/source/_posts/2017-04-22-ikea-tradfri--spotify.markdown +++ b/source/_posts/2017-04-22-ikea-tradfri--spotify.markdown @@ -495,14 +495,14 @@ Experiencing issues introduced by this release? Please report them in our [issue [#7267]: https://github.com/home-assistant/home-assistant/pull/7267 [#7287]: https://github.com/home-assistant/home-assistant/pull/7287 [@KlaasH]: https://github.com/KlaasH -[cover.zwave docs]: https://home-assistant.io/components/cover.zwave/ -[recorder docs]: https://home-assistant.io/components/recorder/ -[switch.hook docs]: https://home-assistant.io/components/switch.hook/ -[switch.wemo docs]: https://home-assistant.io/components/switch.wemo/ -[telegram_bot docs]: https://home-assistant.io/components/telegram_bot/ -[telegram_bot.webhooks docs]: https://home-assistant.io/components/telegram_bot.webhooks/ -[wemo docs]: https://home-assistant.io/components/wemo/ -[zwave.workaround docs]: https://home-assistant.io/components/zwave.workaround/ +[cover.zwave docs]: /components/cover.zwave/ +[recorder docs]: /components/recorder/ +[switch.hook docs]: /components/switch.hook/ +[switch.wemo docs]: /components/switch.wemo/ +[telegram_bot docs]: /components/telegram_bot/ +[telegram_bot.webhooks docs]: /components/telegram_bot.webhooks/ +[wemo docs]: /components/wemo/ +[zwave.workaround docs]: /components/zwave.workaround/ [#7271]: https://github.com/home-assistant/home-assistant/pull/7271 [#7282]: https://github.com/home-assistant/home-assistant/pull/7282 [#7290]: https://github.com/home-assistant/home-assistant/pull/7290 @@ -513,9 +513,9 @@ Experiencing issues introduced by this release? Please report them in our [issue [#7324]: https://github.com/home-assistant/home-assistant/pull/7324 [#7329]: https://github.com/home-assistant/home-assistant/pull/7329 [#7337]: https://github.com/home-assistant/home-assistant/pull/7337 -[device_tracker.automatic docs]: https://home-assistant.io/components/device_tracker.automatic/ -[hassio docs]: https://home-assistant.io/components/hassio/ -[notify.html5 docs]: https://home-assistant.io/components/notify.html5/ -[notify.telegram docs]: https://home-assistant.io/components/notify.telegram/ -[telegram_bot.polling docs]: https://home-assistant.io/components/telegram_bot.polling/ +[device_tracker.automatic docs]: /components/device_tracker.automatic/ +[hassio docs]: /components/hassio/ +[notify.html5 docs]: /components/notify.html5/ +[notify.telegram docs]: /components/notify.telegram/ +[telegram_bot.polling docs]: /components/telegram_bot.polling/ [discord]: https://discord.gg/c5DvZ4e diff --git a/source/_posts/2017-04-24-hardware-contest-2017.markdown b/source/_posts/2017-04-24-hardware-contest-2017.markdown index 083eb12242..0a1b08123f 100644 --- a/source/_posts/2017-04-24-hardware-contest-2017.markdown +++ b/source/_posts/2017-04-24-hardware-contest-2017.markdown @@ -22,7 +22,7 @@ The voting is now open. To keep things simple are we using the voting feature of End of the voting period: April, 30 2017 - 23.59 UTC -[hardware]: https://home-assistant.io/blog/2017/04/01/thomas-krenn-award/ +[hardware]: /blog/2017/04/01/thomas-krenn-award/ [award]: https://www.thomas-krenn.com/de/tkmag/allgemein/zammad-home-assistant-und-freifunk-das-sind-die-gewinner-des-thomas-krenn-awards-2017/ [forum]: https://community.home-assistant.io/c/contest-2017 [twitter]: https://twitter.com/home_assistant diff --git a/source/_posts/2017-04-25-influxdb-grafana-docker.markdown b/source/_posts/2017-04-25-influxdb-grafana-docker.markdown index 184028eaa4..75cdd440c1 100644 --- a/source/_posts/2017-04-25-influxdb-grafana-docker.markdown +++ b/source/_posts/2017-04-25-influxdb-grafana-docker.markdown @@ -11,7 +11,7 @@ categories: How-To og_image: /images/blog/2017-04-influxdb-grafana/influxdb-grafana-ha.png --- -Home Assistant collects volumes of (time series) data that are well suited for some fancy graphs. Although the [History](https://home-assistant.io/components/history/) component provides some nice plots, I am sure you have always wanted those fancy [Grafana](https://grafana.com/) plots. The problem, however, is that low-powered device such as Raspberry Pi that most of us use for our Home Assistant setup are not well suited for such operation. +Home Assistant collects volumes of (time series) data that are well suited for some fancy graphs. Although the [History](/components/history/) component provides some nice plots, I am sure you have always wanted those fancy [Grafana](https://grafana.com/) plots. The problem, however, is that low-powered device such as Raspberry Pi that most of us use for our Home Assistant setup are not well suited for such operation. Instead of running [InfluxDB](https://www.influxdata.com/) and Grafana on a Raspberry Pi or a different system and go through the [classic approach of installing both tools separately](/blog/2015/12/07/influxdb-and-grafana/), you can run them in a Docker container on another machine. For this tutorial, I am using a Synology NAS, but the instructions should apply to other devices that can run Docker. Just follow the steps below: diff --git a/source/_posts/2017-05-01-home-assistant-on-raspberry-pi-zero-in-30-minutes.markdown b/source/_posts/2017-05-01-home-assistant-on-raspberry-pi-zero-in-30-minutes.markdown index ce60a7e8bc..28434d3642 100644 --- a/source/_posts/2017-05-01-home-assistant-on-raspberry-pi-zero-in-30-minutes.markdown +++ b/source/_posts/2017-05-01-home-assistant-on-raspberry-pi-zero-in-30-minutes.markdown @@ -15,7 +15,7 @@ og_image: /images/blog/2017-05-hassbian-pi-zero/home_assistant_plus_rpi_600x315.

    -Saw the [announcement](/blog/2017/04/30/hassbian-1.21-its-about-time/) yesterday for HASSbian 1.21 and got super excited? +Saw the [announcement](/blog/2017/04/30/hassbian-1.21-its-about-time/) yesterday for HASSbian 1.21 and got super excited? Today we'll flash the latest HASSbian to a [Raspberry Pi Zero W](https://www.raspberrypi.org/products/pi-zero/). **With an added bonus** that besides for an USB cable for power, there's no need for any cables! @@ -33,9 +33,9 @@ First, download the HASSbian 1.21 image from [here](https://github.com/home-assi Unzip it. -Flash it to the microSD card. If you need a flash tool, try [Etcher](https://etcher.io/) +Flash it to the microSD card. If you need a flash tool, try [Etcher](https://etcher.io/) -When the flashing finishes, remove it and plug it back in. You should see a drive called "boot". +When the flashing finishes, remove it and plug it back in. You should see a drive called "boot". Right in there, not in any folders, create a file called `wpa_supplicant.conf`. @@ -67,5 +67,5 @@ Wait about 15-20 minutes and voilà you have your Home Assistant on your Raspber To try it out, go to [http://hassbian:8123](http://hassbian:8123) or [http://hassbian.local:8123](http://hassbian.local:8123) if you're using Mac. -For further details about HASSbian, take a look at the [documentation](https://home-assistant.io/docs/hassbian/). +For further details about HASSbian, take a look at the [documentation](/docs/hassbian/). diff --git a/source/_posts/2017-05-06-zigbee-opencv-dlib.markdown b/source/_posts/2017-05-06-zigbee-opencv-dlib.markdown index b0e98c7e94..4e87ac92fd 100644 --- a/source/_posts/2017-05-06-zigbee-opencv-dlib.markdown +++ b/source/_posts/2017-05-06-zigbee-opencv-dlib.markdown @@ -413,91 +413,91 @@ influxdb: [@wokar]: https://github.com/wokar [@wuub]: https://github.com/wuub [@zeltom]: https://github.com/zeltom -[binary_sensor.alarmdecoder docs]: https://home-assistant.io/components/binary_sensor.alarmdecoder/ -[binary_sensor.eight_sleep docs]: https://home-assistant.io/components/binary_sensor.eight_sleep/ -[binary_sensor.maxcube docs]: https://home-assistant.io/components/binary_sensor.maxcube/ -[binary_sensor.octoprint docs]: https://home-assistant.io/components/binary_sensor.octoprint/ -[binary_sensor.pilight docs]: https://home-assistant.io/components/binary_sensor.pilight/ -[binary_sensor.ping docs]: https://home-assistant.io/components/binary_sensor.ping/ -[binary_sensor.workday docs]: https://home-assistant.io/components/binary_sensor.workday/ -[binary_sensor.zha docs]: https://home-assistant.io/components/binary_sensor.zha/ -[camera.netatmo docs]: https://home-assistant.io/components/camera.netatmo/ -[climate docs]: https://home-assistant.io/components/climate/ -[climate.ecobee docs]: https://home-assistant.io/components/climate.ecobee/ -[climate.maxcube docs]: https://home-assistant.io/components/climate.maxcube/ -[climate.zwave docs]: https://home-assistant.io/components/climate.zwave/ -[cover.garadget docs]: https://home-assistant.io/components/cover.garadget/ -[cover.opengarage docs]: https://home-assistant.io/components/cover.opengarage/ -[cover.zwave docs]: https://home-assistant.io/components/cover.zwave/ -[device_tracker.automatic docs]: https://home-assistant.io/components/device_tracker.automatic/ -[device_tracker.zha docs]: https://home-assistant.io/components/device_tracker.zha/ -[ecobee docs]: https://home-assistant.io/components/ecobee/ -[eight_sleep docs]: https://home-assistant.io/components/eight_sleep/ -[enocean docs]: https://home-assistant.io/components/enocean/ -[homematic docs]: https://home-assistant.io/components/homematic/ -[image_processing.dlib_face_detect docs]: https://home-assistant.io/components/image_processing.dlib_face_detect/ -[image_processing.dlib_face_identify docs]: https://home-assistant.io/components/image_processing.dlib_face_identify/ -[image_processing.microsoft_face_detect docs]: https://home-assistant.io/components/image_processing.microsoft_face_detect/ -[image_processing.opencv docs]: https://home-assistant.io/components/image_processing.opencv/ -[joaoapps_join docs]: https://home-assistant.io/components/joaoapps_join/ -[light docs]: https://home-assistant.io/components/light/ -[light.avion docs]: https://home-assistant.io/components/light.avion/ -[light.blinkt docs]: https://home-assistant.io/components/light.blinkt/ -[light.decora docs]: https://home-assistant.io/components/light.decora/ -[light.flux_led docs]: https://home-assistant.io/components/light.flux_led/ -[light.hue docs]: https://home-assistant.io/components/light.hue/ -[light.lifx docs]: https://home-assistant.io/components/light.lifx/ -[light.osramlightify docs]: https://home-assistant.io/components/light.osramlightify/ -[light.piglow docs]: https://home-assistant.io/components/light.piglow/ -[light.sensehat docs]: https://home-assistant.io/components/light.sensehat/ -[light.tradfri docs]: https://home-assistant.io/components/light.tradfri/ -[light.zha docs]: https://home-assistant.io/components/light.zha/ -[light.zwave docs]: https://home-assistant.io/components/light.zwave/ -[maxcube docs]: https://home-assistant.io/components/maxcube/ -[media_player docs]: https://home-assistant.io/components/media_player/ -[media_player.spotify docs]: https://home-assistant.io/components/media_player.spotify/ -[media_player.webostv docs]: https://home-assistant.io/components/media_player.webostv/ -[mqtt docs]: https://home-assistant.io/components/mqtt/ -[notify.html5 docs]: https://home-assistant.io/components/notify.html5/ -[notify.instapush docs]: https://home-assistant.io/components/notify.instapush/ -[notify.joaoapps_join docs]: https://home-assistant.io/components/notify.joaoapps_join/ -[notify.mailgun docs]: https://home-assistant.io/components/notify.mailgun/ -[notify.matrix docs]: https://home-assistant.io/components/notify.matrix/ -[notify.smtp docs]: https://home-assistant.io/components/notify.smtp/ -[notify.telegram docs]: https://home-assistant.io/components/notify.telegram/ -[notify.webostv docs]: https://home-assistant.io/components/notify.webostv/ -[nuimo_controller docs]: https://home-assistant.io/components/nuimo_controller/ -[octoprint docs]: https://home-assistant.io/components/octoprint/ -[opencv docs]: https://home-assistant.io/components/opencv/ -[plant docs]: https://home-assistant.io/components/plant/ -[recorder docs]: https://home-assistant.io/components/recorder/ -[rfxtrx docs]: https://home-assistant.io/components/rfxtrx/ -[rss_feed_template docs]: https://home-assistant.io/components/rss_feed_template/ -[sensor.cert_expiry docs]: https://home-assistant.io/components/sensor.cert_expiry/ -[sensor.dht docs]: https://home-assistant.io/components/sensor.dht/ -[sensor.eight_sleep docs]: https://home-assistant.io/components/sensor.eight_sleep/ -[sensor.envirophat docs]: https://home-assistant.io/components/sensor.envirophat/ -[sensor.ios docs]: https://home-assistant.io/components/sensor.ios/ -[sensor.lyft docs]: https://home-assistant.io/components/sensor.lyft/ -[sensor.pushbullet docs]: https://home-assistant.io/components/sensor.pushbullet/ -[sensor.speedtest docs]: https://home-assistant.io/components/sensor.speedtest/ -[sensor.thinkingcleaner docs]: https://home-assistant.io/components/sensor.thinkingcleaner/ -[sensor.vera docs]: https://home-assistant.io/components/sensor.vera/ -[sensor.zamg docs]: https://home-assistant.io/components/sensor.zamg/ -[sensor.zha docs]: https://home-assistant.io/components/sensor.zha/ -[switch.flux docs]: https://home-assistant.io/components/switch.flux/ -[switch.hook docs]: https://home-assistant.io/components/switch.hook/ -[switch.thinkingcleaner docs]: https://home-assistant.io/components/switch.thinkingcleaner/ -[switch.wemo docs]: https://home-assistant.io/components/switch.wemo/ -[switch.zha docs]: https://home-assistant.io/components/switch.zha/ -[telegram_bot docs]: https://home-assistant.io/components/telegram_bot/ -[telegram_bot.polling docs]: https://home-assistant.io/components/telegram_bot.polling/ -[telegram_bot.webhooks docs]: https://home-assistant.io/components/telegram_bot.webhooks/ -[updater docs]: https://home-assistant.io/components/updater/ -[vera docs]: https://home-assistant.io/components/vera/ -[wemo docs]: https://home-assistant.io/components/wemo/ -[wink docs]: https://home-assistant.io/components/wink/ -[zha docs]: https://home-assistant.io/components/zha/ +[binary_sensor.alarmdecoder docs]: /components/binary_sensor.alarmdecoder/ +[binary_sensor.eight_sleep docs]: /components/binary_sensor.eight_sleep/ +[binary_sensor.maxcube docs]: /components/binary_sensor.maxcube/ +[binary_sensor.octoprint docs]: /components/binary_sensor.octoprint/ +[binary_sensor.pilight docs]: /components/binary_sensor.pilight/ +[binary_sensor.ping docs]: /components/binary_sensor.ping/ +[binary_sensor.workday docs]: /components/binary_sensor.workday/ +[binary_sensor.zha docs]: /components/binary_sensor.zha/ +[camera.netatmo docs]: /components/camera.netatmo/ +[climate docs]: /components/climate/ +[climate.ecobee docs]: /components/climate.ecobee/ +[climate.maxcube docs]: /components/climate.maxcube/ +[climate.zwave docs]: /components/climate.zwave/ +[cover.garadget docs]: /components/cover.garadget/ +[cover.opengarage docs]: /components/cover.opengarage/ +[cover.zwave docs]: /components/cover.zwave/ +[device_tracker.automatic docs]: /components/device_tracker.automatic/ +[device_tracker.zha docs]: /components/device_tracker.zha/ +[ecobee docs]: /components/ecobee/ +[eight_sleep docs]: /components/eight_sleep/ +[enocean docs]: /components/enocean/ +[homematic docs]: /components/homematic/ +[image_processing.dlib_face_detect docs]: /components/image_processing.dlib_face_detect/ +[image_processing.dlib_face_identify docs]: /components/image_processing.dlib_face_identify/ +[image_processing.microsoft_face_detect docs]: /components/image_processing.microsoft_face_detect/ +[image_processing.opencv docs]: /components/image_processing.opencv/ +[joaoapps_join docs]: /components/joaoapps_join/ +[light docs]: /components/light/ +[light.avion docs]: /components/light.avion/ +[light.blinkt docs]: /components/light.blinkt/ +[light.decora docs]: /components/light.decora/ +[light.flux_led docs]: /components/light.flux_led/ +[light.hue docs]: /components/light.hue/ +[light.lifx docs]: /components/light.lifx/ +[light.osramlightify docs]: /components/light.osramlightify/ +[light.piglow docs]: /components/light.piglow/ +[light.sensehat docs]: /components/light.sensehat/ +[light.tradfri docs]: /components/light.tradfri/ +[light.zha docs]: /components/light.zha/ +[light.zwave docs]: /components/light.zwave/ +[maxcube docs]: /components/maxcube/ +[media_player docs]: /components/media_player/ +[media_player.spotify docs]: /components/media_player.spotify/ +[media_player.webostv docs]: /components/media_player.webostv/ +[mqtt docs]: /components/mqtt/ +[notify.html5 docs]: /components/notify.html5/ +[notify.instapush docs]: /components/notify.instapush/ +[notify.joaoapps_join docs]: /components/notify.joaoapps_join/ +[notify.mailgun docs]: /components/notify.mailgun/ +[notify.matrix docs]: /components/notify.matrix/ +[notify.smtp docs]: /components/notify.smtp/ +[notify.telegram docs]: /components/notify.telegram/ +[notify.webostv docs]: /components/notify.webostv/ +[nuimo_controller docs]: /components/nuimo_controller/ +[octoprint docs]: /components/octoprint/ +[opencv docs]: /components/opencv/ +[plant docs]: /components/plant/ +[recorder docs]: /components/recorder/ +[rfxtrx docs]: /components/rfxtrx/ +[rss_feed_template docs]: /components/rss_feed_template/ +[sensor.cert_expiry docs]: /components/sensor.cert_expiry/ +[sensor.dht docs]: /components/sensor.dht/ +[sensor.eight_sleep docs]: /components/sensor.eight_sleep/ +[sensor.envirophat docs]: /components/sensor.envirophat/ +[sensor.ios docs]: /components/sensor.ios/ +[sensor.lyft docs]: /components/sensor.lyft/ +[sensor.pushbullet docs]: /components/sensor.pushbullet/ +[sensor.speedtest docs]: /components/sensor.speedtest/ +[sensor.thinkingcleaner docs]: /components/sensor.thinkingcleaner/ +[sensor.vera docs]: /components/sensor.vera/ +[sensor.zamg docs]: /components/sensor.zamg/ +[sensor.zha docs]: /components/sensor.zha/ +[switch.flux docs]: /components/switch.flux/ +[switch.hook docs]: /components/switch.hook/ +[switch.thinkingcleaner docs]: /components/switch.thinkingcleaner/ +[switch.wemo docs]: /components/switch.wemo/ +[switch.zha docs]: /components/switch.zha/ +[telegram_bot docs]: /components/telegram_bot/ +[telegram_bot.polling docs]: /components/telegram_bot.polling/ +[telegram_bot.webhooks docs]: /components/telegram_bot.webhooks/ +[updater docs]: /components/updater/ +[vera docs]: /components/vera/ +[wemo docs]: /components/wemo/ +[wink docs]: /components/wink/ +[zha docs]: /components/zha/ [forum]: https://community.home-assistant.io/ [issue]: https://github.com/home-assistant/home-assistant/issues [#7062]: https://github.com/home-assistant/home-assistant/pull/7062 @@ -507,6 +507,6 @@ influxdb: [@finish06]: https://github.com/finish06 [@frog32]: https://github.com/frog32 [@pezinek]: https://github.com/pezinek -[device_tracker.unifi docs]: https://home-assistant.io/components/device_tracker.unifi/ -[sensor.wunderground docs]: https://home-assistant.io/components/sensor.wunderground/ +[device_tracker.unifi docs]: /components/device_tracker.unifi/ +[sensor.wunderground docs]: /components/sensor.wunderground/ [discord]: https://discord.gg/c5DvZ4e diff --git a/source/_posts/2017-05-20-automation-editor-zwave-panel-ocr.markdown b/source/_posts/2017-05-20-automation-editor-zwave-panel-ocr.markdown index 381d15f7c3..e2b2e34068 100644 --- a/source/_posts/2017-05-20-automation-editor-zwave-panel-ocr.markdown +++ b/source/_posts/2017-05-20-automation-editor-zwave-panel-ocr.markdown @@ -15,19 +15,19 @@ og_image: /images/blog/2017-05-0.45/components.png Welcome to another great release of Home Assistant! While some of contributors and users are gathering at PyCon US 2017, we still managed to get a great release together! -First thing for this release is a feature that has been requested a lot: an automation editor! It's still experimental - and many things are still in progress - but it works! You can create new automations and edit existing ones. If you start a new config, you're all good to go. Otherwise check [these instructions](https://home-assistant.io/docs/automation/editor/) to get your automations ready for editing in the UI. +First thing for this release is a feature that has been requested a lot: an automation editor! It's still experimental - and many things are still in progress - but it works! You can create new automations and edit existing ones. If you start a new config, you're all good to go. Otherwise check [these instructions](/docs/automation/editor/) to get your automations ready for editing in the UI.

    -Check this [video](https://youtu.be/0j_hWdCTip4) by [Ben](https://twitter.com/BRUHautomation) from [BRUHautomation](http://www.bruhautomation.com/) to see the new release in action. +Check this [video](https://youtu.be/0j_hWdCTip4) by [Ben](https://twitter.com/BRUHautomation) from [BRUHautomation](http://www.bruhautomation.com/) to see the new release in action.
    -As the editor is experimental, there are some limitations. These include that Chrome/Chromium is the only supported browser, we don't support all triggers and actions and there is no support for conditions yet. But the foundation is there and so if you want to contribute to this, come help! +As the editor is experimental, there are some limitations. These include that Chrome/Chromium is the only supported browser, we don't support all triggers and actions and there is no support for conditions yet. But the foundation is there and so if you want to contribute to this, come help! On the Z-Wave front a lot has happened. The biggest one is that we have a major extension of the Z-Wave panel thanks to [@turbokongen]! You will now be able to change config parameters and manage your devices. @@ -37,8 +37,8 @@ On the Z-Wave front a lot has happened. The biggest one is that we have a major Thanks to the work by the Python Open Z-Wave team we are now able to install it on demand from PyPi! There is no longer a need to pre-compile it yourself. This should give us the guarantee that we work with the Python Open Z-Wave version that the code expects.

    -If you have a security key set in your Open Z-Wave `options.xml`, copy `options.xml` to your Home Assistant configuration directory. This is the only place where options will get persisted. -

    +If you have a security key set in your Open Z-Wave `options.xml`, copy `options.xml` to your Home Assistant configuration directory. This is the only place where options will get persisted. +

    Next to that [@armills] has lead the charge and managed to get full test coverage for Z-Wave! Thanks for all the hard work! @@ -53,7 +53,7 @@ And last, but not least, our Docker image is now based off Python 3.6. This vers If you are using our [experimental Hass.io image][hass.io], we made a breaking change in how the panel is served. If you have an existing installation, make sure you update your supervisor to the latest version before updating Home Assistant. If you are going to flash a new Hass.io image, make sure to only flash the new 0.8 image as linked on [the installation page][hass.io-install]. [hass.io]: https://community.home-assistant.io/t/introducing-hass-io/17296 -[hass.io-install]: https://home-assistant.io/hassio/installation/ +[hass.io-install]: /hassio/installation/ ## {% linkable_title New integrations %} @@ -335,93 +335,93 @@ Experiencing issues introduced by this release? Please report them in our [issue [@tsvi]: https://github.com/tsvi [@turbokongen]: https://github.com/turbokongen [@w1ll1am23]: https://github.com/w1ll1am23 -[alexa docs]: https://home-assistant.io/components/alexa/ -[axis docs]: https://home-assistant.io/components/axis/ -[config.automation docs]: https://home-assistant.io/docs/automation/editor/ -[automation.event docs]: https://home-assistant.io/docs/configuration/events/ -[automation.state docs]: https://home-assistant.io/docs/configuration/state_object/ -[binary_sensor.mystrom docs]: https://home-assistant.io/components/binary_sensor.mystrom/ -[binary_sensor.raspihats docs]: https://home-assistant.io/components/binary_sensor.raspihats/ -[binary_sensor.rpi_pfio docs]: https://home-assistant.io/components/binary_sensor.rpi_pfio/ -[blink docs]: https://home-assistant.io/components/blink/ -[camera.__init__ docs]: https://home-assistant.io/components/camera.__init__/ -[camera.uvc docs]: https://home-assistant.io/components/camera.uvc/ -[camera.zoneminder docs]: https://home-assistant.io/components/camera.zoneminder/ -[climate.sensibo docs]: https://home-assistant.io/components/climate.sensibo/ -[config.__init__ docs]: https://home-assistant.io/components/config.__init__/ -[configurator docs]: https://home-assistant.io/components/configurator/ -[cover.lutron_caseta docs]: https://home-assistant.io/components/cover.lutron_caseta/ -[datadog docs]: https://home-assistant.io/components/datadog/ -[device_tracker.automatic docs]: https://home-assistant.io/components/device_tracker.automatic/ -[device_tracker.linksys_ap docs]: https://home-assistant.io/components/device_tracker.linksys_ap/ -[device_tracker.unifi docs]: https://home-assistant.io/components/device_tracker.unifi/ -[dweet docs]: https://home-assistant.io/components/dweet/ -[eight_sleep docs]: https://home-assistant.io/components/eight_sleep/ -[homematic docs]: https://home-assistant.io/components/homematic/ -[image_processing.__init__ docs]: https://home-assistant.io/components/image_processing.__init__/ -[image_processing.demo docs]: https://home-assistant.io/components/image_processing.demo/ -[image_processing.dlib_face_detect docs]: https://home-assistant.io/components/image_processing.dlib_face_detect/ -[image_processing.dlib_face_identify docs]: https://home-assistant.io/components/image_processing.dlib_face_identify/ -[image_processing.microsoft_face_detect docs]: https://home-assistant.io/components/image_processing.microsoft_face_detect/ -[image_processing.microsoft_face_identify docs]: https://home-assistant.io/components/image_processing.microsoft_face_identify/ -[image_processing.openalpr_cloud docs]: https://home-assistant.io/components/image_processing.openalpr_cloud/ -[image_processing.openalpr_local docs]: https://home-assistant.io/components/image_processing.openalpr_local/ -[image_processing.opencv docs]: https://home-assistant.io/components/image_processing.opencv/ -[image_processing.seven_segments docs]: https://home-assistant.io/components/image_processing.seven_segments/ -[kira docs]: https://home-assistant.io/components/kira/ -[light.__init__ docs]: https://home-assistant.io/components/light.__init__/ -[light.blinksticklight docs]: https://home-assistant.io/components/light.blinksticklight/ -[light.enocean docs]: https://home-assistant.io/components/light.enocean/ -[light.flux_led docs]: https://home-assistant.io/components/light.flux_led/ -[light.insteon_local docs]: https://home-assistant.io/components/light.insteon_local/ -[light.insteon_plm docs]: https://home-assistant.io/components/light.insteon_plm/ -[light.isy994 docs]: https://home-assistant.io/components/light.isy994/ -[light.lifx docs]: https://home-assistant.io/components/light.lifx/ -[light.limitlessled docs]: https://home-assistant.io/components/light.limitlessled/ -[light.mystrom docs]: https://home-assistant.io/components/light.mystrom/ -[light.osramlightify docs]: https://home-assistant.io/components/light.osramlightify/ -[light.tradfri docs]: https://home-assistant.io/components/light.tradfri/ -[logbook docs]: https://home-assistant.io/components/logbook/ -[lutron_caseta docs]: https://home-assistant.io/components/lutron_caseta/ -[media_player.denonavr docs]: https://home-assistant.io/components/media_player.denonavr/ -[media_player.kodi docs]: https://home-assistant.io/components/media_player.kodi/ -[media_player.onkyo docs]: https://home-assistant.io/components/media_player.onkyo/ -[media_player.roku docs]: https://home-assistant.io/components/media_player.roku/ -[media_player.sonos docs]: https://home-assistant.io/components/media_player.sonos/ -[media_player.spotify docs]: https://home-assistant.io/components/media_player.spotify/ -[microsoft_face docs]: https://home-assistant.io/components/microsoft_face/ -[notify.html5 docs]: https://home-assistant.io/components/notify.html5/ -[notify.sendgrid docs]: https://home-assistant.io/components/notify.sendgrid/ -[notify.smtp docs]: https://home-assistant.io/components/notify.smtp/ -[notify.telegram docs]: https://home-assistant.io/components/notify.telegram/ -[plant docs]: https://home-assistant.io/components/plant/ -[raspihats docs]: https://home-assistant.io/components/raspihats/ -[remote.kira docs]: https://home-assistant.io/components/remote.kira/ -[rflink docs]: https://home-assistant.io/components/rflink/ -[rpi_pfio docs]: https://home-assistant.io/components/rpi_pfio/ -[sensor.blink docs]: https://home-assistant.io/components/sensor.blink/ -[sensor.dweet docs]: https://home-assistant.io/components/sensor.dweet/ -[sensor.envirophat docs]: https://home-assistant.io/components/sensor.envirophat/ -[sensor.file docs]: https://home-assistant.io/components/sensor.file/ -[sensor.influxdb docs]: https://home-assistant.io/components/sensor.influxdb/ -[sensor.kira docs]: https://home-assistant.io/components/sensor.kira/ -[sensor.miflora docs]: https://home-assistant.io/components/sensor.miflora/ -[sensor.modem_callerid docs]: https://home-assistant.io/components/sensor.modem_callerid/ -[sensor.nzbget docs]: https://home-assistant.io/components/sensor.nzbget/ -[sensor.scrape docs]: https://home-assistant.io/components/sensor.scrape/ -[sensor.snmp docs]: https://home-assistant.io/components/sensor.snmp/ -[sensor.wunderground docs]: https://home-assistant.io/components/sensor.wunderground/ -[sun docs]: https://home-assistant.io/components/sun/ -[switch.rpi_pfio docs]: https://home-assistant.io/components/switch.rpi_pfio/ -[telegram_bot docs]: https://home-assistant.io/components/telegram_bot/ -[telegram_bot.polling docs]: https://home-assistant.io/components/telegram_bot.polling/ -[telegram_bot.services.yaml docs]: https://home-assistant.io/components/telegram_bot.services.yaml/ -[telegram_bot.webhooks docs]: https://home-assistant.io/components/telegram_bot.webhooks/ -[tradfri docs]: https://home-assistant.io/components/tradfri/ -[vera docs]: https://home-assistant.io/components/vera/ -[websocket_api docs]: https://home-assistant.io/components/websocket_api/ -[zwave docs]: https://home-assistant.io/components/zwave/ -[zwave.api docs]: https://home-assistant.io/components/zwave.api/ +[alexa docs]: /components/alexa/ +[axis docs]: /components/axis/ +[config.automation docs]: /docs/automation/editor/ +[automation.event docs]: /docs/configuration/events/ +[automation.state docs]: /docs/configuration/state_object/ +[binary_sensor.mystrom docs]: /components/binary_sensor.mystrom/ +[binary_sensor.raspihats docs]: /components/binary_sensor.raspihats/ +[binary_sensor.rpi_pfio docs]: /components/binary_sensor.rpi_pfio/ +[blink docs]: /components/blink/ +[camera.__init__ docs]: /components/camera.__init__/ +[camera.uvc docs]: /components/camera.uvc/ +[camera.zoneminder docs]: /components/camera.zoneminder/ +[climate.sensibo docs]: /components/climate.sensibo/ +[config.__init__ docs]: /components/config.__init__/ +[configurator docs]: /components/configurator/ +[cover.lutron_caseta docs]: /components/cover.lutron_caseta/ +[datadog docs]: /components/datadog/ +[device_tracker.automatic docs]: /components/device_tracker.automatic/ +[device_tracker.linksys_ap docs]: /components/device_tracker.linksys_ap/ +[device_tracker.unifi docs]: /components/device_tracker.unifi/ +[dweet docs]: /components/dweet/ +[eight_sleep docs]: /components/eight_sleep/ +[homematic docs]: /components/homematic/ +[image_processing.__init__ docs]: /components/image_processing.__init__/ +[image_processing.demo docs]: /components/image_processing.demo/ +[image_processing.dlib_face_detect docs]: /components/image_processing.dlib_face_detect/ +[image_processing.dlib_face_identify docs]: /components/image_processing.dlib_face_identify/ +[image_processing.microsoft_face_detect docs]: /components/image_processing.microsoft_face_detect/ +[image_processing.microsoft_face_identify docs]: /components/image_processing.microsoft_face_identify/ +[image_processing.openalpr_cloud docs]: /components/image_processing.openalpr_cloud/ +[image_processing.openalpr_local docs]: /components/image_processing.openalpr_local/ +[image_processing.opencv docs]: /components/image_processing.opencv/ +[image_processing.seven_segments docs]: /components/image_processing.seven_segments/ +[kira docs]: /components/kira/ +[light.__init__ docs]: /components/light.__init__/ +[light.blinksticklight docs]: /components/light.blinksticklight/ +[light.enocean docs]: /components/light.enocean/ +[light.flux_led docs]: /components/light.flux_led/ +[light.insteon_local docs]: /components/light.insteon_local/ +[light.insteon_plm docs]: /components/light.insteon_plm/ +[light.isy994 docs]: /components/light.isy994/ +[light.lifx docs]: /components/light.lifx/ +[light.limitlessled docs]: /components/light.limitlessled/ +[light.mystrom docs]: /components/light.mystrom/ +[light.osramlightify docs]: /components/light.osramlightify/ +[light.tradfri docs]: /components/light.tradfri/ +[logbook docs]: /components/logbook/ +[lutron_caseta docs]: /components/lutron_caseta/ +[media_player.denonavr docs]: /components/media_player.denonavr/ +[media_player.kodi docs]: /components/media_player.kodi/ +[media_player.onkyo docs]: /components/media_player.onkyo/ +[media_player.roku docs]: /components/media_player.roku/ +[media_player.sonos docs]: /components/media_player.sonos/ +[media_player.spotify docs]: /components/media_player.spotify/ +[microsoft_face docs]: /components/microsoft_face/ +[notify.html5 docs]: /components/notify.html5/ +[notify.sendgrid docs]: /components/notify.sendgrid/ +[notify.smtp docs]: /components/notify.smtp/ +[notify.telegram docs]: /components/notify.telegram/ +[plant docs]: /components/plant/ +[raspihats docs]: /components/raspihats/ +[remote.kira docs]: /components/remote.kira/ +[rflink docs]: /components/rflink/ +[rpi_pfio docs]: /components/rpi_pfio/ +[sensor.blink docs]: /components/sensor.blink/ +[sensor.dweet docs]: /components/sensor.dweet/ +[sensor.envirophat docs]: /components/sensor.envirophat/ +[sensor.file docs]: /components/sensor.file/ +[sensor.influxdb docs]: /components/sensor.influxdb/ +[sensor.kira docs]: /components/sensor.kira/ +[sensor.miflora docs]: /components/sensor.miflora/ +[sensor.modem_callerid docs]: /components/sensor.modem_callerid/ +[sensor.nzbget docs]: /components/sensor.nzbget/ +[sensor.scrape docs]: /components/sensor.scrape/ +[sensor.snmp docs]: /components/sensor.snmp/ +[sensor.wunderground docs]: /components/sensor.wunderground/ +[sun docs]: /components/sun/ +[switch.rpi_pfio docs]: /components/switch.rpi_pfio/ +[telegram_bot docs]: /components/telegram_bot/ +[telegram_bot.polling docs]: /components/telegram_bot.polling/ +[telegram_bot.services.yaml docs]: /components/telegram_bot.services.yaml/ +[telegram_bot.webhooks docs]: /components/telegram_bot.webhooks/ +[tradfri docs]: /components/tradfri/ +[vera docs]: /components/vera/ +[websocket_api docs]: /components/websocket_api/ +[zwave docs]: /components/zwave/ +[zwave.api docs]: /components/zwave.api/ [forum]: https://community.home-assistant.io/ [issue]: https://github.com/home-assistant/home-assistant/issues [#7673]: https://github.com/home-assistant/home-assistant/pull/7673 @@ -430,8 +430,8 @@ Experiencing issues introduced by this release? Please report them in our [issue [#7714]: https://github.com/home-assistant/home-assistant/pull/7714 [@cgtobi]: https://github.com/cgtobi [@tobygray]: https://github.com/tobygray -[device_tracker.ubus docs]: https://home-assistant.io/components/device_tracker.ubus/ -[hassio docs]: https://home-assistant.io/components/hassio/ -[media_player.volumio docs]: https://home-assistant.io/components/media_player.volumio/ -[telegram_bot.__init__ docs]: https://home-assistant.io/components/telegram_bot.__init__/ +[device_tracker.ubus docs]: /components/device_tracker.ubus/ +[hassio docs]: /components/hassio/ +[media_player.volumio docs]: /components/media_player.volumio/ +[telegram_bot.__init__ docs]: /components/telegram_bot.__init__/ [discord]: https://discord.gg/c5DvZ4e diff --git a/source/_posts/2017-06-04-release-46.markdown b/source/_posts/2017-06-04-release-46.markdown index 26ce625edf..f514f61f9b 100644 --- a/source/_posts/2017-06-04-release-46.markdown +++ b/source/_posts/2017-06-04-release-46.markdown @@ -307,80 +307,80 @@ Experiencing issues introduced by this release? Please report them in our [issue [@turbokongen]: https://github.com/turbokongen [@w1ll1am23]: https://github.com/w1ll1am23 [@wardcraigj]: https://github.com/wardcraigj -[alarm_control_panel.concord232 docs]: https://home-assistant.io/components/alarm_control_panel.concord232/ -[apcupsd docs]: https://home-assistant.io/components/apcupsd/ -[arlo docs]: https://home-assistant.io/components/arlo/ -[automation.state docs]: https://home-assistant.io/docs/automation/trigger/#state-trigger -[automation.time docs]: https://home-assistant.io/docs/automation/trigger/#time-trigger -[calendar.demo docs]: https://home-assistant.io/components/calendar.demo/ -[calendar.google docs]: https://home-assistant.io/components/calendar.google/ -[camera.amcrest docs]: https://home-assistant.io/components/camera.amcrest/ -[camera.arlo docs]: https://home-assistant.io/components/camera.arlo/ -[camera.synology docs]: https://home-assistant.io/components/camera.synology/ -[climate.tado docs]: https://home-assistant.io/components/climate.tado/ -[cover.myq docs]: https://home-assistant.io/components/cover.myq/ -[cover.zwave docs]: https://home-assistant.io/components/cover.zwave/ -[device_tracker.__init__ docs]: https://home-assistant.io/components/device_tracker.__init__/ -[device_tracker.asuswrt docs]: https://home-assistant.io/components/device_tracker.asuswrt/ -[device_tracker.mikrotik docs]: https://home-assistant.io/components/device_tracker.mikrotik/ -[device_tracker.snmp docs]: https://home-assistant.io/components/device_tracker.snmp/ -[device_tracker.ubus docs]: https://home-assistant.io/components/device_tracker.ubus/ -[eight_sleep docs]: https://home-assistant.io/components/eight_sleep/ -[envisalink docs]: https://home-assistant.io/components/envisalink/ -[fan.zwave docs]: https://home-assistant.io/components/fan.zwave/ -[hassio docs]: https://home-assistant.io/components/hassio/ -[homematic docs]: https://home-assistant.io/components/homematic/ -[image_processing.seven_segments docs]: https://home-assistant.io/components/image_processing.seven_segments/ -[insteon_local docs]: https://home-assistant.io/components/insteon_local/ -[ios docs]: https://home-assistant.io/components/ios/ -[light.__init__ docs]: https://home-assistant.io/components/light.__init__/ -[light.flux_led docs]: https://home-assistant.io/components/light.flux_led/ -[light.lifx docs]: https://home-assistant.io/components/light.lifx/ -[light.template docs]: https://home-assistant.io/components/light.template/ -[light.wink docs]: https://home-assistant.io/components/light.wink/ -[lock.zwave docs]: https://home-assistant.io/components/lock.zwave/ -[lutron docs]: https://home-assistant.io/components/lutron/ -[media_player.denonavr docs]: https://home-assistant.io/components/media_player.denonavr/ -[media_player.openhome docs]: https://home-assistant.io/components/media_player.openhome/ -[media_player.services.yaml docs]: https://home-assistant.io/components/media_player.services.yaml/ -[media_player.snapcast docs]: https://home-assistant.io/components/media_player.snapcast/ -[media_player.sonos docs]: https://home-assistant.io/components/media_player.sonos/ -[media_player.spotify docs]: https://home-assistant.io/components/media_player.spotify/ -[media_player.volumio docs]: https://home-assistant.io/components/media_player.volumio/ -[modbus docs]: https://home-assistant.io/components/modbus/ -[mqtt.discovery docs]: https://home-assistant.io/components/mqtt.discovery/ -[notify.ios docs]: https://home-assistant.io/components/notify.ios/ -[notify.rest docs]: https://home-assistant.io/components/notify.rest/ -[notify.slack docs]: https://home-assistant.io/components/notify.slack/ -[notify.smtp docs]: https://home-assistant.io/components/notify.smtp/ -[notify.telegram docs]: https://home-assistant.io/components/notify.telegram/ -[recorder.__init__ docs]: https://home-assistant.io/components/recorder.__init__/ -[remote docs]: https://home-assistant.io/components/remote/ -[remote.harmony docs]: https://home-assistant.io/components/remote.harmony/ -[remote.services.yaml docs]: https://home-assistant.io/components/remote.services.yaml/ -[scene.hunterdouglas_powerview docs]: https://home-assistant.io/components/scene.hunterdouglas_powerview/ -[sensor.amcrest docs]: https://home-assistant.io/components/sensor.amcrest/ -[sensor.arlo docs]: https://home-assistant.io/components/sensor.arlo/ -[sensor.dsmr docs]: https://home-assistant.io/components/sensor.dsmr/ -[sensor.fedex docs]: https://home-assistant.io/components/sensor.fedex/ -[sensor.history_stats docs]: https://home-assistant.io/components/sensor.history_stats/ -[sensor.hp_ilo docs]: https://home-assistant.io/components/sensor.hp_ilo/ -[sensor.influxdb docs]: https://home-assistant.io/components/sensor.influxdb/ -[sensor.mvglive docs]: https://home-assistant.io/components/sensor.mvglive/ -[sensor.snmp docs]: https://home-assistant.io/components/sensor.snmp/ -[sensor.synologydsm docs]: https://home-assistant.io/components/sensor.synologydsm/ -[sensor.time_date docs]: https://home-assistant.io/components/sensor.time_date/ -[sensor.usps docs]: https://home-assistant.io/components/sensor.usps/ -[switch.broadlink docs]: https://home-assistant.io/components/switch.broadlink/ -[switch.rachio docs]: https://home-assistant.io/components/switch.rachio/ -[switch.rflink docs]: https://home-assistant.io/components/switch.rflink/ -[telegram_bot.__init__ docs]: https://home-assistant.io/components/telegram_bot.__init__/ -[telegram_bot.polling docs]: https://home-assistant.io/components/telegram_bot.polling/ -[telegram_bot.webhooks docs]: https://home-assistant.io/components/telegram_bot.webhooks/ -[tellduslive docs]: https://home-assistant.io/components/tellduslive/ -[upnp docs]: https://home-assistant.io/components/upnp/ -[zoneminder docs]: https://home-assistant.io/components/zoneminder/ -[zwave docs]: https://home-assistant.io/components/zwave/ +[alarm_control_panel.concord232 docs]: /components/alarm_control_panel.concord232/ +[apcupsd docs]: /components/apcupsd/ +[arlo docs]: /components/arlo/ +[automation.state docs]: /docs/automation/trigger/#state-trigger +[automation.time docs]: /docs/automation/trigger/#time-trigger +[calendar.demo docs]: /components/calendar.demo/ +[calendar.google docs]: /components/calendar.google/ +[camera.amcrest docs]: /components/camera.amcrest/ +[camera.arlo docs]: /components/camera.arlo/ +[camera.synology docs]: /components/camera.synology/ +[climate.tado docs]: /components/climate.tado/ +[cover.myq docs]: /components/cover.myq/ +[cover.zwave docs]: /components/cover.zwave/ +[device_tracker.__init__ docs]: /components/device_tracker.__init__/ +[device_tracker.asuswrt docs]: /components/device_tracker.asuswrt/ +[device_tracker.mikrotik docs]: /components/device_tracker.mikrotik/ +[device_tracker.snmp docs]: /components/device_tracker.snmp/ +[device_tracker.ubus docs]: /components/device_tracker.ubus/ +[eight_sleep docs]: /components/eight_sleep/ +[envisalink docs]: /components/envisalink/ +[fan.zwave docs]: /components/fan.zwave/ +[hassio docs]: /components/hassio/ +[homematic docs]: /components/homematic/ +[image_processing.seven_segments docs]: /components/image_processing.seven_segments/ +[insteon_local docs]: /components/insteon_local/ +[ios docs]: /components/ios/ +[light.__init__ docs]: /components/light.__init__/ +[light.flux_led docs]: /components/light.flux_led/ +[light.lifx docs]: /components/light.lifx/ +[light.template docs]: /components/light.template/ +[light.wink docs]: /components/light.wink/ +[lock.zwave docs]: /components/lock.zwave/ +[lutron docs]: /components/lutron/ +[media_player.denonavr docs]: /components/media_player.denonavr/ +[media_player.openhome docs]: /components/media_player.openhome/ +[media_player.services.yaml docs]: /components/media_player.services.yaml/ +[media_player.snapcast docs]: /components/media_player.snapcast/ +[media_player.sonos docs]: /components/media_player.sonos/ +[media_player.spotify docs]: /components/media_player.spotify/ +[media_player.volumio docs]: /components/media_player.volumio/ +[modbus docs]: /components/modbus/ +[mqtt.discovery docs]: /components/mqtt.discovery/ +[notify.ios docs]: /components/notify.ios/ +[notify.rest docs]: /components/notify.rest/ +[notify.slack docs]: /components/notify.slack/ +[notify.smtp docs]: /components/notify.smtp/ +[notify.telegram docs]: /components/notify.telegram/ +[recorder.__init__ docs]: /components/recorder.__init__/ +[remote docs]: /components/remote/ +[remote.harmony docs]: /components/remote.harmony/ +[remote.services.yaml docs]: /components/remote.services.yaml/ +[scene.hunterdouglas_powerview docs]: /components/scene.hunterdouglas_powerview/ +[sensor.amcrest docs]: /components/sensor.amcrest/ +[sensor.arlo docs]: /components/sensor.arlo/ +[sensor.dsmr docs]: /components/sensor.dsmr/ +[sensor.fedex docs]: /components/sensor.fedex/ +[sensor.history_stats docs]: /components/sensor.history_stats/ +[sensor.hp_ilo docs]: /components/sensor.hp_ilo/ +[sensor.influxdb docs]: /components/sensor.influxdb/ +[sensor.mvglive docs]: /components/sensor.mvglive/ +[sensor.snmp docs]: /components/sensor.snmp/ +[sensor.synologydsm docs]: /components/sensor.synologydsm/ +[sensor.time_date docs]: /components/sensor.time_date/ +[sensor.usps docs]: /components/sensor.usps/ +[switch.broadlink docs]: /components/switch.broadlink/ +[switch.rachio docs]: /components/switch.rachio/ +[switch.rflink docs]: /components/switch.rflink/ +[telegram_bot.__init__ docs]: /components/telegram_bot.__init__/ +[telegram_bot.polling docs]: /components/telegram_bot.polling/ +[telegram_bot.webhooks docs]: /components/telegram_bot.webhooks/ +[tellduslive docs]: /components/tellduslive/ +[upnp docs]: /components/upnp/ +[zoneminder docs]: /components/zoneminder/ +[zwave docs]: /components/zwave/ [forum]: https://community.home-assistant.io/ [issue]: https://github.com/home-assistant/home-assistant/issues [#7780]: https://github.com/home-assistant/home-assistant/pull/7780 @@ -392,8 +392,8 @@ Experiencing issues introduced by this release? Please report them in our [issue [#7969]: https://github.com/home-assistant/home-assistant/pull/7969 [@cyberjacob]: https://github.com/cyberjacob [@mje-nz]: https://github.com/mje-nz -[cover.mqtt docs]: https://home-assistant.io/components/cover.mqtt/ -[sensor.metoffice docs]: https://home-assistant.io/components/sensor.metoffice/ -[sensor.wunderground docs]: https://home-assistant.io/components/sensor.wunderground/ -[media_player.roku docs]: https://home-assistant.io/components/media_player.roku/ +[cover.mqtt docs]: /components/cover.mqtt/ +[sensor.metoffice docs]: /components/sensor.metoffice/ +[sensor.wunderground docs]: /components/sensor.wunderground/ +[media_player.roku docs]: /components/media_player.roku/ [discord]: https://discord.gg/c5DvZ4e diff --git a/source/_posts/2017-06-17-release-47.markdown b/source/_posts/2017-06-17-release-47.markdown index 548f62fa45..b91503b06d 100644 --- a/source/_posts/2017-06-17-release-47.markdown +++ b/source/_posts/2017-06-17-release-47.markdown @@ -448,130 +448,130 @@ automation: [@trisk]: https://github.com/trisk [@twendt]: https://github.com/twendt [@vrs01]: https://github.com/vrs01 -[alarm_control_panel.spc docs]: https://home-assistant.io/components/alarm_control_panel.spc/ -[binary_sensor.enocean docs]: https://home-assistant.io/components/binary_sensor.enocean/ -[binary_sensor.homematic docs]: https://home-assistant.io/components/binary_sensor.homematic/ -[binary_sensor.spc docs]: https://home-assistant.io/components/binary_sensor.spc/ -[binary_sensor.tapsaff docs]: https://home-assistant.io/components/binary_sensor.tapsaff/ -[calendar.google docs]: https://home-assistant.io/components/calendar.google/ -[climate.flexit docs]: https://home-assistant.io/components/climate.flexit/ -[climate.wink docs]: https://home-assistant.io/components/climate.wink/ -[conversation docs]: https://home-assistant.io/components/conversation/ -[cover.homematic docs]: https://home-assistant.io/components/cover.homematic/ -[cover.mqtt docs]: https://home-assistant.io/components/cover.mqtt/ -[cover.myq docs]: https://home-assistant.io/components/cover.myq/ -[device_tracker.__init__ docs]: https://home-assistant.io/components/device_tracker.__init__/ -[device_tracker.owntracks docs]: https://home-assistant.io/components/device_tracker.owntracks/ -[device_tracker.ping docs]: https://home-assistant.io/components/device_tracker.ping/ -[device_tracker.snmp docs]: https://home-assistant.io/components/device_tracker.snmp/ -[device_tracker.unifi docs]: https://home-assistant.io/components/device_tracker.unifi/ -[eight_sleep docs]: https://home-assistant.io/components/eight_sleep/ -[fan.__init__ docs]: https://home-assistant.io/components/fan.__init__/ -[fan.demo docs]: https://home-assistant.io/components/fan.demo/ -[fan.zwave docs]: https://home-assistant.io/components/fan.zwave/ -[group docs]: https://home-assistant.io/components/group/ -[homematic docs]: https://home-assistant.io/components/homematic/ -[http docs]: https://home-assistant.io/components/http/ -[image_processing.opencv docs]: https://home-assistant.io/components/image_processing.opencv/ -[image_processing.seven_segments docs]: https://home-assistant.io/components/image_processing.seven_segments/ -[influxdb docs]: https://home-assistant.io/components/influxdb/ -[juicenet docs]: https://home-assistant.io/components/juicenet/ -[light.lifx docs]: https://home-assistant.io/components/light.lifx/ -[light.lutron docs]: https://home-assistant.io/components/light.lutron/ -[light.osramlightify docs]: https://home-assistant.io/components/light.osramlightify/ -[light.template docs]: https://home-assistant.io/components/light.template/ -[light.vera docs]: https://home-assistant.io/components/light.vera/ -[light.yeelight docs]: https://home-assistant.io/components/light.yeelight/ -[light.zwave docs]: https://home-assistant.io/components/light.zwave/ -[lock.sesame docs]: https://home-assistant.io/components/lock.sesame/ -[lutron docs]: https://home-assistant.io/components/lutron/ -[mailgun docs]: https://home-assistant.io/components/mailgun/ -[media_player.aquostv docs]: https://home-assistant.io/components/media_player.aquostv/ -[media_player.denonavr docs]: https://home-assistant.io/components/media_player.denonavr/ -[media_player.firetv docs]: https://home-assistant.io/components/media_player.firetv/ -[media_player.nad docs]: https://home-assistant.io/components/media_player.nad/ -[media_player.nadtcp docs]: https://home-assistant.io/components/media_player.nadtcp/ -[media_player.openhome docs]: https://home-assistant.io/components/media_player.openhome/ -[media_player.plex docs]: https://home-assistant.io/components/media_player.plex/ -[media_player.roku docs]: https://home-assistant.io/components/media_player.roku/ -[media_player.sonos docs]: https://home-assistant.io/components/media_player.sonos/ -[media_player.spotify docs]: https://home-assistant.io/components/media_player.spotify/ -[media_player.squeezebox docs]: https://home-assistant.io/components/media_player.squeezebox/ -[mqtt.__init__ docs]: https://home-assistant.io/components/mqtt.__init__/ -[nest docs]: https://home-assistant.io/components/nest/ -[netatmo docs]: https://home-assistant.io/components/netatmo/ -[notify.html5 docs]: https://home-assistant.io/components/notify.html5/ -[notify.mailgun docs]: https://home-assistant.io/components/notify.mailgun/ -[notify.sendgrid docs]: https://home-assistant.io/components/notify.sendgrid/ -[notify.xmpp docs]: https://home-assistant.io/components/notify.xmpp/ -[opencv docs]: https://home-assistant.io/components/opencv/ -[persistent_notification docs]: https://home-assistant.io/components/persistent_notification/ -[plant docs]: https://home-assistant.io/components/plant/ -[python_script docs]: https://home-assistant.io/components/python_script/ -[sensor.bitcoin docs]: https://home-assistant.io/components/sensor.bitcoin/ -[sensor.blockchain docs]: https://home-assistant.io/components/sensor.blockchain/ -[sensor.buienradar docs]: https://home-assistant.io/components/sensor.buienradar/ -[sensor.coinmarketcap docs]: https://home-assistant.io/components/sensor.coinmarketcap/ -[sensor.cpuspeed docs]: https://home-assistant.io/components/sensor.cpuspeed/ -[sensor.cups docs]: https://home-assistant.io/components/sensor.cups/ -[sensor.currencylayer docs]: https://home-assistant.io/components/sensor.currencylayer/ -[sensor.dsmr docs]: https://home-assistant.io/components/sensor.dsmr/ -[sensor.dte_energy_bridge docs]: https://home-assistant.io/components/sensor.dte_energy_bridge/ -[sensor.dublin_bus_transport docs]: https://home-assistant.io/components/sensor.dublin_bus_transport/ -[sensor.dweet docs]: https://home-assistant.io/components/sensor.dweet/ -[sensor.ebox docs]: https://home-assistant.io/components/sensor.ebox/ -[sensor.ecobee docs]: https://home-assistant.io/components/sensor.ecobee/ -[sensor.eliqonline docs]: https://home-assistant.io/components/sensor.eliqonline/ -[sensor.etherscan docs]: https://home-assistant.io/components/sensor.etherscan/ -[sensor.fixer docs]: https://home-assistant.io/components/sensor.fixer/ -[sensor.gitter docs]: https://home-assistant.io/components/sensor.gitter/ -[sensor.hddtemp docs]: https://home-assistant.io/components/sensor.hddtemp/ -[sensor.homematic docs]: https://home-assistant.io/components/sensor.homematic/ -[sensor.imap_email_content docs]: https://home-assistant.io/components/sensor.imap_email_content/ -[sensor.juicenet docs]: https://home-assistant.io/components/sensor.juicenet/ -[sensor.metoffice docs]: https://home-assistant.io/components/sensor.metoffice/ -[sensor.mold_indicator docs]: https://home-assistant.io/components/sensor.mold_indicator/ -[sensor.netatmo docs]: https://home-assistant.io/components/sensor.netatmo/ -[sensor.openevse docs]: https://home-assistant.io/components/sensor.openevse/ -[sensor.pi_hole docs]: https://home-assistant.io/components/sensor.pi_hole/ -[sensor.pvoutput docs]: https://home-assistant.io/components/sensor.pvoutput/ -[sensor.radarr docs]: https://home-assistant.io/components/sensor.radarr/ -[sensor.ripple docs]: https://home-assistant.io/components/sensor.ripple/ -[sensor.snmp docs]: https://home-assistant.io/components/sensor.snmp/ -[sensor.statistics docs]: https://home-assistant.io/components/sensor.statistics/ -[sensor.template docs]: https://home-assistant.io/components/sensor.template/ -[sensor.ups docs]: https://home-assistant.io/components/sensor.ups/ -[sensor.usps docs]: https://home-assistant.io/components/sensor.usps/ -[sensor.waqi docs]: https://home-assistant.io/components/sensor.waqi/ -[sensor.wunderground docs]: https://home-assistant.io/components/sensor.wunderground/ -[sensor.yahoo_finance docs]: https://home-assistant.io/components/sensor.yahoo_finance/ -[sensor.yweather docs]: https://home-assistant.io/components/sensor.yweather/ -[spc docs]: https://home-assistant.io/components/spc/ -[splunk docs]: https://home-assistant.io/components/splunk/ -[switch.homematic docs]: https://home-assistant.io/components/switch.homematic/ -[switch.raspihats docs]: https://home-assistant.io/components/switch.raspihats/ -[switch.rest docs]: https://home-assistant.io/components/switch.rest/ -[switch.template docs]: https://home-assistant.io/components/switch.template/ -[telegram_bot.__init__ docs]: https://home-assistant.io/components/telegram_bot.__init__/ -[telegram_bot.polling docs]: https://home-assistant.io/components/telegram_bot.polling/ -[telegram_bot.webhooks docs]: https://home-assistant.io/components/telegram_bot.webhooks/ -[updater docs]: https://home-assistant.io/components/updater/ -[vera docs]: https://home-assistant.io/components/vera/ -[volvooncall docs]: https://home-assistant.io/components/volvooncall/ -[weather.buienradar docs]: https://home-assistant.io/components/weather.buienradar/ -[zeroconf docs]: https://home-assistant.io/components/zeroconf/ -[zwave docs]: https://home-assistant.io/components/zwave/ -[zwave blog post]: https://home-assistant.io/blog/2017/06/15/zwave-entity-ids/ +[alarm_control_panel.spc docs]: /components/alarm_control_panel.spc/ +[binary_sensor.enocean docs]: /components/binary_sensor.enocean/ +[binary_sensor.homematic docs]: /components/binary_sensor.homematic/ +[binary_sensor.spc docs]: /components/binary_sensor.spc/ +[binary_sensor.tapsaff docs]: /components/binary_sensor.tapsaff/ +[calendar.google docs]: /components/calendar.google/ +[climate.flexit docs]: /components/climate.flexit/ +[climate.wink docs]: /components/climate.wink/ +[conversation docs]: /components/conversation/ +[cover.homematic docs]: /components/cover.homematic/ +[cover.mqtt docs]: /components/cover.mqtt/ +[cover.myq docs]: /components/cover.myq/ +[device_tracker.__init__ docs]: /components/device_tracker.__init__/ +[device_tracker.owntracks docs]: /components/device_tracker.owntracks/ +[device_tracker.ping docs]: /components/device_tracker.ping/ +[device_tracker.snmp docs]: /components/device_tracker.snmp/ +[device_tracker.unifi docs]: /components/device_tracker.unifi/ +[eight_sleep docs]: /components/eight_sleep/ +[fan.__init__ docs]: /components/fan.__init__/ +[fan.demo docs]: /components/fan.demo/ +[fan.zwave docs]: /components/fan.zwave/ +[group docs]: /components/group/ +[homematic docs]: /components/homematic/ +[http docs]: /components/http/ +[image_processing.opencv docs]: /components/image_processing.opencv/ +[image_processing.seven_segments docs]: /components/image_processing.seven_segments/ +[influxdb docs]: /components/influxdb/ +[juicenet docs]: /components/juicenet/ +[light.lifx docs]: /components/light.lifx/ +[light.lutron docs]: /components/light.lutron/ +[light.osramlightify docs]: /components/light.osramlightify/ +[light.template docs]: /components/light.template/ +[light.vera docs]: /components/light.vera/ +[light.yeelight docs]: /components/light.yeelight/ +[light.zwave docs]: /components/light.zwave/ +[lock.sesame docs]: /components/lock.sesame/ +[lutron docs]: /components/lutron/ +[mailgun docs]: /components/mailgun/ +[media_player.aquostv docs]: /components/media_player.aquostv/ +[media_player.denonavr docs]: /components/media_player.denonavr/ +[media_player.firetv docs]: /components/media_player.firetv/ +[media_player.nad docs]: /components/media_player.nad/ +[media_player.nadtcp docs]: /components/media_player.nadtcp/ +[media_player.openhome docs]: /components/media_player.openhome/ +[media_player.plex docs]: /components/media_player.plex/ +[media_player.roku docs]: /components/media_player.roku/ +[media_player.sonos docs]: /components/media_player.sonos/ +[media_player.spotify docs]: /components/media_player.spotify/ +[media_player.squeezebox docs]: /components/media_player.squeezebox/ +[mqtt.__init__ docs]: /components/mqtt.__init__/ +[nest docs]: /components/nest/ +[netatmo docs]: /components/netatmo/ +[notify.html5 docs]: /components/notify.html5/ +[notify.mailgun docs]: /components/notify.mailgun/ +[notify.sendgrid docs]: /components/notify.sendgrid/ +[notify.xmpp docs]: /components/notify.xmpp/ +[opencv docs]: /components/opencv/ +[persistent_notification docs]: /components/persistent_notification/ +[plant docs]: /components/plant/ +[python_script docs]: /components/python_script/ +[sensor.bitcoin docs]: /components/sensor.bitcoin/ +[sensor.blockchain docs]: /components/sensor.blockchain/ +[sensor.buienradar docs]: /components/sensor.buienradar/ +[sensor.coinmarketcap docs]: /components/sensor.coinmarketcap/ +[sensor.cpuspeed docs]: /components/sensor.cpuspeed/ +[sensor.cups docs]: /components/sensor.cups/ +[sensor.currencylayer docs]: /components/sensor.currencylayer/ +[sensor.dsmr docs]: /components/sensor.dsmr/ +[sensor.dte_energy_bridge docs]: /components/sensor.dte_energy_bridge/ +[sensor.dublin_bus_transport docs]: /components/sensor.dublin_bus_transport/ +[sensor.dweet docs]: /components/sensor.dweet/ +[sensor.ebox docs]: /components/sensor.ebox/ +[sensor.ecobee docs]: /components/sensor.ecobee/ +[sensor.eliqonline docs]: /components/sensor.eliqonline/ +[sensor.etherscan docs]: /components/sensor.etherscan/ +[sensor.fixer docs]: /components/sensor.fixer/ +[sensor.gitter docs]: /components/sensor.gitter/ +[sensor.hddtemp docs]: /components/sensor.hddtemp/ +[sensor.homematic docs]: /components/sensor.homematic/ +[sensor.imap_email_content docs]: /components/sensor.imap_email_content/ +[sensor.juicenet docs]: /components/sensor.juicenet/ +[sensor.metoffice docs]: /components/sensor.metoffice/ +[sensor.mold_indicator docs]: /components/sensor.mold_indicator/ +[sensor.netatmo docs]: /components/sensor.netatmo/ +[sensor.openevse docs]: /components/sensor.openevse/ +[sensor.pi_hole docs]: /components/sensor.pi_hole/ +[sensor.pvoutput docs]: /components/sensor.pvoutput/ +[sensor.radarr docs]: /components/sensor.radarr/ +[sensor.ripple docs]: /components/sensor.ripple/ +[sensor.snmp docs]: /components/sensor.snmp/ +[sensor.statistics docs]: /components/sensor.statistics/ +[sensor.template docs]: /components/sensor.template/ +[sensor.ups docs]: /components/sensor.ups/ +[sensor.usps docs]: /components/sensor.usps/ +[sensor.waqi docs]: /components/sensor.waqi/ +[sensor.wunderground docs]: /components/sensor.wunderground/ +[sensor.yahoo_finance docs]: /components/sensor.yahoo_finance/ +[sensor.yweather docs]: /components/sensor.yweather/ +[spc docs]: /components/spc/ +[splunk docs]: /components/splunk/ +[switch.homematic docs]: /components/switch.homematic/ +[switch.raspihats docs]: /components/switch.raspihats/ +[switch.rest docs]: /components/switch.rest/ +[switch.template docs]: /components/switch.template/ +[telegram_bot.__init__ docs]: /components/telegram_bot.__init__/ +[telegram_bot.polling docs]: /components/telegram_bot.polling/ +[telegram_bot.webhooks docs]: /components/telegram_bot.webhooks/ +[updater docs]: /components/updater/ +[vera docs]: /components/vera/ +[volvooncall docs]: /components/volvooncall/ +[weather.buienradar docs]: /components/weather.buienradar/ +[zeroconf docs]: /components/zeroconf/ +[zwave docs]: /components/zwave/ +[zwave blog post]: /blog/2017/06/15/zwave-entity-ids/ [forum]: https://community.home-assistant.io/ [issue]: https://github.com/home-assistant/home-assistant/issues -[first-commit]: https://home-assistant.io/help/trivia/#first-commit +[first-commit]: /help/trivia/#first-commit [#8080]: https://github.com/home-assistant/home-assistant/pull/8080 [#8101]: https://github.com/home-assistant/home-assistant/pull/8101 [#8104]: https://github.com/home-assistant/home-assistant/pull/8104 [#8113]: https://github.com/home-assistant/home-assistant/pull/8113 [#8134]: https://github.com/home-assistant/home-assistant/pull/8134 [@tsvi]: https://github.com/tsvi -[fan.dyson docs]: https://home-assistant.io/components/fan.dyson/ -[remote.itach docs]: https://home-assistant.io/components/remote.itach/ -[sensor.dyson docs]: https://home-assistant.io/components/sensor.dyson/ +[fan.dyson docs]: /components/fan.dyson/ +[remote.itach docs]: /components/remote.itach/ +[sensor.dyson docs]: /components/sensor.dyson/ [discord]: https://discord.gg/c5DvZ4e diff --git a/source/_posts/2017-07-02-release-48.markdown b/source/_posts/2017-07-02-release-48.markdown index 4fc39bea01..3dc0835b55 100644 --- a/source/_posts/2017-07-02-release-48.markdown +++ b/source/_posts/2017-07-02-release-48.markdown @@ -28,13 +28,13 @@ zwave: ## {% linkable_title Big speed up in querying the history %} -Thanks to the work by [@cmsimike] in [#8255] you'll see a significant speed up when using the history view. In his local tests queries went from 1 minute to 90ms! ⚡️ +Thanks to the work by [@cmsimike] in [#8255] you'll see a significant speed up when using the history view. In his local tests queries went from 1 minute to 90ms! ⚡️ ## {% linkable_title Snips.ai component %} Snips has contributed a component to integrate with their Snips.ai local voice assistant. This will allow you to hook a speaker and a microphone into your Raspberry Pi and make your own local Amazon Echo quickly. See [the docs][snips docs] for further instructions. -Also a shoutout to [@michaelarnauts] for keeping an eye on our Docker build and once again reducing the file size 👍 +Also a shoutout to [@michaelarnauts] for keeping an eye on our Docker build and once again reducing the file size 👍 [issue-polymer]: https://github.com/home-assistant/home-assistant-polymer/issues @@ -530,9 +530,9 @@ light: [#8336]: https://github.com/home-assistant/home-assistant/pull/8336 [@adrienball]: https://github.com/adrienball [@bergemalm]: https://github.com/bergemalm -[api docs]: https://home-assistant.io/components/api/ -[camera.arlo docs]: https://home-assistant.io/components/camera.arlo/ -[mqtt docs]: https://home-assistant.io/components/mqtt/ -[remote.harmony docs]: https://home-assistant.io/components/remote.harmony/ -[sensor.arlo docs]: https://home-assistant.io/components/sensor.arlo/ -[snips docs]: https://home-assistant.io/components/snips/ +[api docs]: /components/api/ +[camera.arlo docs]: /components/camera.arlo/ +[mqtt docs]: /components/mqtt/ +[remote.harmony docs]: /components/remote.harmony/ +[sensor.arlo docs]: /components/sensor.arlo/ +[snips docs]: /components/snips/ diff --git a/source/_posts/2017-07-03-home-assistant-is-moving-to-discord.markdown b/source/_posts/2017-07-03-home-assistant-is-moving-to-discord.markdown index fc40dfa617..f85c83c020 100644 --- a/source/_posts/2017-07-03-home-assistant-is-moving-to-discord.markdown +++ b/source/_posts/2017-07-03-home-assistant-is-moving-to-discord.markdown @@ -86,5 +86,5 @@ Community Leader, Home Assistant [discord]: https://discord.gg/c5DvZ4e [discord-devs]: https://discord.gg/8X8DTH4 [discord-general]: https://discord.gg/pywKZRT -[FAQ]: https://home-assistant.io/faq/ -[docs]: https://home-assistant.io/docs/ +[FAQ]: /faq/ +[docs]: /docs/ diff --git a/source/_posts/2017-07-16-release-49.markdown b/source/_posts/2017-07-16-release-49.markdown index 81aaab898a..09a24ce1f7 100644 --- a/source/_posts/2017-07-16-release-49.markdown +++ b/source/_posts/2017-07-16-release-49.markdown @@ -375,105 +375,105 @@ amcrest: [@w1ll1am23]: https://github.com/w1ll1am23 [@wardcraigj]: https://github.com/wardcraigj [@wmalgadey]: https://github.com/wmalgadey -[alarm_control_panel.totalconnect docs]: https://home-assistant.io/components/alarm_control_panel.totalconnect/ -[amcrest docs]: https://home-assistant.io/components/amcrest/ -[apcupsd docs]: https://home-assistant.io/components/apcupsd/ -[binary_sensor.hikvision docs]: https://home-assistant.io/components/binary_sensor.hikvision/ -[binary_sensor.modbus docs]: https://home-assistant.io/components/binary_sensor.modbus/ -[binary_sensor.octoprint docs]: https://home-assistant.io/components/binary_sensor.octoprint/ -[binary_sensor.pilight docs]: https://home-assistant.io/components/binary_sensor.pilight/ -[binary_sensor.zha docs]: https://home-assistant.io/components/binary_sensor.zha/ -[camera.amcrest docs]: https://home-assistant.io/components/camera.amcrest/ -[camera.arlo docs]: https://home-assistant.io/components/camera.arlo/ -[climate.flexit docs]: https://home-assistant.io/components/climate.flexit/ -[climate.generic_thermostat docs]: https://home-assistant.io/components/climate.generic_thermostat/ -[climate.radiotherm docs]: https://home-assistant.io/components/climate.radiotherm/ -[climate.tado docs]: https://home-assistant.io/components/climate.tado/ -[cover.template docs]: https://home-assistant.io/components/cover.template/ -[device_tracker.asuswrt docs]: https://home-assistant.io/components/device_tracker.asuswrt/ -[device_tracker.linksys_smart docs]: https://home-assistant.io/components/device_tracker.linksys_smart/ -[device_tracker.tplink docs]: https://home-assistant.io/components/device_tracker.tplink/ -[device_tracker.upc_connect docs]: https://home-assistant.io/components/device_tracker.upc_connect/ -[dyson docs]: https://home-assistant.io/components/dyson/ -[fan.dyson docs]: https://home-assistant.io/components/fan.dyson/ -[group docs]: https://home-assistant.io/components/group/ -[hassio docs]: https://home-assistant.io/hassio/ -[homematic docs]: https://home-assistant.io/components/homematic/ -[image_processing.dlib_face_detect docs]: https://home-assistant.io/components/image_processing.dlib_face_detect/ -[image_processing.dlib_face_identify docs]: https://home-assistant.io/components/image_processing.dlib_face_identify/ -[knx docs]: https://home-assistant.io/components/knx/ -[lametric docs]: https://home-assistant.io/components/lametric/ -[light.avion docs]: https://home-assistant.io/components/light.avion/ -[light.decora docs]: https://home-assistant.io/components/light.decora/ -[light.hue docs]: https://home-assistant.io/components/light.hue/ -[light.hyperion docs]: https://home-assistant.io/components/light.hyperion/ -[light.knx docs]: https://home-assistant.io/components/light.knx/ -[light.lifx docs]: https://home-assistant.io/components/light.lifx/ -[light.mystrom docs]: https://home-assistant.io/components/light.mystrom/ -[light.rflink docs]: https://home-assistant.io/components/light.rflink/ -[light.zha docs]: https://home-assistant.io/components/light.zha/ -[lutron docs]: https://home-assistant.io/components/lutron/ -[media_extractor docs]: https://home-assistant.io/components/media_extractor/ -[media_player.apple_tv docs]: https://home-assistant.io/components/media_player.apple_tv/ -[media_player.denonavr docs]: https://home-assistant.io/components/media_player.denonavr/ -[media_player.emby docs]: https://home-assistant.io/components/media_player.emby/ -[media_player.plex docs]: https://home-assistant.io/components/media_player.plex/ -[media_player.soundtouch docs]: https://home-assistant.io/components/media_player.soundtouch/ -[media_player.spotify docs]: https://home-assistant.io/components/media_player.spotify/ -[media_player.vizio docs]: https://home-assistant.io/components/media_player.vizio/ -[modbus docs]: https://home-assistant.io/components/modbus/ -[mqtt docs]: https://home-assistant.io/components/mqtt/ -[notify docs]: https://home-assistant.io/components/notify/ -[notify.discord docs]: https://home-assistant.io/components/notify.discord/ -[notify.lametric docs]: https://home-assistant.io/components/notify.lametric/ -[notify.slack docs]: https://home-assistant.io/components/notify.slack/ -[notify.twitter docs]: https://home-assistant.io/components/notify.twitter/ -[octoprint docs]: https://home-assistant.io/components/octoprint/ -[prometheus docs]: https://home-assistant.io/components/prometheus/ -[python_script docs]: https://home-assistant.io/components/python_script/ -[recorder docs]: https://home-assistant.io/components/recorder/ -[rflink docs]: https://home-assistant.io/components/rflink/ -[rfxtrx docs]: https://home-assistant.io/components/rfxtrx/ -[scene.velux docs]: https://home-assistant.io/components/scene.velux/ -[sensor.amcrest docs]: https://home-assistant.io/components/sensor.amcrest/ -[sensor.apcupsd docs]: https://home-assistant.io/components/sensor.apcupsd/ -[sensor.arwn docs]: https://home-assistant.io/components/sensor.arwn/ -[sensor.broadlink docs]: https://home-assistant.io/components/sensor.broadlink/ -[sensor.buienradar docs]: https://home-assistant.io/components/sensor.buienradar/ -[sensor.citybikes docs]: https://home-assistant.io/components/sensor.citybikes/ -[sensor.dht docs]: https://home-assistant.io/components/sensor.dht/ -[sensor.dyson docs]: https://home-assistant.io/components/sensor.dyson/ -[sensor.gtfs docs]: https://home-assistant.io/components/sensor.gtfs/ -[sensor.london_underground docs]: https://home-assistant.io/components/sensor.london_underground/ -[sensor.modbus docs]: https://home-assistant.io/components/sensor.modbus/ -[sensor.octoprint docs]: https://home-assistant.io/components/sensor.octoprint/ -[sensor.openweathermap docs]: https://home-assistant.io/components/sensor.openweathermap/ -[sensor.otp docs]: https://home-assistant.io/components/sensor.otp/ -[sensor.rflink docs]: https://home-assistant.io/components/sensor.rflink/ -[sensor.uber docs]: https://home-assistant.io/components/sensor.uber/ -[sensor.waqi docs]: https://home-assistant.io/components/sensor.waqi/ -[sensor.yweather docs]: https://home-assistant.io/components/sensor.yweather/ -[sensor.zha docs]: https://home-assistant.io/components/sensor.zha/ -[snips docs]: https://home-assistant.io/components/snips/ -[switch.broadlink docs]: https://home-assistant.io/components/switch.broadlink/ -[switch.dlink docs]: https://home-assistant.io/components/switch.dlink/ -[switch.modbus docs]: https://home-assistant.io/components/switch.modbus/ -[switch.rachio docs]: https://home-assistant.io/components/switch.rachio/ -[switch.rflink docs]: https://home-assistant.io/components/switch.rflink/ -[switch.xiaomi_vacuum docs]: https://home-assistant.io/components/switch.xiaomi_vacuum/ -[tado docs]: https://home-assistant.io/components/tado/ -[tts docs]: https://home-assistant.io/components/tts/ -[tts.amazon_polly docs]: https://home-assistant.io/components/tts.amazon_polly/ -[upnp docs]: https://home-assistant.io/components/upnp/ -[velux docs]: https://home-assistant.io/components/velux/ -[frontend docs]: https://home-assistant.io/components/frontend/ -[vera docs]: https://home-assistant.io/components/vera/ -[verisure docs]: https://home-assistant.io/components/verisure/ -[wake_on_lan docs]: https://home-assistant.io/components/wake_on_lan/ -[weather.buienradar docs]: https://home-assistant.io/components/weather.buienradar/ -[weather.openweathermap docs]: https://home-assistant.io/components/weather.openweathermap/ -[zha docs]: https://home-assistant.io/components/zha/ -[zha.const docs]: https://home-assistant.io/components/zha.const/ +[alarm_control_panel.totalconnect docs]: /components/alarm_control_panel.totalconnect/ +[amcrest docs]: /components/amcrest/ +[apcupsd docs]: /components/apcupsd/ +[binary_sensor.hikvision docs]: /components/binary_sensor.hikvision/ +[binary_sensor.modbus docs]: /components/binary_sensor.modbus/ +[binary_sensor.octoprint docs]: /components/binary_sensor.octoprint/ +[binary_sensor.pilight docs]: /components/binary_sensor.pilight/ +[binary_sensor.zha docs]: /components/binary_sensor.zha/ +[camera.amcrest docs]: /components/camera.amcrest/ +[camera.arlo docs]: /components/camera.arlo/ +[climate.flexit docs]: /components/climate.flexit/ +[climate.generic_thermostat docs]: /components/climate.generic_thermostat/ +[climate.radiotherm docs]: /components/climate.radiotherm/ +[climate.tado docs]: /components/climate.tado/ +[cover.template docs]: /components/cover.template/ +[device_tracker.asuswrt docs]: /components/device_tracker.asuswrt/ +[device_tracker.linksys_smart docs]: /components/device_tracker.linksys_smart/ +[device_tracker.tplink docs]: /components/device_tracker.tplink/ +[device_tracker.upc_connect docs]: /components/device_tracker.upc_connect/ +[dyson docs]: /components/dyson/ +[fan.dyson docs]: /components/fan.dyson/ +[group docs]: /components/group/ +[hassio docs]: /hassio/ +[homematic docs]: /components/homematic/ +[image_processing.dlib_face_detect docs]: /components/image_processing.dlib_face_detect/ +[image_processing.dlib_face_identify docs]: /components/image_processing.dlib_face_identify/ +[knx docs]: /components/knx/ +[lametric docs]: /components/lametric/ +[light.avion docs]: /components/light.avion/ +[light.decora docs]: /components/light.decora/ +[light.hue docs]: /components/light.hue/ +[light.hyperion docs]: /components/light.hyperion/ +[light.knx docs]: /components/light.knx/ +[light.lifx docs]: /components/light.lifx/ +[light.mystrom docs]: /components/light.mystrom/ +[light.rflink docs]: /components/light.rflink/ +[light.zha docs]: /components/light.zha/ +[lutron docs]: /components/lutron/ +[media_extractor docs]: /components/media_extractor/ +[media_player.apple_tv docs]: /components/media_player.apple_tv/ +[media_player.denonavr docs]: /components/media_player.denonavr/ +[media_player.emby docs]: /components/media_player.emby/ +[media_player.plex docs]: /components/media_player.plex/ +[media_player.soundtouch docs]: /components/media_player.soundtouch/ +[media_player.spotify docs]: /components/media_player.spotify/ +[media_player.vizio docs]: /components/media_player.vizio/ +[modbus docs]: /components/modbus/ +[mqtt docs]: /components/mqtt/ +[notify docs]: /components/notify/ +[notify.discord docs]: /components/notify.discord/ +[notify.lametric docs]: /components/notify.lametric/ +[notify.slack docs]: /components/notify.slack/ +[notify.twitter docs]: /components/notify.twitter/ +[octoprint docs]: /components/octoprint/ +[prometheus docs]: /components/prometheus/ +[python_script docs]: /components/python_script/ +[recorder docs]: /components/recorder/ +[rflink docs]: /components/rflink/ +[rfxtrx docs]: /components/rfxtrx/ +[scene.velux docs]: /components/scene.velux/ +[sensor.amcrest docs]: /components/sensor.amcrest/ +[sensor.apcupsd docs]: /components/sensor.apcupsd/ +[sensor.arwn docs]: /components/sensor.arwn/ +[sensor.broadlink docs]: /components/sensor.broadlink/ +[sensor.buienradar docs]: /components/sensor.buienradar/ +[sensor.citybikes docs]: /components/sensor.citybikes/ +[sensor.dht docs]: /components/sensor.dht/ +[sensor.dyson docs]: /components/sensor.dyson/ +[sensor.gtfs docs]: /components/sensor.gtfs/ +[sensor.london_underground docs]: /components/sensor.london_underground/ +[sensor.modbus docs]: /components/sensor.modbus/ +[sensor.octoprint docs]: /components/sensor.octoprint/ +[sensor.openweathermap docs]: /components/sensor.openweathermap/ +[sensor.otp docs]: /components/sensor.otp/ +[sensor.rflink docs]: /components/sensor.rflink/ +[sensor.uber docs]: /components/sensor.uber/ +[sensor.waqi docs]: /components/sensor.waqi/ +[sensor.yweather docs]: /components/sensor.yweather/ +[sensor.zha docs]: /components/sensor.zha/ +[snips docs]: /components/snips/ +[switch.broadlink docs]: /components/switch.broadlink/ +[switch.dlink docs]: /components/switch.dlink/ +[switch.modbus docs]: /components/switch.modbus/ +[switch.rachio docs]: /components/switch.rachio/ +[switch.rflink docs]: /components/switch.rflink/ +[switch.xiaomi_vacuum docs]: /components/switch.xiaomi_vacuum/ +[tado docs]: /components/tado/ +[tts docs]: /components/tts/ +[tts.amazon_polly docs]: /components/tts.amazon_polly/ +[upnp docs]: /components/upnp/ +[velux docs]: /components/velux/ +[frontend docs]: /components/frontend/ +[vera docs]: /components/vera/ +[verisure docs]: /components/verisure/ +[wake_on_lan docs]: /components/wake_on_lan/ +[weather.buienradar docs]: /components/weather.buienradar/ +[weather.openweathermap docs]: /components/weather.openweathermap/ +[zha docs]: /components/zha/ +[zha.const docs]: /components/zha.const/ [forum]: https://community.home-assistant.io/ [issue]: https://github.com/home-assistant/home-assistant/issues [discord]: https://discord.gg/c5DvZ4e @@ -490,8 +490,8 @@ amcrest: [@clkao]: https://github.com/clkao [@maikelwever]: https://github.com/maikelwever [@ypollart]: https://github.com/ypollart -[binary_sensor.rfxtrx docs]: https://home-assistant.io/components/binary_sensor.rfxtrx/ -[telegram_bot docs]: https://home-assistant.io/components/telegram_bot/ +[binary_sensor.rfxtrx docs]: /components/binary_sensor.rfxtrx/ +[telegram_bot docs]: /components/telegram_bot/ [#8545]: https://github.com/home-assistant/home-assistant/pull/8545 [#8571]: https://github.com/home-assistant/home-assistant/pull/8571 [#8601]: https://github.com/home-assistant/home-assistant/pull/8601 @@ -502,6 +502,6 @@ amcrest: [@glance-]: https://github.com/glance- [@jawilson]: https://github.com/jawilson [@schaal]: https://github.com/schaal -[device_tracker.ubus docs]: https://home-assistant.io/components/device_tracker.ubus/ -[keyboard_remote docs]: https://home-assistant.io/components/keyboard_remote/ -[switch.flux docs]: https://home-assistant.io/components/switch.flux/ +[device_tracker.ubus docs]: /components/device_tracker.ubus/ +[keyboard_remote docs]: /components/keyboard_remote/ +[switch.flux docs]: /components/switch.flux/ diff --git a/source/_posts/2017-07-29-release-50.markdown b/source/_posts/2017-07-29-release-50.markdown index 3de112daf6..bd9fba9034 100644 --- a/source/_posts/2017-07-29-release-50.markdown +++ b/source/_posts/2017-07-29-release-50.markdown @@ -13,7 +13,7 @@ og_image: /images/blog/2017-07-0.50/components.png -Last Wednesday we released [Hass.io](https://home-assistant.io/hassio/), an operating system to take care of all the updating hassles that come with running home automation at home and so much more. This is a major milestone for Home Assistant as it is our first step to offering a fully integrated solution using a bring your own hardware approach. +Last Wednesday we released [Hass.io](/hassio/), an operating system to take care of all the updating hassles that come with running home automation at home and so much more. This is a major milestone for Home Assistant as it is our first step to offering a fully integrated solution using a bring your own hardware approach. The launch has been crazy successful. The [20 minute introduction video][hassio-intro] by BRUHAutomation already has 12.5k views in just 4 days with no less than 150 comments. @@ -333,76 +333,76 @@ conversation: [@titilambert]: https://github.com/titilambert [@viswa-swami]: https://github.com/viswa-swami [@w1ll1am23]: https://github.com/w1ll1am23 -[alarm_control_panel.manual_mqtt docs]: https://home-assistant.io/components/alarm_control_panel.manual_mqtt/ -[alarm_control_panel.simplisafe docs]: https://home-assistant.io/components/alarm_control_panel.simplisafe/ -[alarmdecoder docs]: https://home-assistant.io/components/alarmdecoder/ -[alexa docs]: https://home-assistant.io/components/alexa/ -[automation.state docs]: https://home-assistant.io/docs/automation/trigger/#state-trigger -[automation.time docs]: https://home-assistant.io/docs/automation/trigger/#time-trigger -[binary_sensor.ping docs]: https://home-assistant.io/components/binary_sensor.ping/ -[binary_sensor.rest docs]: https://home-assistant.io/components/binary_sensor.rest/ -[binary_sensor.velbus docs]: https://home-assistant.io/components/binary_sensor.velbus/ -[binary_sensor.xiaomi docs]: https://home-assistant.io/components/binary_sensor.xiaomi/ -[camera.onvif docs]: https://home-assistant.io/components/camera.onvif/ -[climate.maxcube docs]: https://home-assistant.io/components/climate.maxcube/ -[conversation docs]: https://home-assistant.io/components/conversation/ -[cover docs]: https://home-assistant.io/components/cover/ -[cover.lutron_caseta docs]: https://home-assistant.io/components/cover.lutron_caseta/ -[cover.xiaomi docs]: https://home-assistant.io/components/cover.xiaomi/ -[cover.zwave docs]: https://home-assistant.io/components/cover.zwave/ -[device_tracker.owntracks docs]: https://home-assistant.io/components/device_tracker.owntracks/ -[device_tracker.snmp docs]: https://home-assistant.io/components/device_tracker.snmp/ -[emulated_hue docs]: https://home-assistant.io/components/emulated_hue/ -[fan.wink docs]: https://home-assistant.io/components/fan.wink/ -[hassio docs]: https://home-assistant.io/hassio/ -[history docs]: https://home-assistant.io/components/history/ -[homematic docs]: https://home-assistant.io/components/homematic/ -[image_processing.dlib_face_identify docs]: https://home-assistant.io/components/image_processing.dlib_face_identify/ -[intent docs]: https://home-assistant.io/developers/intent/ -[intent_script docs]: https://home-assistant.io/components/intent_script/ -[knx docs]: https://home-assistant.io/components/knx/ -[light docs]: https://home-assistant.io/components/light/ -[light.decora docs]: https://home-assistant.io/components/light.decora/ -[light.hue docs]: https://home-assistant.io/components/light.hue/ -[light.lifx docs]: https://home-assistant.io/components/light.lifx/ -[light.tplink docs]: https://home-assistant.io/components/light.tplink/ -[light.velbus docs]: https://home-assistant.io/components/light.velbus/ -[light.wink docs]: https://home-assistant.io/components/light.wink/ -[light.xiaomi docs]: https://home-assistant.io/components/light.xiaomi/ -[light.zha docs]: https://home-assistant.io/components/light.zha/ -[media_extractor docs]: https://home-assistant.io/components/media_extractor/ -[media_player.cast docs]: https://home-assistant.io/components/media_player.cast/ -[media_player.kodi docs]: https://home-assistant.io/components/media_player.kodi/ -[mqtt docs]: https://home-assistant.io/components/mqtt/ -[notify.html5 docs]: https://home-assistant.io/components/notify.html5/ -[notify.twitter docs]: https://home-assistant.io/components/notify.twitter/ -[python_script docs]: https://home-assistant.io/components/python_script/ -[recorder docs]: https://home-assistant.io/components/recorder/ -[remote.harmony docs]: https://home-assistant.io/components/remote.harmony/ -[sensor.citybikes docs]: https://home-assistant.io/components/sensor.citybikes/ -[sensor.dht docs]: https://home-assistant.io/components/sensor.dht/ -[sensor.fitbit docs]: https://home-assistant.io/components/sensor.fitbit/ -[sensor.google_wifi docs]: https://home-assistant.io/components/sensor.google_wifi/ -[sensor.hydroquebec docs]: https://home-assistant.io/components/sensor.hydroquebec/ -[sensor.knx docs]: https://home-assistant.io/components/sensor.knx/ -[sensor.lyft docs]: https://home-assistant.io/components/sensor.lyft/ -[sensor.octoprint docs]: https://home-assistant.io/components/sensor.octoprint/ -[sensor.pi_hole docs]: https://home-assistant.io/components/sensor.pi_hole/ -[sensor.snmp docs]: https://home-assistant.io/components/sensor.snmp/ -[sensor.uk_transport docs]: https://home-assistant.io/components/sensor.uk_transport/ -[sensor.xiaomi docs]: https://home-assistant.io/components/sensor.xiaomi/ -[shopping_list docs]: https://home-assistant.io/components/shopping_list/ -[snips docs]: https://home-assistant.io/components/snips/ -[statsd docs]: https://home-assistant.io/components/statsd/ -[switch.fritzdect docs]: https://home-assistant.io/components/switch.fritzdect/ -[switch.mqtt docs]: https://home-assistant.io/components/switch.mqtt/ -[switch.wink docs]: https://home-assistant.io/components/switch.wink/ -[switch.xiaomi docs]: https://home-assistant.io/components/switch.xiaomi/ -[switch.xiaomi_vacuum docs]: https://home-assistant.io/components/switch.xiaomi_vacuum/ -[velbus docs]: https://home-assistant.io/components/velbus/ -[weather.yweather docs]: https://home-assistant.io/components/weather.yweather/ -[wink docs]: https://home-assistant.io/components/wink/ -[xiaomi docs]: https://home-assistant.io/components/xiaomi/ +[alarm_control_panel.manual_mqtt docs]: /components/alarm_control_panel.manual_mqtt/ +[alarm_control_panel.simplisafe docs]: /components/alarm_control_panel.simplisafe/ +[alarmdecoder docs]: /components/alarmdecoder/ +[alexa docs]: /components/alexa/ +[automation.state docs]: /docs/automation/trigger/#state-trigger +[automation.time docs]: /docs/automation/trigger/#time-trigger +[binary_sensor.ping docs]: /components/binary_sensor.ping/ +[binary_sensor.rest docs]: /components/binary_sensor.rest/ +[binary_sensor.velbus docs]: /components/binary_sensor.velbus/ +[binary_sensor.xiaomi docs]: /components/binary_sensor.xiaomi/ +[camera.onvif docs]: /components/camera.onvif/ +[climate.maxcube docs]: /components/climate.maxcube/ +[conversation docs]: /components/conversation/ +[cover docs]: /components/cover/ +[cover.lutron_caseta docs]: /components/cover.lutron_caseta/ +[cover.xiaomi docs]: /components/cover.xiaomi/ +[cover.zwave docs]: /components/cover.zwave/ +[device_tracker.owntracks docs]: /components/device_tracker.owntracks/ +[device_tracker.snmp docs]: /components/device_tracker.snmp/ +[emulated_hue docs]: /components/emulated_hue/ +[fan.wink docs]: /components/fan.wink/ +[hassio docs]: /hassio/ +[history docs]: /components/history/ +[homematic docs]: /components/homematic/ +[image_processing.dlib_face_identify docs]: /components/image_processing.dlib_face_identify/ +[intent docs]: /developers/intent/ +[intent_script docs]: /components/intent_script/ +[knx docs]: /components/knx/ +[light docs]: /components/light/ +[light.decora docs]: /components/light.decora/ +[light.hue docs]: /components/light.hue/ +[light.lifx docs]: /components/light.lifx/ +[light.tplink docs]: /components/light.tplink/ +[light.velbus docs]: /components/light.velbus/ +[light.wink docs]: /components/light.wink/ +[light.xiaomi docs]: /components/light.xiaomi/ +[light.zha docs]: /components/light.zha/ +[media_extractor docs]: /components/media_extractor/ +[media_player.cast docs]: /components/media_player.cast/ +[media_player.kodi docs]: /components/media_player.kodi/ +[mqtt docs]: /components/mqtt/ +[notify.html5 docs]: /components/notify.html5/ +[notify.twitter docs]: /components/notify.twitter/ +[python_script docs]: /components/python_script/ +[recorder docs]: /components/recorder/ +[remote.harmony docs]: /components/remote.harmony/ +[sensor.citybikes docs]: /components/sensor.citybikes/ +[sensor.dht docs]: /components/sensor.dht/ +[sensor.fitbit docs]: /components/sensor.fitbit/ +[sensor.google_wifi docs]: /components/sensor.google_wifi/ +[sensor.hydroquebec docs]: /components/sensor.hydroquebec/ +[sensor.knx docs]: /components/sensor.knx/ +[sensor.lyft docs]: /components/sensor.lyft/ +[sensor.octoprint docs]: /components/sensor.octoprint/ +[sensor.pi_hole docs]: /components/sensor.pi_hole/ +[sensor.snmp docs]: /components/sensor.snmp/ +[sensor.uk_transport docs]: /components/sensor.uk_transport/ +[sensor.xiaomi docs]: /components/sensor.xiaomi/ +[shopping_list docs]: /components/shopping_list/ +[snips docs]: /components/snips/ +[statsd docs]: /components/statsd/ +[switch.fritzdect docs]: /components/switch.fritzdect/ +[switch.mqtt docs]: /components/switch.mqtt/ +[switch.wink docs]: /components/switch.wink/ +[switch.xiaomi docs]: /components/switch.xiaomi/ +[switch.xiaomi_vacuum docs]: /components/switch.xiaomi_vacuum/ +[velbus docs]: /components/velbus/ +[weather.yweather docs]: /components/weather.yweather/ +[wink docs]: /components/wink/ +[xiaomi docs]: /components/xiaomi/ [forum]: https://community.home-assistant.io/ [issue]: https://github.com/home-assistant/home-assistant/issues [discord]: https://discord.gg/c5DvZ4e @@ -418,7 +418,7 @@ conversation: [#8754]: https://github.com/home-assistant/home-assistant/pull/8754 [#8755]: https://github.com/home-assistant/home-assistant/pull/8755 [@n8henrie]: https://github.com/n8henrie -[light.tradfri docs]: https://home-assistant.io/components/light.tradfri/ -[media_player.pioneer docs]: https://home-assistant.io/components/media_player.pioneer/ -[telegram_bot.webhooks docs]: https://home-assistant.io/components/telegram_bot.webhooks/ -[zwave docs]: https://home-assistant.io/components/zwave/ +[light.tradfri docs]: /components/light.tradfri/ +[media_player.pioneer docs]: /components/media_player.pioneer/ +[telegram_bot.webhooks docs]: /components/telegram_bot.webhooks/ +[zwave docs]: /components/zwave/ diff --git a/source/_posts/2017-08-12-release-51.markdown b/source/_posts/2017-08-12-release-51.markdown index 36b32d9ad9..6e8a5f24ff 100644 --- a/source/_posts/2017-08-12-release-51.markdown +++ b/source/_posts/2017-08-12-release-51.markdown @@ -353,107 +353,107 @@ vacuum: [@viswa-swami]: https://github.com/viswa-swami [@w1ll1am23]: https://github.com/w1ll1am23 [@wickerwaka]: https://github.com/wickerwaka -[alarm_control_panel.simplisafe docs]: https://home-assistant.io/components/alarm_control_panel.simplisafe/ -[alexa docs]: https://home-assistant.io/components/alexa/ -[asterisk_mbox docs]: https://home-assistant.io/components/asterisk_mbox/ -[automation docs]: https://home-assistant.io/components/automation/ -[binary_sensor docs]: https://home-assistant.io/components/binary_sensor/ -[binary_sensor.command_line docs]: https://home-assistant.io/components/binary_sensor.command_line/ -[binary_sensor.rest docs]: https://home-assistant.io/components/binary_sensor.rest/ -[binary_sensor.zwave docs]: https://home-assistant.io/components/binary_sensor.zwave/ -[camera.foscam docs]: https://home-assistant.io/components/camera.foscam/ -[climate docs]: https://home-assistant.io/components/climate/ -[climate.honeywell docs]: https://home-assistant.io/components/climate.honeywell/ -[climate.tado docs]: https://home-assistant.io/components/climate.tado/ -[config.zwave docs]: https://home-assistant.io/components/config.zwave/ -[cover.lutron_caseta docs]: https://home-assistant.io/components/cover.lutron_caseta/ -[cover.rpi_gpio docs]: https://home-assistant.io/components/cover.rpi_gpio/ -[device_tracker.huawei_router docs]: https://home-assistant.io/components/device_tracker.huawei_router/ -[dyson docs]: https://home-assistant.io/components/dyson/ -[emulated_hue docs]: https://home-assistant.io/components/emulated_hue/ -[fan.dyson docs]: https://home-assistant.io/components/fan.dyson/ -[group docs]: https://home-assistant.io/components/group/ -[history docs]: https://home-assistant.io/components/history/ -[image_processing.opencv docs]: https://home-assistant.io/components/image_processing.opencv/ -[influxdb docs]: https://home-assistant.io/components/influxdb/ -[insteon_plm docs]: https://home-assistant.io/components/insteon_plm/ -[light.decora_wifi docs]: https://home-assistant.io/components/light.decora_wifi/ -[light.flux_led docs]: https://home-assistant.io/components/light.flux_led/ -[light.lifx docs]: https://home-assistant.io/components/light.lifx/ -[light.mochad docs]: https://home-assistant.io/components/light.mochad/ -[light.osramlightify docs]: https://home-assistant.io/components/light.osramlightify/ -[lock.nuki docs]: https://home-assistant.io/components/lock.nuki/ -[lutron_caseta docs]: https://home-assistant.io/components/lutron_caseta/ -[mailbox.demo docs]: https://home-assistant.io/components/mailbox.demo/ -[mailbox.demo.txt docs]: https://home-assistant.io/components/mailbox.demo.txt/ -[media_extractor docs]: https://home-assistant.io/components/media_extractor/ -[media_player docs]: https://home-assistant.io/components/media_player/ -[media_player.bluesound docs]: https://home-assistant.io/components/media_player.bluesound/ -[media_player.cast docs]: https://home-assistant.io/components/media_player.cast/ -[media_player.directv docs]: https://home-assistant.io/components/media_player.directv/ -[media_player.kodi docs]: https://home-assistant.io/components/media_player.kodi/ -[media_player.mpd docs]: https://home-assistant.io/components/media_player.mpd/ -[media_player.russound_rio docs]: https://home-assistant.io/components/media_player.russound_rio/ -[media_player.sonos docs]: https://home-assistant.io/components/media_player.sonos/ -[media_player.squeezebox docs]: https://home-assistant.io/components/media_player.squeezebox/ -[notify.pushbullet docs]: https://home-assistant.io/components/notify.pushbullet/ -[notify.xmpp docs]: https://home-assistant.io/components/notify.xmpp/ -[recorder docs]: https://home-assistant.io/components/recorder/ -[recorder.migration docs]: https://home-assistant.io/components/recorder.migration/ -[recorder.models docs]: https://home-assistant.io/components/recorder.models/ -[recorder.purge docs]: https://home-assistant.io/components/recorder.purge/ -[recorder.util docs]: https://home-assistant.io/components/recorder.util/ -[remote docs]: https://home-assistant.io/components/remote/ -[remote.apple_tv docs]: https://home-assistant.io/components/remote.apple_tv/ -[remote.demo docs]: https://home-assistant.io/components/remote.demo/ -[remote.harmony docs]: https://home-assistant.io/components/remote.harmony/ -[remote.itach docs]: https://home-assistant.io/components/remote.itach/ -[remote.kira docs]: https://home-assistant.io/components/remote.kira/ -[rflink docs]: https://home-assistant.io/components/rflink/ -[scene.lutron_caseta docs]: https://home-assistant.io/components/scene.lutron_caseta/ -[sensor.asterisk_mbox docs]: https://home-assistant.io/components/sensor.asterisk_mbox/ -[sensor.buienradar docs]: https://home-assistant.io/components/sensor.buienradar/ -[sensor.command_line docs]: https://home-assistant.io/components/sensor.command_line/ -[sensor.dyson docs]: https://home-assistant.io/components/sensor.dyson/ -[sensor.efergy docs]: https://home-assistant.io/components/sensor.efergy/ -[sensor.eight_sleep docs]: https://home-assistant.io/components/sensor.eight_sleep/ -[sensor.geizhals docs]: https://home-assistant.io/components/sensor.geizhals/ -[sensor.google_wifi docs]: https://home-assistant.io/components/sensor.google_wifi/ -[sensor.lastfm docs]: https://home-assistant.io/components/sensor.lastfm/ -[sensor.neato docs]: https://home-assistant.io/components/sensor.neato/ -[sensor.pi_hole docs]: https://home-assistant.io/components/sensor.pi_hole/ -[sensor.pocketcasts docs]: https://home-assistant.io/components/sensor.pocketcasts/ -[sensor.radarr docs]: https://home-assistant.io/components/sensor.radarr/ -[sensor.rest docs]: https://home-assistant.io/components/sensor.rest/ -[sensor.sabnzbd docs]: https://home-assistant.io/components/sensor.sabnzbd/ -[sensor.shodan docs]: https://home-assistant.io/components/sensor.shodan/ -[sensor.sonarr docs]: https://home-assistant.io/components/sensor.sonarr/ -[sensor.statistics docs]: https://home-assistant.io/components/sensor.statistics/ -[sensor.supervisord docs]: https://home-assistant.io/components/sensor.supervisord/ -[sensor.synologydsm docs]: https://home-assistant.io/components/sensor.synologydsm/ -[sensor.systemmonitor docs]: https://home-assistant.io/components/sensor.systemmonitor/ -[sensor.vasttrafik docs]: https://home-assistant.io/components/sensor.vasttrafik/ -[sensor.yr docs]: https://home-assistant.io/components/sensor.yr/ -[sensor.zamg docs]: https://home-assistant.io/components/sensor.zamg/ -[switch.command_line docs]: https://home-assistant.io/components/switch.command_line/ -[switch.mqtt docs]: https://home-assistant.io/components/switch.mqtt/ -[switch.neato docs]: https://home-assistant.io/components/switch.neato/ -[switch.rachio docs]: https://home-assistant.io/components/switch.rachio/ -[switch.rainmachine docs]: https://home-assistant.io/components/switch.rainmachine/ -[switch.wink docs]: https://home-assistant.io/components/switch.wink/ -[switch.xiaomi_vacuum docs]: https://home-assistant.io/components/switch.xiaomi_vacuum/ -[telegram_bot docs]: https://home-assistant.io/components/telegram_bot/ -[updater docs]: https://home-assistant.io/components/updater/ -[vacuum docs]: https://home-assistant.io/components/vacuum/ -[vacuum.demo docs]: https://home-assistant.io/components/vacuum.demo/ -[vacuum.dyson docs]: https://home-assistant.io/components/vacuum.dyson/ -[vacuum.roomba docs]: https://home-assistant.io/components/vacuum.roomba/ -[vacuum.xiaomi docs]: https://home-assistant.io/components/vacuum.xiaomi/ -[weather.buienradar docs]: https://home-assistant.io/components/weather.buienradar/ -[weather.yweather docs]: https://home-assistant.io/components/weather.yweather/ -[weather.zamg docs]: https://home-assistant.io/components/weather.zamg/ -[wink docs]: https://home-assistant.io/components/wink/ -[zwave docs]: https://home-assistant.io/components/zwave/ +[alarm_control_panel.simplisafe docs]: /components/alarm_control_panel.simplisafe/ +[alexa docs]: /components/alexa/ +[asterisk_mbox docs]: /components/asterisk_mbox/ +[automation docs]: /components/automation/ +[binary_sensor docs]: /components/binary_sensor/ +[binary_sensor.command_line docs]: /components/binary_sensor.command_line/ +[binary_sensor.rest docs]: /components/binary_sensor.rest/ +[binary_sensor.zwave docs]: /components/binary_sensor.zwave/ +[camera.foscam docs]: /components/camera.foscam/ +[climate docs]: /components/climate/ +[climate.honeywell docs]: /components/climate.honeywell/ +[climate.tado docs]: /components/climate.tado/ +[config.zwave docs]: /components/config.zwave/ +[cover.lutron_caseta docs]: /components/cover.lutron_caseta/ +[cover.rpi_gpio docs]: /components/cover.rpi_gpio/ +[device_tracker.huawei_router docs]: /components/device_tracker.huawei_router/ +[dyson docs]: /components/dyson/ +[emulated_hue docs]: /components/emulated_hue/ +[fan.dyson docs]: /components/fan.dyson/ +[group docs]: /components/group/ +[history docs]: /components/history/ +[image_processing.opencv docs]: /components/image_processing.opencv/ +[influxdb docs]: /components/influxdb/ +[insteon_plm docs]: /components/insteon_plm/ +[light.decora_wifi docs]: /components/light.decora_wifi/ +[light.flux_led docs]: /components/light.flux_led/ +[light.lifx docs]: /components/light.lifx/ +[light.mochad docs]: /components/light.mochad/ +[light.osramlightify docs]: /components/light.osramlightify/ +[lock.nuki docs]: /components/lock.nuki/ +[lutron_caseta docs]: /components/lutron_caseta/ +[mailbox.demo docs]: /components/mailbox.demo/ +[mailbox.demo.txt docs]: /components/mailbox.demo.txt/ +[media_extractor docs]: /components/media_extractor/ +[media_player docs]: /components/media_player/ +[media_player.bluesound docs]: /components/media_player.bluesound/ +[media_player.cast docs]: /components/media_player.cast/ +[media_player.directv docs]: /components/media_player.directv/ +[media_player.kodi docs]: /components/media_player.kodi/ +[media_player.mpd docs]: /components/media_player.mpd/ +[media_player.russound_rio docs]: /components/media_player.russound_rio/ +[media_player.sonos docs]: /components/media_player.sonos/ +[media_player.squeezebox docs]: /components/media_player.squeezebox/ +[notify.pushbullet docs]: /components/notify.pushbullet/ +[notify.xmpp docs]: /components/notify.xmpp/ +[recorder docs]: /components/recorder/ +[recorder.migration docs]: /components/recorder.migration/ +[recorder.models docs]: /components/recorder.models/ +[recorder.purge docs]: /components/recorder.purge/ +[recorder.util docs]: /components/recorder.util/ +[remote docs]: /components/remote/ +[remote.apple_tv docs]: /components/remote.apple_tv/ +[remote.demo docs]: /components/remote.demo/ +[remote.harmony docs]: /components/remote.harmony/ +[remote.itach docs]: /components/remote.itach/ +[remote.kira docs]: /components/remote.kira/ +[rflink docs]: /components/rflink/ +[scene.lutron_caseta docs]: /components/scene.lutron_caseta/ +[sensor.asterisk_mbox docs]: /components/sensor.asterisk_mbox/ +[sensor.buienradar docs]: /components/sensor.buienradar/ +[sensor.command_line docs]: /components/sensor.command_line/ +[sensor.dyson docs]: /components/sensor.dyson/ +[sensor.efergy docs]: /components/sensor.efergy/ +[sensor.eight_sleep docs]: /components/sensor.eight_sleep/ +[sensor.geizhals docs]: /components/sensor.geizhals/ +[sensor.google_wifi docs]: /components/sensor.google_wifi/ +[sensor.lastfm docs]: /components/sensor.lastfm/ +[sensor.neato docs]: /components/sensor.neato/ +[sensor.pi_hole docs]: /components/sensor.pi_hole/ +[sensor.pocketcasts docs]: /components/sensor.pocketcasts/ +[sensor.radarr docs]: /components/sensor.radarr/ +[sensor.rest docs]: /components/sensor.rest/ +[sensor.sabnzbd docs]: /components/sensor.sabnzbd/ +[sensor.shodan docs]: /components/sensor.shodan/ +[sensor.sonarr docs]: /components/sensor.sonarr/ +[sensor.statistics docs]: /components/sensor.statistics/ +[sensor.supervisord docs]: /components/sensor.supervisord/ +[sensor.synologydsm docs]: /components/sensor.synologydsm/ +[sensor.systemmonitor docs]: /components/sensor.systemmonitor/ +[sensor.vasttrafik docs]: /components/sensor.vasttrafik/ +[sensor.yr docs]: /components/sensor.yr/ +[sensor.zamg docs]: /components/sensor.zamg/ +[switch.command_line docs]: /components/switch.command_line/ +[switch.mqtt docs]: /components/switch.mqtt/ +[switch.neato docs]: /components/switch.neato/ +[switch.rachio docs]: /components/switch.rachio/ +[switch.rainmachine docs]: /components/switch.rainmachine/ +[switch.wink docs]: /components/switch.wink/ +[switch.xiaomi_vacuum docs]: /components/switch.xiaomi_vacuum/ +[telegram_bot docs]: /components/telegram_bot/ +[updater docs]: /components/updater/ +[vacuum docs]: /components/vacuum/ +[vacuum.demo docs]: /components/vacuum.demo/ +[vacuum.dyson docs]: /components/vacuum.dyson/ +[vacuum.roomba docs]: /components/vacuum.roomba/ +[vacuum.xiaomi docs]: /components/vacuum.xiaomi/ +[weather.buienradar docs]: /components/weather.buienradar/ +[weather.yweather docs]: /components/weather.yweather/ +[weather.zamg docs]: /components/weather.zamg/ +[wink docs]: /components/wink/ +[zwave docs]: /components/zwave/ [forum]: https://community.home-assistant.io/ [issue]: https://github.com/home-assistant/home-assistant/issues [discord]: https://discord.gg/c5DvZ4e diff --git a/source/_posts/2017-08-26-release-0-52.markdown b/source/_posts/2017-08-26-release-0-52.markdown index c6bcb3e486..38e5e66151 100644 --- a/source/_posts/2017-08-26-release-0-52.markdown +++ b/source/_posts/2017-08-26-release-0-52.markdown @@ -303,85 +303,85 @@ usps: [@timstanley1985]: https://github.com/timstanley1985 [@tlyakhov]: https://github.com/tlyakhov [@w1ll1am23]: https://github.com/w1ll1am23 -[abode docs]: https://home-assistant.io/components/abode/ -[alarm_control_panel docs]: https://home-assistant.io/components/alarm_control_panel/ -[alarm_control_panel.abode docs]: https://home-assistant.io/components/alarm_control_panel.abode/ -[alarm_control_panel.egardia docs]: https://home-assistant.io/components/alarm_control_panel.egardia/ -[alarm_control_panel.simplisafe docs]: https://home-assistant.io/components/alarm_control_panel.simplisafe/ -[alarm_control_panel.totalconnect docs]: https://home-assistant.io/components/alarm_control_panel.totalconnect/ -[binary_sensor.abode docs]: https://home-assistant.io/components/binary_sensor.abode/ -[binary_sensor.mysensors docs]: https://home-assistant.io/components/binary_sensor.mysensors/ -[binary_sensor.workday docs]: https://home-assistant.io/components/binary_sensor.workday/ -[camera.usps docs]: https://home-assistant.io/components/camera.usps/ -[climate.mysensors docs]: https://home-assistant.io/components/climate.mysensors/ -[config docs]: https://home-assistant.io/components/config/ -[configurator docs]: https://home-assistant.io/components/configurator/ -[cover.mysensors docs]: https://home-assistant.io/components/cover.mysensors/ -[cover.template docs]: https://home-assistant.io/components/cover.template/ -[device_tracker.automatic docs]: https://home-assistant.io/components/device_tracker.automatic/ -[device_tracker.mysensors docs]: https://home-assistant.io/components/device_tracker.mysensors/ -[ecobee docs]: https://home-assistant.io/components/ecobee/ -[emulated_hue.upnp docs]: https://home-assistant.io/components/emulated_hue.upnp/ -[envisalink docs]: https://home-assistant.io/components/envisalink/ -[fan.isy994 docs]: https://home-assistant.io/components/fan.isy994/ -[image_processing.dlib_face_detect docs]: https://home-assistant.io/components/image_processing.dlib_face_detect/ -[image_processing.dlib_face_identify docs]: https://home-assistant.io/components/image_processing.dlib_face_identify/ -[insteon_plm docs]: https://home-assistant.io/components/insteon_plm/ -[light.decora_wifi docs]: https://home-assistant.io/components/light.decora_wifi/ -[light.flux_led docs]: https://home-assistant.io/components/light.flux_led/ -[light.hue docs]: https://home-assistant.io/components/light.hue/ -[light.lifx docs]: https://home-assistant.io/components/light.lifx/ -[light.mysensors docs]: https://home-assistant.io/components/light.mysensors/ -[light.rpi_gpio_pwm docs]: https://home-assistant.io/components/light.rpi_gpio_pwm/ -[light.tplink docs]: https://home-assistant.io/components/light.tplink/ -[light.yeelight docs]: https://home-assistant.io/components/light.yeelight/ -[lock.nello docs]: https://home-assistant.io/components/lock.nello/ -[media_extractor docs]: https://home-assistant.io/components/media_extractor/ -[media_player.mpd docs]: https://home-assistant.io/components/media_player.mpd/ -[media_player.onkyo docs]: https://home-assistant.io/components/media_player.onkyo/ -[media_player.snapcast docs]: https://home-assistant.io/components/media_player.snapcast/ -[media_player.spotify docs]: https://home-assistant.io/components/media_player.spotify/ -[media_player.squeezebox docs]: https://home-assistant.io/components/media_player.squeezebox/ -[media_player.webostv docs]: https://home-assistant.io/components/media_player.webostv/ -[mysensors docs]: https://home-assistant.io/components/mysensors/ -[notify.discord docs]: https://home-assistant.io/components/notify.discord/ -[notify.hipchat docs]: https://home-assistant.io/components/notify.hipchat/ -[notify.mysensors docs]: https://home-assistant.io/components/notify.mysensors/ -[notify.prowl docs]: https://home-assistant.io/components/notify.prowl/ -[notify.pushbullet docs]: https://home-assistant.io/components/notify.pushbullet/ -[notify.pushover docs]: https://home-assistant.io/components/notify.pushover/ -[notify.sendgrid docs]: https://home-assistant.io/components/notify.sendgrid/ -[notify.slack docs]: https://home-assistant.io/components/notify.slack/ -[octoprint docs]: https://home-assistant.io/components/octoprint/ -[prometheus docs]: https://home-assistant.io/components/prometheus/ -[script docs]: https://home-assistant.io/components/script/ -[sensor.buienradar docs]: https://home-assistant.io/components/sensor.buienradar/ -[sensor.cert_expiry docs]: https://home-assistant.io/components/sensor.cert_expiry/ -[sensor.eliqonline docs]: https://home-assistant.io/components/sensor.eliqonline/ -[sensor.fedex docs]: https://home-assistant.io/components/sensor.fedex/ -[sensor.fitbit docs]: https://home-assistant.io/components/sensor.fitbit/ -[sensor.fritzbox_callmonitor docs]: https://home-assistant.io/components/sensor.fritzbox_callmonitor/ -[sensor.geizhals docs]: https://home-assistant.io/components/sensor.geizhals/ -[sensor.ios docs]: https://home-assistant.io/components/sensor.ios/ -[sensor.london_air docs]: https://home-assistant.io/components/sensor.london_air/ -[sensor.mysensors docs]: https://home-assistant.io/components/sensor.mysensors/ -[sensor.netdata docs]: https://home-assistant.io/components/sensor.netdata/ -[sensor.octoprint docs]: https://home-assistant.io/components/sensor.octoprint/ -[sensor.snmp docs]: https://home-assistant.io/components/sensor.snmp/ -[sensor.swiss_public_transport docs]: https://home-assistant.io/components/sensor.swiss_public_transport/ -[sensor.uber docs]: https://home-assistant.io/components/sensor.uber/ -[sensor.uk_transport docs]: https://home-assistant.io/components/sensor.uk_transport/ -[sensor.usps docs]: https://home-assistant.io/components/sensor.usps/ -[sensor.version docs]: https://home-assistant.io/components/sensor.version/ -[sensor.worldtidesinfo docs]: https://home-assistant.io/components/sensor.worldtidesinfo/ -[switch.mqtt docs]: https://home-assistant.io/components/switch.mqtt/ -[switch.mysensors docs]: https://home-assistant.io/components/switch.mysensors/ -[switch.pilight docs]: https://home-assistant.io/components/switch.pilight/ -[switch.rainmachine docs]: https://home-assistant.io/components/switch.rainmachine/ -[switch.xiaomi docs]: https://home-assistant.io/components/switch.xiaomi/ -[usps docs]: https://home-assistant.io/components/usps/ -[weather.buienradar docs]: https://home-assistant.io/components/weather.buienradar/ -[xiaomi docs]: https://home-assistant.io/components/xiaomi/ +[abode docs]: /components/abode/ +[alarm_control_panel docs]: /components/alarm_control_panel/ +[alarm_control_panel.abode docs]: /components/alarm_control_panel.abode/ +[alarm_control_panel.egardia docs]: /components/alarm_control_panel.egardia/ +[alarm_control_panel.simplisafe docs]: /components/alarm_control_panel.simplisafe/ +[alarm_control_panel.totalconnect docs]: /components/alarm_control_panel.totalconnect/ +[binary_sensor.abode docs]: /components/binary_sensor.abode/ +[binary_sensor.mysensors docs]: /components/binary_sensor.mysensors/ +[binary_sensor.workday docs]: /components/binary_sensor.workday/ +[camera.usps docs]: /components/camera.usps/ +[climate.mysensors docs]: /components/climate.mysensors/ +[config docs]: /components/config/ +[configurator docs]: /components/configurator/ +[cover.mysensors docs]: /components/cover.mysensors/ +[cover.template docs]: /components/cover.template/ +[device_tracker.automatic docs]: /components/device_tracker.automatic/ +[device_tracker.mysensors docs]: /components/device_tracker.mysensors/ +[ecobee docs]: /components/ecobee/ +[emulated_hue.upnp docs]: /components/emulated_hue.upnp/ +[envisalink docs]: /components/envisalink/ +[fan.isy994 docs]: /components/fan.isy994/ +[image_processing.dlib_face_detect docs]: /components/image_processing.dlib_face_detect/ +[image_processing.dlib_face_identify docs]: /components/image_processing.dlib_face_identify/ +[insteon_plm docs]: /components/insteon_plm/ +[light.decora_wifi docs]: /components/light.decora_wifi/ +[light.flux_led docs]: /components/light.flux_led/ +[light.hue docs]: /components/light.hue/ +[light.lifx docs]: /components/light.lifx/ +[light.mysensors docs]: /components/light.mysensors/ +[light.rpi_gpio_pwm docs]: /components/light.rpi_gpio_pwm/ +[light.tplink docs]: /components/light.tplink/ +[light.yeelight docs]: /components/light.yeelight/ +[lock.nello docs]: /components/lock.nello/ +[media_extractor docs]: /components/media_extractor/ +[media_player.mpd docs]: /components/media_player.mpd/ +[media_player.onkyo docs]: /components/media_player.onkyo/ +[media_player.snapcast docs]: /components/media_player.snapcast/ +[media_player.spotify docs]: /components/media_player.spotify/ +[media_player.squeezebox docs]: /components/media_player.squeezebox/ +[media_player.webostv docs]: /components/media_player.webostv/ +[mysensors docs]: /components/mysensors/ +[notify.discord docs]: /components/notify.discord/ +[notify.hipchat docs]: /components/notify.hipchat/ +[notify.mysensors docs]: /components/notify.mysensors/ +[notify.prowl docs]: /components/notify.prowl/ +[notify.pushbullet docs]: /components/notify.pushbullet/ +[notify.pushover docs]: /components/notify.pushover/ +[notify.sendgrid docs]: /components/notify.sendgrid/ +[notify.slack docs]: /components/notify.slack/ +[octoprint docs]: /components/octoprint/ +[prometheus docs]: /components/prometheus/ +[script docs]: /components/script/ +[sensor.buienradar docs]: /components/sensor.buienradar/ +[sensor.cert_expiry docs]: /components/sensor.cert_expiry/ +[sensor.eliqonline docs]: /components/sensor.eliqonline/ +[sensor.fedex docs]: /components/sensor.fedex/ +[sensor.fitbit docs]: /components/sensor.fitbit/ +[sensor.fritzbox_callmonitor docs]: /components/sensor.fritzbox_callmonitor/ +[sensor.geizhals docs]: /components/sensor.geizhals/ +[sensor.ios docs]: /components/sensor.ios/ +[sensor.london_air docs]: /components/sensor.london_air/ +[sensor.mysensors docs]: /components/sensor.mysensors/ +[sensor.netdata docs]: /components/sensor.netdata/ +[sensor.octoprint docs]: /components/sensor.octoprint/ +[sensor.snmp docs]: /components/sensor.snmp/ +[sensor.swiss_public_transport docs]: /components/sensor.swiss_public_transport/ +[sensor.uber docs]: /components/sensor.uber/ +[sensor.uk_transport docs]: /components/sensor.uk_transport/ +[sensor.usps docs]: /components/sensor.usps/ +[sensor.version docs]: /components/sensor.version/ +[sensor.worldtidesinfo docs]: /components/sensor.worldtidesinfo/ +[switch.mqtt docs]: /components/switch.mqtt/ +[switch.mysensors docs]: /components/switch.mysensors/ +[switch.pilight docs]: /components/switch.pilight/ +[switch.rainmachine docs]: /components/switch.rainmachine/ +[switch.xiaomi docs]: /components/switch.xiaomi/ +[usps docs]: /components/usps/ +[weather.buienradar docs]: /components/weather.buienradar/ +[xiaomi docs]: /components/xiaomi/ [forum]: https://community.home-assistant.io/ [issue]: https://github.com/home-assistant/home-assistant/issues [discord]: https://discord.gg/c5DvZ4e @@ -395,6 +395,6 @@ usps: [#9191]: https://github.com/home-assistant/home-assistant/pull/9191 [@foxel]: https://github.com/foxel [@sdague]: https://github.com/sdague -[camera.foscam docs]: https://home-assistant.io/components/camera.foscam/ -[climate.ecobee docs]: https://home-assistant.io/components/climate.ecobee/ -[device_tracker.icloud docs]: https://home-assistant.io/components/device_tracker.icloud/ +[camera.foscam docs]: /components/camera.foscam/ +[climate.ecobee docs]: /components/climate.ecobee/ +[device_tracker.icloud docs]: /components/device_tracker.icloud/ diff --git a/source/_posts/2017-09-09-release-53.markdown b/source/_posts/2017-09-09-release-53.markdown index 51223765d4..7897969747 100644 --- a/source/_posts/2017-09-09-release-53.markdown +++ b/source/_posts/2017-09-09-release-53.markdown @@ -349,108 +349,108 @@ frontend: [@tinloaf]: https://github.com/tinloaf [@w1ll1am23]: https://github.com/w1ll1am23 [@zabuldon]: https://github.com/zabuldon -[abode docs]: https://home-assistant.io/components/abode/ -[alarm_control_panel.abode docs]: https://home-assistant.io/components/alarm_control_panel.abode/ -[alarm_control_panel.egardia docs]: https://home-assistant.io/components/alarm_control_panel.egardia/ -[alarm_control_panel.manual docs]: https://home-assistant.io/components/alarm_control_panel.manual/ -[binary_sensor.abode docs]: https://home-assistant.io/components/binary_sensor.abode/ -[binary_sensor.bayesian docs]: https://home-assistant.io/components/binary_sensor.bayesian/ -[binary_sensor.hikvision docs]: https://home-assistant.io/components/binary_sensor.hikvision/ -[binary_sensor.homematic docs]: https://home-assistant.io/components/binary_sensor.homematic/ -[binary_sensor.ring docs]: https://home-assistant.io/components/binary_sensor.ring/ -[binary_sensor.tesla docs]: https://home-assistant.io/components/binary_sensor.tesla/ -[binary_sensor.xiaomi docs]: https://home-assistant.io/components/binary_sensor.xiaomi/ -[binary_sensor.knx docs]: https://home-assistant.io/components/binary_sensor.knx/ -[climate.homematic docs]: https://home-assistant.io/components/climate.homematic/ -[climate.honeywell docs]: https://home-assistant.io/components/climate.honeywell/ -[climate.tesla docs]: https://home-assistant.io/components/climate.tesla/ -[climate.knx docs]: https://home-assistant.io/components/climate.knx/ -[cloud docs]: https://home-assistant.io/components/cloud/ -[cloud.cloud_api docs]: https://home-assistant.io/components/cloud.cloud_api/ -[cloud.const docs]: https://home-assistant.io/components/cloud.const/ -[cloud.http_api docs]: https://home-assistant.io/components/cloud.http_api/ -[cloud.util docs]: https://home-assistant.io/components/cloud.util/ -[config docs]: https://home-assistant.io/components/config/ -[config.customize docs]: https://home-assistant.io/components/config.customize/ -[counter docs]: https://home-assistant.io/components/counter/ -[cover.abode docs]: https://home-assistant.io/components/cover.abode/ -[cover.homematic docs]: https://home-assistant.io/components/cover.homematic/ -[cover.lutron_caseta docs]: https://home-assistant.io/components/cover.lutron_caseta/ -[cover.rfxtrx docs]: https://home-assistant.io/components/cover.rfxtrx/ -[cover.xiaomi docs]: https://home-assistant.io/components/cover.xiaomi/ -[cover.knx docs]: https://home-assistant.io/components/cover.knx/ -[device_tracker.automatic docs]: https://home-assistant.io/components/device_tracker.automatic/ -[device_tracker.geofency docs]: https://home-assistant.io/components/device_tracker.geofency/ -[device_tracker.tesla docs]: https://home-assistant.io/components/device_tracker.tesla/ -[device_tracker.volvooncall docs]: https://home-assistant.io/components/device_tracker.volvooncall/ -[hdmi_cec docs]: https://home-assistant.io/components/hdmi_cec/ -[homematic docs]: https://home-assistant.io/components/homematic/ -[image_processing.dlib_face_detect docs]: https://home-assistant.io/components/image_processing.dlib_face_detect/ -[image_processing.dlib_face_identify docs]: https://home-assistant.io/components/image_processing.dlib_face_identify/ -[input_text docs]: https://home-assistant.io/components/input_text/ -[insteon_plm docs]: https://home-assistant.io/components/insteon_plm/ -[light.homematic docs]: https://home-assistant.io/components/light.homematic/ -[light.hue docs]: https://home-assistant.io/components/light.hue/ -[light.lutron_caseta docs]: https://home-assistant.io/components/light.lutron_caseta/ -[light.mqtt docs]: https://home-assistant.io/components/light.mqtt/ -[light.xiaomi_philipslight docs]: https://home-assistant.io/components/light.xiaomi_philipslight/ -[light.rfxtrx docs]: https://home-assistant.io/components/light.rfxtrx/ -[light.tradfri docs]: https://home-assistant.io/components/light.tradfri/ -[light.knx docs]: https://home-assistant.io/components/light.knx/ -[light.zha docs]: https://home-assistant.io/components/light.zha/ -[lock.abode docs]: https://home-assistant.io/components/lock.abode/ -[lock.nello docs]: https://home-assistant.io/components/lock.nello/ -[lock.tesla docs]: https://home-assistant.io/components/lock.tesla/ -[lutron_caseta docs]: https://home-assistant.io/components/lutron_caseta/ -[media_extractor docs]: https://home-assistant.io/components/media_extractor/ -[media_player.denonavr docs]: https://home-assistant.io/components/media_player.denonavr/ -[media_player.directv docs]: https://home-assistant.io/components/media_player.directv/ -[media_player.sonos docs]: https://home-assistant.io/components/media_player.sonos/ -[media_player.spotify docs]: https://home-assistant.io/components/media_player.spotify/ -[media_player.yamaha_musiccast docs]: https://home-assistant.io/components/media_player.yamaha_musiccast/ -[mycroft docs]: https://home-assistant.io/components/mycroft/ -[mysensors docs]: https://home-assistant.io/components/mysensors/ -[notify.discord docs]: https://home-assistant.io/components/notify.discord/ -[notify.mycroft docs]: https://home-assistant.io/components/notify.mycroft/ -[notify.pushbullet docs]: https://home-assistant.io/components/notify.pushbullet/ -[notify.sendgrid docs]: https://home-assistant.io/components/notify.sendgrid/ -[notify.twitter docs]: https://home-assistant.io/components/notify.twitter/ -[notify.xmpp docs]: https://home-assistant.io/components/notify.xmpp/ -[rfxtrx docs]: https://home-assistant.io/components/rfxtrx/ -[sensor.airvisual docs]: https://home-assistant.io/components/sensor.airvisual/ -[sensor.buienradar docs]: https://home-assistant.io/components/sensor.buienradar/ -[sensor.dht docs]: https://home-assistant.io/components/sensor.dht/ -[sensor.dwdwarnapp docs]: https://home-assistant.io/components/sensor.dwdwarnapp/ -[sensor.fitbit docs]: https://home-assistant.io/components/sensor.fitbit/ -[sensor.homematic docs]: https://home-assistant.io/components/sensor.homematic/ -[sensor.mopar docs]: https://home-assistant.io/components/sensor.mopar/ -[sensor.radarr docs]: https://home-assistant.io/components/sensor.radarr/ -[sensor.season docs]: https://home-assistant.io/components/sensor.season/ -[sensor.shodan docs]: https://home-assistant.io/components/sensor.shodan/ -[sensor.sonarr docs]: https://home-assistant.io/components/sensor.sonarr/ -[sensor.statistics docs]: https://home-assistant.io/components/sensor.statistics/ -[sensor.systemmonitor docs]: https://home-assistant.io/components/sensor.systemmonitor/ -[sensor.tank_utility docs]: https://home-assistant.io/components/sensor.tank_utility/ -[sensor.tesla docs]: https://home-assistant.io/components/sensor.tesla/ -[sensor.uber docs]: https://home-assistant.io/components/sensor.uber/ -[sensor.worldtidesinfo docs]: https://home-assistant.io/components/sensor.worldtidesinfo/ -[sensor.knx docs]: https://home-assistant.io/components/sensor.knx/ -[snips docs]: https://home-assistant.io/components/snips/ -[switch.abode docs]: https://home-assistant.io/components/switch.abode/ -[switch.digitalloggers docs]: https://home-assistant.io/components/switch.digitalloggers/ -[switch.dlink docs]: https://home-assistant.io/components/switch.dlink/ -[switch.homematic docs]: https://home-assistant.io/components/switch.homematic/ -[switch.lutron_caseta docs]: https://home-assistant.io/components/switch.lutron_caseta/ -[switch.rest docs]: https://home-assistant.io/components/switch.rest/ -[switch.rfxtrx docs]: https://home-assistant.io/components/switch.rfxtrx/ -[switch.knx docs]: https://home-assistant.io/components/switch.knx/ -[telegram_bot docs]: https://home-assistant.io/components/telegram_bot/ -[tesla docs]: https://home-assistant.io/components/tesla/ -[tradfri docs]: https://home-assistant.io/components/tradfri/ -[volvooncall docs]: https://home-assistant.io/components/volvooncall/ -[xiaomi docs]: https://home-assistant.io/components/xiaomi/ -[knx docs]: https://home-assistant.io/components/knx/ -[zwave docs]: https://home-assistant.io/components/zwave/ +[abode docs]: /components/abode/ +[alarm_control_panel.abode docs]: /components/alarm_control_panel.abode/ +[alarm_control_panel.egardia docs]: /components/alarm_control_panel.egardia/ +[alarm_control_panel.manual docs]: /components/alarm_control_panel.manual/ +[binary_sensor.abode docs]: /components/binary_sensor.abode/ +[binary_sensor.bayesian docs]: /components/binary_sensor.bayesian/ +[binary_sensor.hikvision docs]: /components/binary_sensor.hikvision/ +[binary_sensor.homematic docs]: /components/binary_sensor.homematic/ +[binary_sensor.ring docs]: /components/binary_sensor.ring/ +[binary_sensor.tesla docs]: /components/binary_sensor.tesla/ +[binary_sensor.xiaomi docs]: /components/binary_sensor.xiaomi/ +[binary_sensor.knx docs]: /components/binary_sensor.knx/ +[climate.homematic docs]: /components/climate.homematic/ +[climate.honeywell docs]: /components/climate.honeywell/ +[climate.tesla docs]: /components/climate.tesla/ +[climate.knx docs]: /components/climate.knx/ +[cloud docs]: /components/cloud/ +[cloud.cloud_api docs]: /components/cloud.cloud_api/ +[cloud.const docs]: /components/cloud.const/ +[cloud.http_api docs]: /components/cloud.http_api/ +[cloud.util docs]: /components/cloud.util/ +[config docs]: /components/config/ +[config.customize docs]: /components/config.customize/ +[counter docs]: /components/counter/ +[cover.abode docs]: /components/cover.abode/ +[cover.homematic docs]: /components/cover.homematic/ +[cover.lutron_caseta docs]: /components/cover.lutron_caseta/ +[cover.rfxtrx docs]: /components/cover.rfxtrx/ +[cover.xiaomi docs]: /components/cover.xiaomi/ +[cover.knx docs]: /components/cover.knx/ +[device_tracker.automatic docs]: /components/device_tracker.automatic/ +[device_tracker.geofency docs]: /components/device_tracker.geofency/ +[device_tracker.tesla docs]: /components/device_tracker.tesla/ +[device_tracker.volvooncall docs]: /components/device_tracker.volvooncall/ +[hdmi_cec docs]: /components/hdmi_cec/ +[homematic docs]: /components/homematic/ +[image_processing.dlib_face_detect docs]: /components/image_processing.dlib_face_detect/ +[image_processing.dlib_face_identify docs]: /components/image_processing.dlib_face_identify/ +[input_text docs]: /components/input_text/ +[insteon_plm docs]: /components/insteon_plm/ +[light.homematic docs]: /components/light.homematic/ +[light.hue docs]: /components/light.hue/ +[light.lutron_caseta docs]: /components/light.lutron_caseta/ +[light.mqtt docs]: /components/light.mqtt/ +[light.xiaomi_philipslight docs]: /components/light.xiaomi_philipslight/ +[light.rfxtrx docs]: /components/light.rfxtrx/ +[light.tradfri docs]: /components/light.tradfri/ +[light.knx docs]: /components/light.knx/ +[light.zha docs]: /components/light.zha/ +[lock.abode docs]: /components/lock.abode/ +[lock.nello docs]: /components/lock.nello/ +[lock.tesla docs]: /components/lock.tesla/ +[lutron_caseta docs]: /components/lutron_caseta/ +[media_extractor docs]: /components/media_extractor/ +[media_player.denonavr docs]: /components/media_player.denonavr/ +[media_player.directv docs]: /components/media_player.directv/ +[media_player.sonos docs]: /components/media_player.sonos/ +[media_player.spotify docs]: /components/media_player.spotify/ +[media_player.yamaha_musiccast docs]: /components/media_player.yamaha_musiccast/ +[mycroft docs]: /components/mycroft/ +[mysensors docs]: /components/mysensors/ +[notify.discord docs]: /components/notify.discord/ +[notify.mycroft docs]: /components/notify.mycroft/ +[notify.pushbullet docs]: /components/notify.pushbullet/ +[notify.sendgrid docs]: /components/notify.sendgrid/ +[notify.twitter docs]: /components/notify.twitter/ +[notify.xmpp docs]: /components/notify.xmpp/ +[rfxtrx docs]: /components/rfxtrx/ +[sensor.airvisual docs]: /components/sensor.airvisual/ +[sensor.buienradar docs]: /components/sensor.buienradar/ +[sensor.dht docs]: /components/sensor.dht/ +[sensor.dwdwarnapp docs]: /components/sensor.dwdwarnapp/ +[sensor.fitbit docs]: /components/sensor.fitbit/ +[sensor.homematic docs]: /components/sensor.homematic/ +[sensor.mopar docs]: /components/sensor.mopar/ +[sensor.radarr docs]: /components/sensor.radarr/ +[sensor.season docs]: /components/sensor.season/ +[sensor.shodan docs]: /components/sensor.shodan/ +[sensor.sonarr docs]: /components/sensor.sonarr/ +[sensor.statistics docs]: /components/sensor.statistics/ +[sensor.systemmonitor docs]: /components/sensor.systemmonitor/ +[sensor.tank_utility docs]: /components/sensor.tank_utility/ +[sensor.tesla docs]: /components/sensor.tesla/ +[sensor.uber docs]: /components/sensor.uber/ +[sensor.worldtidesinfo docs]: /components/sensor.worldtidesinfo/ +[sensor.knx docs]: /components/sensor.knx/ +[snips docs]: /components/snips/ +[switch.abode docs]: /components/switch.abode/ +[switch.digitalloggers docs]: /components/switch.digitalloggers/ +[switch.dlink docs]: /components/switch.dlink/ +[switch.homematic docs]: /components/switch.homematic/ +[switch.lutron_caseta docs]: /components/switch.lutron_caseta/ +[switch.rest docs]: /components/switch.rest/ +[switch.rfxtrx docs]: /components/switch.rfxtrx/ +[switch.knx docs]: /components/switch.knx/ +[telegram_bot docs]: /components/telegram_bot/ +[tesla docs]: /components/tesla/ +[tradfri docs]: /components/tradfri/ +[volvooncall docs]: /components/volvooncall/ +[xiaomi docs]: /components/xiaomi/ +[knx docs]: /components/knx/ +[zwave docs]: /components/zwave/ [forum]: https://community.home-assistant.io/ [issue]: https://github.com/home-assistant/home-assistant/issues [discord]: https://discord.gg/c5DvZ4e @@ -458,5 +458,5 @@ frontend: [#9380]: https://github.com/home-assistant/home-assistant/pull/9380 [#9387]: https://github.com/home-assistant/home-assistant/pull/9387 [@viswa-swami]: https://github.com/viswa-swami -[camera.foscam docs]: https://home-assistant.io/components/camera.foscam/ -[sensor.wunderground docs]: https://home-assistant.io/components/sensor.wunderground/ +[camera.foscam docs]: /components/camera.foscam/ +[sensor.wunderground docs]: /components/sensor.wunderground/ diff --git a/source/_posts/2017-09-16-hassbian-1.3-a-bit-of-a-stretch.markdown b/source/_posts/2017-09-16-hassbian-1.3-a-bit-of-a-stretch.markdown index 8d1c4732c8..e601496765 100644 --- a/source/_posts/2017-09-16-hassbian-1.3-a-bit-of-a-stretch.markdown +++ b/source/_posts/2017-09-16-hassbian-1.3-a-bit-of-a-stretch.markdown @@ -18,9 +18,9 @@ To allow you to customize your installation further, we have made a few addition #### {% linkable_title Upgrade scripts %} -[@Ludeeus][ludeeus] contributed the possibility to run upgrade scripts to the `hassbian-config` tool. +[@Ludeeus][ludeeus] contributed the possibility to run upgrade scripts to the `hassbian-config` tool. - - Upgrade Hassbian: Upgrades packages of the base operating system. Contributed by [@Landrash][landrash]. + - Upgrade Hassbian: Upgrades packages of the base operating system. Contributed by [@Landrash][landrash]. - Upgrade Hassbian-script: Downloads and upgrades the latest release of Hassbian-scripts. Contributed by [@Ludeeus][ludeeus]. - Upgrade Home-assistant: Upgrades the Home Assistant installation to the latest release. Contributed by [@Ludeeus][ludeeus]. @@ -28,9 +28,9 @@ To follow discussions about the development of the HASSbian image or to contribu To get started with the new image, check out the installation instructions on the [installing Hassbian page][install]. -[landrash]: http://github.com/landrash +[landrash]: http://github.com/landrash [ludeeus]: http://github.com/ludeeus [hassbian-repo]: https://github.com/home-assistant/hassbian-scripts/ [hassbian-config-release]: https://github.com/home-assistant/hassbian-scripts/releases/latest -[install]: https://home-assistant.io/docs/installation/hassbian/installation/ +[install]: /docs/installation/hassbian/installation/ [discord-hassbian]: https://discord.gg/RkajcgS diff --git a/source/_posts/2017-09-29-hacktoberfest.markdown b/source/_posts/2017-09-29-hacktoberfest.markdown index a57eaba03f..58a15d94cd 100644 --- a/source/_posts/2017-09-29-hacktoberfest.markdown +++ b/source/_posts/2017-09-29-hacktoberfest.markdown @@ -42,5 +42,5 @@ Our participation for [Hacktoberfest 2016][hackt-2016] was a huge success. Join [dev-env]: /developers/development_environment/ [dev-chat]: https://discord.gg/8X8DTH4 [dev-forum]: https://community.home-assistant.io/c/development -[hackt-2016]: https://home-assistant.io/blog/2016/11/05/hacktoberfest-influxdb-weather/#hacktoberfest +[hackt-2016]: /blog/2016/11/05/hacktoberfest-influxdb-weather/#hacktoberfest diff --git a/source/_posts/2017-10-07-release-55.markdown b/source/_posts/2017-10-07-release-55.markdown index 6517546712..6d1c6b36da 100644 --- a/source/_posts/2017-10-07-release-55.markdown +++ b/source/_posts/2017-10-07-release-55.markdown @@ -16,7 +16,7 @@ og_image: /images/blog/2017-10-0.55/components.png Beside the improved Wink support which was contributed by [@w1ll1am23], ships this release a wide variety of new components and platforms. The `input_slider` components has received a makeover by [@BioSehnsucht] and is now [`input_number`][input_number docs]. [@tinloaf] added a feature that allows you to enter dates: [`input_datetime`][input_datetime docs]. Both will help you to improve your automation rules. ## {% linkable_title DuckDNS %} -Using Home Assistant with [DuckDNS](http://www.duckdns.org) for Dynamic DNS (DDNS or DynDNS) is an [old story](https://home-assistant.io/blog/2015/12/13/setup-encryption-using-lets-encrypt/). DuckDNS is also integrated in [Hass.io](https://home-assistant.io/addons/duckdns/). 0.55 ships a component for non Hass.io users to get a similar feature. +Using Home Assistant with [DuckDNS](http://www.duckdns.org) for Dynamic DNS (DDNS or DynDNS) is an [old story](/blog/2015/12/13/setup-encryption-using-lets-encrypt/). DuckDNS is also integrated in [Hass.io](/addons/duckdns/). 0.55 ships a component for non Hass.io users to get a similar feature. ## {% linkable_title Recorder %} The purging of data was [improved][recorder docs]. With `purge_interval` you can schedule regular purges of older events and states. In combination you can specify with `purge_keep_days` the amount of days you want to keep. The new service `recorder.purge` allows you to handle this task when needed. @@ -305,92 +305,92 @@ Experiencing issues introduced by this release? Please report them in our [issue [@tinloaf]: https://github.com/tinloaf [@vickyg3]: https://github.com/vickyg3 [@w1ll1am23]: https://github.com/w1ll1am23 -[abode docs]: https://home-assistant.io/components/abode/ -[alarm_control_panel.egardia docs]: https://home-assistant.io/components/alarm_control_panel.egardia/ -[alarm_control_panel.manual_mqtt docs]: https://home-assistant.io/components/alarm_control_panel.manual_mqtt/ -[alexa.smart_home docs]: https://home-assistant.io/components/alexa/ -[apple_tv docs]: https://home-assistant.io/components/apple_tv/ -[arlo docs]: https://home-assistant.io/components/arlo/ -[binary_sensor.raincloud docs]: https://home-assistant.io/components/binary_sensor.raincloud/ -[binary_sensor.threshold docs]: https://home-assistant.io/components/binary_sensor.threshold/ -[binary_sensor.wink docs]: https://home-assistant.io/components/binary_sensor.wink/ -[camera.arlo docs]: https://home-assistant.io/components/camera.arlo/ -[camera.synology docs]: https://home-assistant.io/components/camera.synology/ -[camera.usps docs]: https://home-assistant.io/components/camera.usps/ -[climate.ecobee docs]: https://home-assistant.io/components/climate.ecobee/ -[climate.mqtt docs]: https://home-assistant.io/components/climate.mqtt/ -[cover.mqtt docs]: https://home-assistant.io/components/cover.mqtt/ -[cover.rflink docs]: https://home-assistant.io/components/cover.rflink/ -[demo docs]: https://home-assistant.io/components/demo/ -[device_tracker.owntracks docs]: https://home-assistant.io/components/device_tracker.owntracks/ -[device_tracker.owntracks_http docs]: https://home-assistant.io/components/device_tracker.owntracks_http/ -[duckdns docs]: https://home-assistant.io/components/duckdns/ -[ecobee docs]: https://home-assistant.io/components/ecobee/ -[emulated_hue docs]: https://home-assistant.io/components/emulated_hue/ -[google docs]: https://home-assistant.io/components/calendar.google/ -[group docs]: https://home-assistant.io/components/group/ -[hassio docs]: https://home-assistant.io/hassio/ -[history docs]: https://home-assistant.io/components/history/ -[homematic docs]: https://home-assistant.io/components/homematic/ -[http docs]: https://home-assistant.io/components/http/ -[image_processing.opencv docs]: https://home-assistant.io/components/image_processing.opencv/ -[influxdb docs]: https://home-assistant.io/components/influxdb/ -[input_datetime docs]: https://home-assistant.io/components/input_datetime/ -[input_number docs]: https://home-assistant.io/components/input_number/ -[light.flux_led docs]: https://home-assistant.io/components/light.flux_led/ -[light.rflink docs]: https://home-assistant.io/components/light.rflink/ -[light.tradfri docs]: https://home-assistant.io/components/light.tradfri/ -[light.yeelight docs]: https://home-assistant.io/components/light.yeelight/ -[lock.wink docs]: https://home-assistant.io/components/lock.wink/ -[media_extractor docs]: https://home-assistant.io/components/media_extractor/ -[media_player.apple_tv docs]: https://home-assistant.io/components/media_player.apple_tv/ -[media_player.webostv docs]: https://home-assistant.io/components/media_player.webostv/ -[media_player.yamaha_musiccast docs]: https://home-assistant.io/components/media_player.yamaha_musiccast/ -[mqtt_statestream docs]: https://home-assistant.io/components/mqtt_statestream/ -[notify.clicksendaudio docs]: https://home-assistant.io/components/notify.clicksendaudio/ -[notify.discord docs]: https://home-assistant.io/components/notify.discord/ -[notify.facebook docs]: https://home-assistant.io/components/notify.facebook/ -[notify.simplepush docs]: https://home-assistant.io/components/notify.simplepush/ -[raincloud docs]: https://home-assistant.io/components/raincloud/ -[raspihats docs]: https://home-assistant.io/components/raspihats/ -[recorder docs]: https://home-assistant.io/components/recorder/ -[remote.itach docs]: https://home-assistant.io/components/remote.itach/ -[rflink docs]: https://home-assistant.io/components/rflink/ -[sensor.airvisual docs]: https://home-assistant.io/components/sensor.airvisual/ -[sensor.arlo docs]: https://home-assistant.io/components/sensor.arlo/ -[sensor.comed_hourly_pricing docs]: https://home-assistant.io/components/sensor.comed_hourly_pricing/ -[sensor.dsmr docs]: https://home-assistant.io/components/sensor.dsmr/ -[sensor.fedex docs]: https://home-assistant.io/components/sensor.fedex/ -[sensor.geo_rss_events docs]: https://home-assistant.io/components/sensor.geo_rss_events/ -[sensor.google_travel_time docs]: https://home-assistant.io/components/sensor.google_travel_time/ -[sensor.imap docs]: https://home-assistant.io/components/sensor.imap/ -[sensor.lyft docs]: https://home-assistant.io/components/sensor.lyft/ -[sensor.onewire docs]: https://home-assistant.io/components/sensor.onewire/ -[sensor.pvoutput docs]: https://home-assistant.io/components/sensor.pvoutput/ -[sensor.raincloud docs]: https://home-assistant.io/components/sensor.raincloud/ -[sensor.systemmonitor docs]: https://home-assistant.io/components/sensor.systemmonitor/ -[sensor.thethingsnetwork docs]: https://home-assistant.io/components/sensor.thethingsnetwork/ -[sensor.tibber docs]: https://home-assistant.io/components/sensor.tibber/ -[sensor.ups docs]: https://home-assistant.io/components/sensor.ups/ -[sensor.usps docs]: https://home-assistant.io/components/sensor.usps/ -[sensor.vera docs]: https://home-assistant.io/components/sensor.vera/ -[sensor.wunderground docs]: https://home-assistant.io/components/sensor.wunderground/ -[splunk docs]: https://home-assistant.io/components/splunk/ -[switch.abode docs]: https://home-assistant.io/components/switch.abode/ -[switch.raincloud docs]: https://home-assistant.io/components/switch.raincloud/ -[switch.rflink docs]: https://home-assistant.io/components/switch.rflink/ -[switch.tplink docs]: https://home-assistant.io/components/switch.tplink/ -[thethingsnetwork docs]: https://home-assistant.io/components/thethingsnetwork/ -[tradfri docs]: https://home-assistant.io/components/tradfri/ -[upnp docs]: https://home-assistant.io/components/upnp/ -[usps docs]: https://home-assistant.io/components/usps/ -[vacuum.xiaomi docs]: https://home-assistant.io/components/vacuum.xiaomi_miio/ -[wink docs]: https://home-assistant.io/components/wink/ -[zwave docs]: https://home-assistant.io/components/zwave/ +[abode docs]: /components/abode/ +[alarm_control_panel.egardia docs]: /components/alarm_control_panel.egardia/ +[alarm_control_panel.manual_mqtt docs]: /components/alarm_control_panel.manual_mqtt/ +[alexa.smart_home docs]: /components/alexa/ +[apple_tv docs]: /components/apple_tv/ +[arlo docs]: /components/arlo/ +[binary_sensor.raincloud docs]: /components/binary_sensor.raincloud/ +[binary_sensor.threshold docs]: /components/binary_sensor.threshold/ +[binary_sensor.wink docs]: /components/binary_sensor.wink/ +[camera.arlo docs]: /components/camera.arlo/ +[camera.synology docs]: /components/camera.synology/ +[camera.usps docs]: /components/camera.usps/ +[climate.ecobee docs]: /components/climate.ecobee/ +[climate.mqtt docs]: /components/climate.mqtt/ +[cover.mqtt docs]: /components/cover.mqtt/ +[cover.rflink docs]: /components/cover.rflink/ +[demo docs]: /components/demo/ +[device_tracker.owntracks docs]: /components/device_tracker.owntracks/ +[device_tracker.owntracks_http docs]: /components/device_tracker.owntracks_http/ +[duckdns docs]: /components/duckdns/ +[ecobee docs]: /components/ecobee/ +[emulated_hue docs]: /components/emulated_hue/ +[google docs]: /components/calendar.google/ +[group docs]: /components/group/ +[hassio docs]: /hassio/ +[history docs]: /components/history/ +[homematic docs]: /components/homematic/ +[http docs]: /components/http/ +[image_processing.opencv docs]: /components/image_processing.opencv/ +[influxdb docs]: /components/influxdb/ +[input_datetime docs]: /components/input_datetime/ +[input_number docs]: /components/input_number/ +[light.flux_led docs]: /components/light.flux_led/ +[light.rflink docs]: /components/light.rflink/ +[light.tradfri docs]: /components/light.tradfri/ +[light.yeelight docs]: /components/light.yeelight/ +[lock.wink docs]: /components/lock.wink/ +[media_extractor docs]: /components/media_extractor/ +[media_player.apple_tv docs]: /components/media_player.apple_tv/ +[media_player.webostv docs]: /components/media_player.webostv/ +[media_player.yamaha_musiccast docs]: /components/media_player.yamaha_musiccast/ +[mqtt_statestream docs]: /components/mqtt_statestream/ +[notify.clicksendaudio docs]: /components/notify.clicksendaudio/ +[notify.discord docs]: /components/notify.discord/ +[notify.facebook docs]: /components/notify.facebook/ +[notify.simplepush docs]: /components/notify.simplepush/ +[raincloud docs]: /components/raincloud/ +[raspihats docs]: /components/raspihats/ +[recorder docs]: /components/recorder/ +[remote.itach docs]: /components/remote.itach/ +[rflink docs]: /components/rflink/ +[sensor.airvisual docs]: /components/sensor.airvisual/ +[sensor.arlo docs]: /components/sensor.arlo/ +[sensor.comed_hourly_pricing docs]: /components/sensor.comed_hourly_pricing/ +[sensor.dsmr docs]: /components/sensor.dsmr/ +[sensor.fedex docs]: /components/sensor.fedex/ +[sensor.geo_rss_events docs]: /components/sensor.geo_rss_events/ +[sensor.google_travel_time docs]: /components/sensor.google_travel_time/ +[sensor.imap docs]: /components/sensor.imap/ +[sensor.lyft docs]: /components/sensor.lyft/ +[sensor.onewire docs]: /components/sensor.onewire/ +[sensor.pvoutput docs]: /components/sensor.pvoutput/ +[sensor.raincloud docs]: /components/sensor.raincloud/ +[sensor.systemmonitor docs]: /components/sensor.systemmonitor/ +[sensor.thethingsnetwork docs]: /components/sensor.thethingsnetwork/ +[sensor.tibber docs]: /components/sensor.tibber/ +[sensor.ups docs]: /components/sensor.ups/ +[sensor.usps docs]: /components/sensor.usps/ +[sensor.vera docs]: /components/sensor.vera/ +[sensor.wunderground docs]: /components/sensor.wunderground/ +[splunk docs]: /components/splunk/ +[switch.abode docs]: /components/switch.abode/ +[switch.raincloud docs]: /components/switch.raincloud/ +[switch.rflink docs]: /components/switch.rflink/ +[switch.tplink docs]: /components/switch.tplink/ +[thethingsnetwork docs]: /components/thethingsnetwork/ +[tradfri docs]: /components/tradfri/ +[upnp docs]: /components/upnp/ +[usps docs]: /components/usps/ +[vacuum.xiaomi docs]: /components/vacuum.xiaomi_miio/ +[wink docs]: /components/wink/ +[zwave docs]: /components/zwave/ [forum]: https://community.home-assistant.io/ [issue]: https://github.com/home-assistant/home-assistant/issues [discord]: https://discord.gg/c5DvZ4e -[history_graph docs]: https://home-assistant.io/components/history_graph/ +[history_graph docs]: /components/history_graph/ [#9754]: https://github.com/home-assistant/home-assistant/pull/9754 [#9776]: https://github.com/home-assistant/home-assistant/pull/9776 [#9785]: https://github.com/home-assistant/home-assistant/pull/9785 @@ -404,9 +404,9 @@ Experiencing issues introduced by this release? Please report them in our [issue [@passie]: https://github.com/passie [@pschmitt]: https://github.com/pschmitt [@snjoetw]: https://github.com/snjoetw -[camera.synology docs]: https://home-assistant.io/components/camera.synology/ -[cover.rflink docs]: https://home-assistant.io/components/cover.rflink/ -[device_tracker.owntracks docs]: https://home-assistant.io/components/device_tracker.owntracks/ -[google docs]: https://home-assistant.io/components/google/ -[light.tradfri docs]: https://home-assistant.io/components/light.tradfri/ -[media_player.liveboxplaytv docs]: https://home-assistant.io/components/media_player.liveboxplaytv/ +[camera.synology docs]: /components/camera.synology/ +[cover.rflink docs]: /components/cover.rflink/ +[device_tracker.owntracks docs]: /components/device_tracker.owntracks/ +[google docs]: /components/google/ +[light.tradfri docs]: /components/light.tradfri/ +[media_player.liveboxplaytv docs]: /components/media_player.liveboxplaytv/ diff --git a/source/_posts/2017-10-21-release-56.markdown b/source/_posts/2017-10-21-release-56.markdown index 97699b6b47..33c6472628 100644 --- a/source/_posts/2017-10-21-release-56.markdown +++ b/source/_posts/2017-10-21-release-56.markdown @@ -16,23 +16,23 @@ og_image: /images/blog/2017-10-0.56/components.png We reached another milestone aka number: 10000. GitHub is assigning numbers to pull requests and issues and the "10000" is a [PR](https://github.com/home-assistant/home-assistant/pull/10000). Our ratio is around 1/3 issues and 2/3 pull requests. To be more precise: 64% pull requests and 36% issues. -If you haven't noticed, there is now a [glossary](https://home-assistant.io/docs/glossary/) that collects some Home Assistant relevant terms. Talking about the documentation: [@DubhAd](https://github.com/DubhAd) rewrote large parts of the [Z-Wave section](https://home-assistant.io/docs/z-wave/). More structure to get started and to find details during the setup and the configuration. +If you haven't noticed, there is now a [glossary](/docs/glossary/) that collects some Home Assistant relevant terms. Talking about the documentation: [@DubhAd](https://github.com/DubhAd) rewrote large parts of the [Z-Wave section](/docs/z-wave/). More structure to get started and to find details during the setup and the configuration. ## {% linkable_title Google Assistant / Google Home integration %} This release includes a new component to integrate Home Assistant with Google Assistant by [Phil Kates][@philk]. We integrate via the Smart Home API, this means that you will be able to control your devices in Home Assistant via any device that has Google Assistant. Learn more in [the documentation][google_assistant docs]. ## {% linkable_title Hacktoberfest %} -[Hacktoberfest](https://home-assistant.io/blog/2017/09/29/hacktoberfest/) is still on and so far we have received a lot improvements. We can't make any promises to review everything by the end of October, but we are trying to make sure that you will get your t-shirt. +[Hacktoberfest](/blog/2017/09/29/hacktoberfest/) is still on and so far we have received a lot improvements. We can't make any promises to review everything by the end of October, but we are trying to make sure that you will get your t-shirt. ## {% linkable_title Map %} -The [map][map docs] is now its own component. Similar to [configuration (`config:`)](https://home-assistant.io/components/config/), it will not show up without adding it to your `configuration.yaml` file. +The [map][map docs] is now its own component. Similar to [configuration (`config:`)](/components/config/), it will not show up without adding it to your `configuration.yaml` file. ```yaml map: ``` ## {% linkable_title Travis CI %} -Why not observe your [Travis CI](https://travis-ci.org) jobs with Home Assistant? [@tchellomello] created a [Travis CI][sensor.travisci docs] sensor which allows one to check on the current state of Travis jobs. Now you can make sure that the [coffee](https://home-assistant.io/blog/2017/01/28/face-coffee-wink/#first-coffee-maker-supported) is ready when the build passed. +Why not observe your [Travis CI](https://travis-ci.org) jobs with Home Assistant? [@tchellomello] created a [Travis CI][sensor.travisci docs] sensor which allows one to check on the current state of Travis jobs. Now you can make sure that the [coffee](/blog/2017/01/28/face-coffee-wink/#first-coffee-maker-supported) is ready when the build passed. ## {% linkable_title New Platforms %} @@ -416,133 +416,133 @@ Experiencing issues introduced by this release? Please report them in our [issue [@webworxshop]: https://github.com/webworxshop [@zabuldon]: https://github.com/zabuldon [@ziotibia81]: https://github.com/ziotibia81 -[__init__ docs]: https://home-assistant.io/components/__init__/ -[abode docs]: https://home-assistant.io/components/abode/ -[alarm_control_panel.arlo docs]: https://home-assistant.io/components/alarm_control_panel.arlo/ -[alarm_control_panel.egardia docs]: https://home-assistant.io/components/alarm_control_panel.egardia/ -[alexa.smart_home docs]: https://home-assistant.io/components/alexa.smart_home/ -[arlo docs]: https://home-assistant.io/components/arlo/ -[automation.event docs]: https://home-assistant.io/docs/automation/trigger/#event-trigger -[automation.numeric_state docs]: https://home-assistant.io/docs/automation/trigger/#numeric-state-trigger -[automation.state docs]: https://home-assistant.io/docs/automation/trigger/#state-trigger -[binary_sensor.iss docs]: https://home-assistant.io/components/binary_sensor.iss/ -[binary_sensor.netatmo docs]: https://home-assistant.io/components/binary_sensor.netatmo/ -[binary_sensor.skybell docs]: https://home-assistant.io/components/binary_sensor.skybell/ -[binary_sensor.template docs]: https://home-assistant.io/components/binary_sensor.template/ -[binary_sensor.tesla docs]: https://home-assistant.io/components/binary_sensor.tesla/ -[binary_sensor.wink docs]: https://home-assistant.io/components/binary_sensor.wink/ -[binary_sensor.xiaomi_aqara docs]: https://home-assistant.io/components/binary_sensor.xiaomi_aqara/ -[camera.arlo docs]: https://home-assistant.io/components/camera.arlo/ -[camera.ffmpeg docs]: https://home-assistant.io/components/camera.ffmpeg/ -[camera.onvif docs]: https://home-assistant.io/components/camera.onvif/ -[camera.skybell docs]: https://home-assistant.io/components/camera.skybell/ -[camera.synology docs]: https://home-assistant.io/components/camera.synology/ -[camera.yi docs]: https://home-assistant.io/components/camera.yi/ -[climate.eq3btsmart docs]: https://home-assistant.io/components/climate.eq3btsmart/ -[climate.knx docs]: https://home-assistant.io/components/climate.knx/ -[climate.mqtt docs]: https://home-assistant.io/components/climate.mqtt/ -[climate.tesla docs]: https://home-assistant.io/components/climate.tesla/ -[climate.toon docs]: https://home-assistant.io/components/climate.toon/ -[cloud.iot docs]: https://home-assistant.io/components/cloud.iot/ -[cover.rflink docs]: https://home-assistant.io/components/cover.rflink/ -[device_tracker docs]: https://home-assistant.io/components/device_tracker/ -[device_tracker.fritz docs]: https://home-assistant.io/components/device_tracker.fritz/ -[device_tracker.mikrotik docs]: https://home-assistant.io/components/device_tracker.mikrotik/ -[device_tracker.netgear docs]: https://home-assistant.io/components/device_tracker.netgear/ -[device_tracker.owntracks docs]: https://home-assistant.io/components/device_tracker.owntracks/ -[device_tracker.snmp docs]: https://home-assistant.io/components/device_tracker.snmp/ -[device_tracker.unifi docs]: https://home-assistant.io/components/device_tracker.unifi/ -[device_tracker.upc_connect docs]: https://home-assistant.io/components/device_tracker.upc_connect/ -[enocean docs]: https://home-assistant.io/components/enocean/ -[ffmpeg docs]: https://home-assistant.io/components/ffmpeg/ -[google_assistant docs]: https://home-assistant.io/components/google_assistant/ -[hassio docs]: https://home-assistant.io/components/hassio/ -[homematic docs]: https://home-assistant.io/components/homematic/ -[http docs]: https://home-assistant.io/components/http/ -[knx docs]: https://home-assistant.io/components/knx/ -[light.hue docs]: https://home-assistant.io/components/light.hue/ -[light.mqtt_json docs]: https://home-assistant.io/components/light.mqtt_json/ -[light.osramlightify docs]: https://home-assistant.io/components/light.osramlightify/ -[light.skybell docs]: https://home-assistant.io/components/light.skybell/ -[light.template docs]: https://home-assistant.io/components/light.template/ -[light.tplink docs]: https://home-assistant.io/components/light.tplink/ -[light.tradfri docs]: https://home-assistant.io/components/light.tradfri/ -[light.yeelight docs]: https://home-assistant.io/components/light.yeelight/ -[lock.tesla docs]: https://home-assistant.io/components/lock.tesla/ -[map docs]: https://home-assistant.io/components/map/ -[media_extractor docs]: https://home-assistant.io/components/media_extractor/ -[media_player.denon docs]: https://home-assistant.io/components/media_player.denon/ -[media_player.denonavr docs]: https://home-assistant.io/components/media_player.denonavr/ -[media_player.dunehd docs]: https://home-assistant.io/components/media_player.dunehd/ -[media_player.liveboxplaytv docs]: https://home-assistant.io/components/media_player.liveboxplaytv/ -[media_player.monoprice docs]: https://home-assistant.io/components/media_player.monoprice/ -[media_player.plex docs]: https://home-assistant.io/components/media_player.plex/ -[media_player.yamaha docs]: https://home-assistant.io/components/media_player.yamaha/ -[modbus docs]: https://home-assistant.io/components/modbus/ -[mqtt docs]: https://home-assistant.io/components/mqtt/ -[namecheapdns docs]: https://home-assistant.io/components/namecheapdns/ -[notify.clicksend_tts docs]: https://home-assistant.io/components/notify.clicksend_tts/ -[notify.html5 docs]: https://home-assistant.io/components/notify.html5/ -[notify.rocketchat docs]: https://home-assistant.io/components/notify.rocketchat/ -[notify.xmpp docs]: https://home-assistant.io/components/notify.xmpp/ -[python_script docs]: https://home-assistant.io/components/python_script/ -[raincloud docs]: https://home-assistant.io/components/raincloud/ -[sensor.abode docs]: https://home-assistant.io/components/sensor.abode/ -[sensor.airvisual docs]: https://home-assistant.io/components/sensor.airvisual/ -[sensor.android_ip_webcam docs]: https://home-assistant.io/components/sensor.android_ip_webcam/ -[sensor.arlo docs]: https://home-assistant.io/components/sensor.arlo/ -[sensor.arwn docs]: https://home-assistant.io/components/sensor.arwn/ -[sensor.darksky docs]: https://home-assistant.io/components/sensor.darksky/ -[sensor.fitbit docs]: https://home-assistant.io/components/sensor.fitbit/ -[sensor.fritzbox_callmonitor docs]: https://home-assistant.io/components/sensor.fritzbox_callmonitor/ -[sensor.fritzbox_netmonitor docs]: https://home-assistant.io/components/sensor.fritzbox_netmonitor/ -[sensor.glances docs]: https://home-assistant.io/components/sensor.glances/ -[sensor.imap docs]: https://home-assistant.io/components/sensor.imap/ -[sensor.ios docs]: https://home-assistant.io/components/sensor.ios/ -[sensor.mqtt_room docs]: https://home-assistant.io/components/sensor.mqtt_room/ -[sensor.netdata docs]: https://home-assistant.io/components/sensor.netdata/ -[sensor.openweathermap docs]: https://home-assistant.io/components/sensor.openweathermap/ -[sensor.raincloud docs]: https://home-assistant.io/components/sensor.raincloud/ -[sensor.ring docs]: https://home-assistant.io/components/sensor.ring/ -[sensor.serial docs]: https://home-assistant.io/components/sensor.serial/ -[sensor.skybell docs]: https://home-assistant.io/components/sensor.skybell/ -[sensor.snmp docs]: https://home-assistant.io/components/sensor.snmp/ -[sensor.statistics docs]: https://home-assistant.io/components/sensor.statistics/ -[sensor.steam_online docs]: https://home-assistant.io/components/sensor.steam_online/ -[sensor.systemmonitor docs]: https://home-assistant.io/components/sensor.systemmonitor/ -[sensor.tesla docs]: https://home-assistant.io/components/sensor.tesla/ -[sensor.toon docs]: https://home-assistant.io/components/sensor.toon/ -[sensor.tradfri docs]: https://home-assistant.io/components/sensor.tradfri/ -[sensor.transmission docs]: https://home-assistant.io/components/sensor.transmission/ -[sensor.travisci docs]: https://home-assistant.io/components/sensor.travisci/ -[sensor.uptime docs]: https://home-assistant.io/components/sensor.uptime/ -[sensor.vera docs]: https://home-assistant.io/components/sensor.vera/ -[sensor.xiaomi_aqara docs]: https://home-assistant.io/components/sensor.xiaomi_aqara/ -[sensor.zha docs]: https://home-assistant.io/components/sensor.zha/ -[shiftr docs]: https://home-assistant.io/components/shiftr/ -[skybell docs]: https://home-assistant.io/components/skybell/ -[switch.flux docs]: https://home-assistant.io/components/switch.flux/ -[switch.fritzdect docs]: https://home-assistant.io/components/switch.fritzdect/ -[switch.hikvisioncam docs]: https://home-assistant.io/components/switch.hikvisioncam/ -[switch.rainmachine docs]: https://home-assistant.io/components/switch.rainmachine/ -[switch.skybell docs]: https://home-assistant.io/components/switch.skybell/ -[switch.tesla docs]: https://home-assistant.io/components/switch.tesla/ -[switch.toon docs]: https://home-assistant.io/components/switch.toon/ -[switch.tplink docs]: https://home-assistant.io/components/switch.tplink/ -[switch.wink docs]: https://home-assistant.io/components/switch.wink/ -[switch.xiaomi_miio docs]: https://home-assistant.io/components/switch.xiaomi_miio/ -[telegram_bot docs]: https://home-assistant.io/components/telegram_bot/ -[tesla docs]: https://home-assistant.io/components/tesla/ -[toon docs]: https://home-assistant.io/components/toon/ -[tradfri docs]: https://home-assistant.io/components/tradfri/ -[vacuum docs]: https://home-assistant.io/components/vacuum/ -[vacuum.dyson docs]: https://home-assistant.io/components/vacuum.dyson/ -[vacuum.mqtt docs]: https://home-assistant.io/components/vacuum.mqtt/ -[vera docs]: https://home-assistant.io/components/vera/ -[weather.openweathermap docs]: https://home-assistant.io/components/weather.openweathermap/ -[wink docs]: https://home-assistant.io/components/wink/ -[xiaomi_aqara docs]: https://home-assistant.io/components/xiaomi_aqara/ -[zha docs]: https://home-assistant.io/components/zha/ +[__init__ docs]: /components/__init__/ +[abode docs]: /components/abode/ +[alarm_control_panel.arlo docs]: /components/alarm_control_panel.arlo/ +[alarm_control_panel.egardia docs]: /components/alarm_control_panel.egardia/ +[alexa.smart_home docs]: /components/alexa.smart_home/ +[arlo docs]: /components/arlo/ +[automation.event docs]: /docs/automation/trigger/#event-trigger +[automation.numeric_state docs]: /docs/automation/trigger/#numeric-state-trigger +[automation.state docs]: /docs/automation/trigger/#state-trigger +[binary_sensor.iss docs]: /components/binary_sensor.iss/ +[binary_sensor.netatmo docs]: /components/binary_sensor.netatmo/ +[binary_sensor.skybell docs]: /components/binary_sensor.skybell/ +[binary_sensor.template docs]: /components/binary_sensor.template/ +[binary_sensor.tesla docs]: /components/binary_sensor.tesla/ +[binary_sensor.wink docs]: /components/binary_sensor.wink/ +[binary_sensor.xiaomi_aqara docs]: /components/binary_sensor.xiaomi_aqara/ +[camera.arlo docs]: /components/camera.arlo/ +[camera.ffmpeg docs]: /components/camera.ffmpeg/ +[camera.onvif docs]: /components/camera.onvif/ +[camera.skybell docs]: /components/camera.skybell/ +[camera.synology docs]: /components/camera.synology/ +[camera.yi docs]: /components/camera.yi/ +[climate.eq3btsmart docs]: /components/climate.eq3btsmart/ +[climate.knx docs]: /components/climate.knx/ +[climate.mqtt docs]: /components/climate.mqtt/ +[climate.tesla docs]: /components/climate.tesla/ +[climate.toon docs]: /components/climate.toon/ +[cloud.iot docs]: /components/cloud.iot/ +[cover.rflink docs]: /components/cover.rflink/ +[device_tracker docs]: /components/device_tracker/ +[device_tracker.fritz docs]: /components/device_tracker.fritz/ +[device_tracker.mikrotik docs]: /components/device_tracker.mikrotik/ +[device_tracker.netgear docs]: /components/device_tracker.netgear/ +[device_tracker.owntracks docs]: /components/device_tracker.owntracks/ +[device_tracker.snmp docs]: /components/device_tracker.snmp/ +[device_tracker.unifi docs]: /components/device_tracker.unifi/ +[device_tracker.upc_connect docs]: /components/device_tracker.upc_connect/ +[enocean docs]: /components/enocean/ +[ffmpeg docs]: /components/ffmpeg/ +[google_assistant docs]: /components/google_assistant/ +[hassio docs]: /components/hassio/ +[homematic docs]: /components/homematic/ +[http docs]: /components/http/ +[knx docs]: /components/knx/ +[light.hue docs]: /components/light.hue/ +[light.mqtt_json docs]: /components/light.mqtt_json/ +[light.osramlightify docs]: /components/light.osramlightify/ +[light.skybell docs]: /components/light.skybell/ +[light.template docs]: /components/light.template/ +[light.tplink docs]: /components/light.tplink/ +[light.tradfri docs]: /components/light.tradfri/ +[light.yeelight docs]: /components/light.yeelight/ +[lock.tesla docs]: /components/lock.tesla/ +[map docs]: /components/map/ +[media_extractor docs]: /components/media_extractor/ +[media_player.denon docs]: /components/media_player.denon/ +[media_player.denonavr docs]: /components/media_player.denonavr/ +[media_player.dunehd docs]: /components/media_player.dunehd/ +[media_player.liveboxplaytv docs]: /components/media_player.liveboxplaytv/ +[media_player.monoprice docs]: /components/media_player.monoprice/ +[media_player.plex docs]: /components/media_player.plex/ +[media_player.yamaha docs]: /components/media_player.yamaha/ +[modbus docs]: /components/modbus/ +[mqtt docs]: /components/mqtt/ +[namecheapdns docs]: /components/namecheapdns/ +[notify.clicksend_tts docs]: /components/notify.clicksend_tts/ +[notify.html5 docs]: /components/notify.html5/ +[notify.rocketchat docs]: /components/notify.rocketchat/ +[notify.xmpp docs]: /components/notify.xmpp/ +[python_script docs]: /components/python_script/ +[raincloud docs]: /components/raincloud/ +[sensor.abode docs]: /components/sensor.abode/ +[sensor.airvisual docs]: /components/sensor.airvisual/ +[sensor.android_ip_webcam docs]: /components/sensor.android_ip_webcam/ +[sensor.arlo docs]: /components/sensor.arlo/ +[sensor.arwn docs]: /components/sensor.arwn/ +[sensor.darksky docs]: /components/sensor.darksky/ +[sensor.fitbit docs]: /components/sensor.fitbit/ +[sensor.fritzbox_callmonitor docs]: /components/sensor.fritzbox_callmonitor/ +[sensor.fritzbox_netmonitor docs]: /components/sensor.fritzbox_netmonitor/ +[sensor.glances docs]: /components/sensor.glances/ +[sensor.imap docs]: /components/sensor.imap/ +[sensor.ios docs]: /components/sensor.ios/ +[sensor.mqtt_room docs]: /components/sensor.mqtt_room/ +[sensor.netdata docs]: /components/sensor.netdata/ +[sensor.openweathermap docs]: /components/sensor.openweathermap/ +[sensor.raincloud docs]: /components/sensor.raincloud/ +[sensor.ring docs]: /components/sensor.ring/ +[sensor.serial docs]: /components/sensor.serial/ +[sensor.skybell docs]: /components/sensor.skybell/ +[sensor.snmp docs]: /components/sensor.snmp/ +[sensor.statistics docs]: /components/sensor.statistics/ +[sensor.steam_online docs]: /components/sensor.steam_online/ +[sensor.systemmonitor docs]: /components/sensor.systemmonitor/ +[sensor.tesla docs]: /components/sensor.tesla/ +[sensor.toon docs]: /components/sensor.toon/ +[sensor.tradfri docs]: /components/sensor.tradfri/ +[sensor.transmission docs]: /components/sensor.transmission/ +[sensor.travisci docs]: /components/sensor.travisci/ +[sensor.uptime docs]: /components/sensor.uptime/ +[sensor.vera docs]: /components/sensor.vera/ +[sensor.xiaomi_aqara docs]: /components/sensor.xiaomi_aqara/ +[sensor.zha docs]: /components/sensor.zha/ +[shiftr docs]: /components/shiftr/ +[skybell docs]: /components/skybell/ +[switch.flux docs]: /components/switch.flux/ +[switch.fritzdect docs]: /components/switch.fritzdect/ +[switch.hikvisioncam docs]: /components/switch.hikvisioncam/ +[switch.rainmachine docs]: /components/switch.rainmachine/ +[switch.skybell docs]: /components/switch.skybell/ +[switch.tesla docs]: /components/switch.tesla/ +[switch.toon docs]: /components/switch.toon/ +[switch.tplink docs]: /components/switch.tplink/ +[switch.wink docs]: /components/switch.wink/ +[switch.xiaomi_miio docs]: /components/switch.xiaomi_miio/ +[telegram_bot docs]: /components/telegram_bot/ +[tesla docs]: /components/tesla/ +[toon docs]: /components/toon/ +[tradfri docs]: /components/tradfri/ +[vacuum docs]: /components/vacuum/ +[vacuum.dyson docs]: /components/vacuum.dyson/ +[vacuum.mqtt docs]: /components/vacuum.mqtt/ +[vera docs]: /components/vera/ +[weather.openweathermap docs]: /components/weather.openweathermap/ +[wink docs]: /components/wink/ +[xiaomi_aqara docs]: /components/xiaomi_aqara/ +[zha docs]: /components/zha/ [#10024]: https://github.com/home-assistant/home-assistant/pull/10024 [#10029]: https://github.com/home-assistant/home-assistant/pull/10029 [@bieniu]: https://github.com/bieniu diff --git a/source/_posts/2017-10-28-demo.markdown b/source/_posts/2017-10-28-demo.markdown index d6d9d89582..a64b3e18d8 100644 --- a/source/_posts/2017-10-28-demo.markdown +++ b/source/_posts/2017-10-28-demo.markdown @@ -13,7 +13,7 @@ og_image: /images/blog/2017-10-interactive-demo/demo-random.png If you are planning to host a Home Assistant meetup or doing a talk, then you probably want to show Home Assistant to an audience. You could use a Wireless router, bulbs, switches, and a single board computer to do a realistic demo. For a workshop, this is what I usually do because I think that working with physical hardware is more fun for the participants. The issue is that you need time to set up, power and space. For a talk or in a location, where you only have a beamer and a table or a lectern, the physical hardware approach is not very convenient. -The simplest way to show Home Assistant to others is the online demo at [https://home-assistant.io/demo/](https://home-assistant.io/demo/) +The simplest way to show Home Assistant to others is the online demo at [/demo/](/demo/)

    diff --git a/source/_posts/2017-11-02-secure-shell-tunnel.markdown b/source/_posts/2017-11-02-secure-shell-tunnel.markdown index 0d346e5389..1d02e48e3b 100644 --- a/source/_posts/2017-11-02-secure-shell-tunnel.markdown +++ b/source/_posts/2017-11-02-secure-shell-tunnel.markdown @@ -13,7 +13,7 @@ og_image: /images/blog/2017-11-ssh/social.png Most system engineers are very familiar with [SSH (Secure shell)](https://en.wikipedia.org/wiki/Secure_Shell). This tool which contains a server part and a client part is used to access a remote system in a secure way. It can also help you if your are running Home Assistant but don't want to expose it to the public. On a Linux system SSH is often available by default. If you are using a Windows installation additional steps are required which are not covered here. -In this blog post we are going to use the tunneling option of SSH to create a secure connection and forward the Home Assistant frontend to a local system. +In this blog post we are going to use the tunneling option of SSH to create a secure connection and forward the Home Assistant frontend to a local system. @@ -22,7 +22,7 @@ The involved parties are: - **Remote system**: Where Home Assistant is running, usually in your home network. - **Local system**: Where you want to see the frontend. -The prerequirements are that you need to allow the forwarding of port 22 from your router to the system where Home Assistant is running in your network. It might also be needed that you enable the SSH daemon by `$ sudo systemctl start sshd` on the remote system and to adjust the host firewall. If you are running [Hass.io](https://home-assistant.io/hassio/) then enable the [SSH Server add-on](https://home-assistant.io/addons/ssh/). You must also have a public IP address or hostname which can be provided by dynamic DNS (e.g., [NO-IP](https://www.noip.com/) or [DuckDNS](https://www.duckdns.org/)). +The prerequirements are that you need to allow the forwarding of port 22 from your router to the system where Home Assistant is running in your network. It might also be needed that you enable the SSH daemon by `$ sudo systemctl start sshd` on the remote system and to adjust the host firewall. If you are running [Hass.io](/hassio/) then enable the [SSH Server add-on](/addons/ssh/). You must also have a public IP address or hostname which can be provided by dynamic DNS (e.g., [NO-IP](https://www.noip.com/) or [DuckDNS](https://www.duckdns.org/)). On your local system you need only a SSH client and you need to be in a network where SSH is allowed. First let's have a look at the command we are going to use. Use `man ssh` to get more information. @@ -38,7 +38,7 @@ $ ssh -L 8000:localhost:8123 user@[IP_ADDRESS_REMOTE] |_ We want to do local port forwarding. ``` -A possible example could look like the command below. +A possible example could look like the command below. ```bash $ ssh -L 8000:localhost:8123 ha@192.168.0.11 @@ -50,11 +50,11 @@ The first time you establish the connection you need to accept the fingerprint. The authenticity of host '192.168.0.11 (192.168.0.11)' can't be established. ECDSA key fingerprint is SHA256:asdf2faasd4gk45454fadr78wfadfasdfeg4vvvsae33. ECDSA key fingerprint is MD5:44:d4:f7:44:d4:aa:b8:de:ef:09:3e:0d:4e:12:11:09. -Are you sure you want to continue connecting (yes/no)? +Are you sure you want to continue connecting (yes/no)? Warning: Permanently added '192.168.0.162' (ECDSA) to the list of known hosts. -ha@192.168.0.11's password: +ha@192.168.0.11's password: Last login: Fri Oct 27 17:50:09 2017 -[ha@home-assistant ~]$ +[ha@home-assistant ~]$ ``` Now you are able to use your frontend on your local system: [http://localhost:8000](http://localhost:8000) diff --git a/source/_posts/2017-11-04-release-57.markdown b/source/_posts/2017-11-04-release-57.markdown index dc054b035c..5c689b185a 100644 --- a/source/_posts/2017-11-04-release-57.markdown +++ b/source/_posts/2017-11-04-release-57.markdown @@ -32,7 +32,7 @@ As part of getting translations to work, we did a lot of cleanup work on the fro [Hacktoberfest](https://hacktoberfest.digitalocean.com/) 2017 is over! FINALLY. Each year we're attracting more developers that want to contribute to Home Assistant. This is great but also very exhausting to our code reviewers. I want to give an enormous gigantic huge big shout out to our reviewers @pvizeli, @andrey-git, @armills, @MartinHjelmare, @fabaff. You have all done an amazing job and we couldn't run Home Assistant without any of you! ❤ -Hacktoberfest is obviously about the people contributing to open source. Big thanks to everyone that has taken the time to learn our code base and make contributions. We hope it was a pleasant experience and show how great open source can be. Hope to see many contributions in the future 👍 +Hacktoberfest is obviously about the people contributing to open source. Big thanks to everyone that has taken the time to learn our code base and make contributions. We hope it was a pleasant experience and show how great open source can be. Hope to see many contributions in the future 👍 Here are our Hacktoberfest 2017 stats. It's a miracle everyone is still alive: @@ -56,7 +56,7 @@ Long time contributor [@lwis] jumped on the case and managed to migrate our inte ## {% linkable_title Timer %} -Okay, one more highlight before we'll let you check out the changelog. Contributor [@danielperna84] (famous for creating the [HASS Configurator](https://home-assistant.io/addons/configurator/)), had another great component up his sleeve: the Timer component. With the timer component you'll be able to start countdown timers. A neat tool for your automation toolbox! More info in the [timer docs]. +Okay, one more highlight before we'll let you check out the changelog. Contributor [@danielperna84] (famous for creating the [HASS Configurator](/addons/configurator/)), had another great component up his sleeve: the Timer component. With the timer component you'll be able to start countdown timers. A neat tool for your automation toolbox! More info in the [timer docs]. ## {% linkable_title New Platforms %} @@ -110,7 +110,7 @@ Experiencing issues introduced by this release? Please report them in our [issue ## {% linkable_title Breaking Changes %} - IKEA TRÅDFRI: We no longer support entering the key in the configuration. ([@lwis] - [#10282]) ([tradfri docs]) (breaking change) -- API.AI was renamed to [Dialogflow](https://home-assistant.io/components/dialogflow/). This requires to rename the entry in your `configuration.yaml` file from `apiai:` to `dialogflow`. ([@fabaff] - [#10006]) ([dialogflow docs]) (breaking change) +- API.AI was renamed to [Dialogflow](/components/dialogflow/). This requires to rename the entry in your `configuration.yaml` file from `apiai:` to `dialogflow`. ([@fabaff] - [#10006]) ([dialogflow docs]) (breaking change) - Wink: Removed support for entering your `username` and `password` in your config. Use the [new authentication method][wink-auth] instead. ([@w1ll1am23] - [#10277]) ([wink docs]) (breaking change) - Use feed name assigned in EmonCMS if there is one. This changes the default behavior but still uses configured 'name' if it's set, so it won't break the configuration of people who have customized their feed names in HA config. ([@KlaasH] - [#10021]) ([sensor.emoncms docs]) (breaking change) - The `namecheapdns` now uses `password:` instead of `access_token` in the configuration. Also, `host` is now optional which allow people who are not using subdomains to keep their configuration shorter. ([@fabaff] - [#10063]) ([namecheapdns docs]) (breaking change) @@ -120,7 +120,7 @@ Experiencing issues introduced by this release? Please report them in our [issue This fixes errors when an entity has an attribute that is not "a string, bytearray, int, float or None" and mqtt_statestream is used. As of now, the attribute is just handed over to paho, and paho can only send the aforementioned types. This patch fixes the issue by just casting everything to string before handing it over to paho. - There are a number of components / entities which have "other" attributes, e.g. light that have an RGB attribute which is a list. ([@tinloaf] - [#9872]) ([mqtt_statestream docs]) (breaking change) + There are a number of components / entities which have "other" attributes, e.g., light that have an RGB attribute which is a list. ([@tinloaf] - [#9872]) ([mqtt_statestream docs]) (breaking change) - Generic thermostat: the configuration option `tolerance` has been removed and has been replaced by `cold_tolerance` and `hot_tolerance`. This allows on and off states to have different error bands. ([@biggms] - [#9843]) ([climate.generic_thermostat docs]) (breaking change) - Developers only: frontend has been refactored. The method `register_panel` has been turned into a coroutine function called `async_register_panel`. The parameter `url_path` has been renamed to `frontend_url_path`. For frontend, development, you no longer pass `development: 1` to the http component but instead configure the frontend component to be in development mode by pointing it at a local checkout of the Polymer repo: ([@balloob] - [#9915]) (breaking change) @@ -522,138 +522,138 @@ Experiencing issues introduced by this release? Please report them in our [issue [@wardcraigj]: https://github.com/wardcraigj [@ypollart]: https://github.com/ypollart [@zabuldon]: https://github.com/zabuldon -[alarm_control_panel.totalconnect docs]: https://home-assistant.io/components/alarm_control_panel.totalconnect/ -[alexa.smart_home docs]: https://home-assistant.io/components/alexa.smart_home/ -[api docs]: https://home-assistant.io/components/api/ -[automation.event docs]: https://home-assistant.io/docs/automation/trigger/#event-trigger -[automation.numeric_state docs]: https://home-assistant.io/docs/automation/trigger/#numeric-state-trigger -[axis docs]: https://home-assistant.io/components/axis/ -[binary_sensor.axis docs]: https://home-assistant.io/components/binary_sensor.axis/ -[binary_sensor.gc100 docs]: https://home-assistant.io/components/binary_sensor.gc100/ -[binary_sensor.linode docs]: https://home-assistant.io/components/binary_sensor.linode/ -[binary_sensor.random docs]: https://home-assistant.io/components/binary_sensor.random/ -[binary_sensor.rfxtrx docs]: https://home-assistant.io/components/binary_sensor.rfxtrx/ -[binary_sensor.ring docs]: https://home-assistant.io/components/binary_sensor.ring/ -[binary_sensor.tellduslive docs]: https://home-assistant.io/components/binary_sensor.tellduslive/ -[binary_sensor.trend docs]: https://home-assistant.io/components/binary_sensor.trend/ -[binary_sensor.xiaomi_aqara docs]: https://home-assistant.io/components/binary_sensor.xiaomi_aqara/ -[camera docs]: https://home-assistant.io/components/camera/ -[camera.ring docs]: https://home-assistant.io/components/camera.ring/ -[climate.ephember docs]: https://home-assistant.io/components/climate.ephember/ -[climate.generic_thermostat docs]: https://home-assistant.io/components/climate.generic_thermostat/ -[climate.honeywell docs]: https://home-assistant.io/components/climate.honeywell/ -[climate.toon docs]: https://home-assistant.io/components/climate.toon/ -[cloud docs]: https://home-assistant.io/components/cloud/ -[cloud.iot docs]: https://home-assistant.io/components/cloud.iot/ -[cover.template docs]: https://home-assistant.io/components/cover.template/ -[device_tracker docs]: https://home-assistant.io/components/device_tracker/ -[device_tracker.asuswrt docs]: https://home-assistant.io/components/device_tracker.asuswrt/ -[device_tracker.automatic docs]: https://home-assistant.io/components/device_tracker.automatic/ -[device_tracker.geofency docs]: https://home-assistant.io/components/device_tracker.geofency/ -[device_tracker.mikrotik docs]: https://home-assistant.io/components/device_tracker.mikrotik/ -[device_tracker.owntracks docs]: https://home-assistant.io/components/device_tracker.owntracks/ -[device_tracker.snmp docs]: https://home-assistant.io/components/device_tracker.snmp/ -[device_tracker.ubus docs]: https://home-assistant.io/components/device_tracker.ubus/ -[dialogflow docs]: https://home-assistant.io/components/dialogflow/ -[downloader docs]: https://home-assistant.io/components/downloader/ -[duckdns docs]: https://home-assistant.io/components/duckdns/ -[fan.mqtt docs]: https://home-assistant.io/components/fan.mqtt/ -[fan.xiaomi_miio docs]: https://home-assistant.io/components/fan.xiaomi_miio/ -[gc100 docs]: https://home-assistant.io/components/gc100/ -[google_assistant docs]: https://home-assistant.io/components/google_assistant/ -[google_domains docs]: https://home-assistant.io/components/google_domains/ -[hassio docs]: https://home-assistant.io/components/hassio/ -[history docs]: https://home-assistant.io/components/history/ -[http docs]: https://home-assistant.io/components/http/ -[image_processing.openalpr_local docs]: https://home-assistant.io/components/image_processing.openalpr_local/ -[input_number docs]: https://home-assistant.io/components/input_number/ -[input_text docs]: https://home-assistant.io/components/input_text/ -[introduction docs]: https://home-assistant.io/components/introduction/ -[light.hue docs]: https://home-assistant.io/components/light.hue/ -[light.hyperion docs]: https://home-assistant.io/components/light.hyperion/ -[light.mqtt docs]: https://home-assistant.io/components/light.mqtt/ -[light.tradfri docs]: https://home-assistant.io/components/light.tradfri/ -[light.xiaomi_miio docs]: https://home-assistant.io/components/light.xiaomi_miio/ -[light.yeelight docs]: https://home-assistant.io/components/light.yeelight/ -[linode docs]: https://home-assistant.io/components/linode/ -[logbook docs]: https://home-assistant.io/components/logbook/ -[mailbox docs]: https://home-assistant.io/components/mailbox/ -[media_extractor docs]: https://home-assistant.io/components/media_extractor/ -[media_player docs]: https://home-assistant.io/components/media_player/ -[media_player.liveboxplaytv docs]: https://home-assistant.io/components/media_player.liveboxplaytv/ -[media_player.monoprice docs]: https://home-assistant.io/components/media_player.monoprice/ -[media_player.plex docs]: https://home-assistant.io/components/media_player.plex/ -[media_player.russound_rnet docs]: https://home-assistant.io/components/media_player.russound_rnet/ -[media_player.sonos docs]: https://home-assistant.io/components/media_player.sonos/ -[media_player.yamaha docs]: https://home-assistant.io/components/media_player.yamaha/ -[mqtt_statestream docs]: https://home-assistant.io/components/mqtt_statestream/ -[namecheapdns docs]: https://home-assistant.io/components/namecheapdns/ -[no_ip docs]: https://home-assistant.io/components/no_ip/ -[notify.aws_lambda docs]: https://home-assistant.io/components/notify.aws_lambda/ -[notify.aws_sns docs]: https://home-assistant.io/components/notify.aws_sns/ -[notify.aws_sqs docs]: https://home-assistant.io/components/notify.aws_sqs/ -[notify.clickatell docs]: https://home-assistant.io/components/notify.clickatell/ -[notify.sendgrid docs]: https://home-assistant.io/components/notify.sendgrid/ -[notify.yessssms docs]: https://home-assistant.io/components/notify.yessssms/ -[panel_custom docs]: https://home-assistant.io/components/panel_custom/ -[persistent_notification docs]: https://home-assistant.io/components/persistent_notification/ -[plant docs]: https://home-assistant.io/components/plant/ -[raincloud docs]: https://home-assistant.io/components/raincloud/ -[remember_the_milk docs]: https://home-assistant.io/components/remember_the_milk/ -[rfxtrx docs]: https://home-assistant.io/components/rfxtrx/ -[ring docs]: https://home-assistant.io/components/ring/ -[sensor.coinmarketcap docs]: https://home-assistant.io/components/sensor.coinmarketcap/ -[sensor.emoncms docs]: https://home-assistant.io/components/sensor.emoncms/ -[sensor.fail2ban docs]: https://home-assistant.io/components/sensor.fail2ban/ -[sensor.gitter docs]: https://home-assistant.io/components/sensor.gitter/ -[sensor.glances docs]: https://home-assistant.io/components/sensor.glances/ -[sensor.google_travel_time docs]: https://home-assistant.io/components/sensor.google_travel_time/ -[sensor.hddtemp docs]: https://home-assistant.io/components/sensor.hddtemp/ -[sensor.imap docs]: https://home-assistant.io/components/sensor.imap/ -[sensor.irish_rail_transport docs]: https://home-assistant.io/components/sensor.irish_rail_transport/ -[sensor.lastfm docs]: https://home-assistant.io/components/sensor.lastfm/ -[sensor.luftdaten docs]: https://home-assistant.io/components/sensor.luftdaten/ -[sensor.nederlandse_spoorwegen docs]: https://home-assistant.io/components/sensor.nederlandse_spoorwegen/ -[sensor.radarr docs]: https://home-assistant.io/components/sensor.radarr/ -[sensor.rest docs]: https://home-assistant.io/components/sensor.rest/ -[sensor.ring docs]: https://home-assistant.io/components/sensor.ring/ -[sensor.scrape docs]: https://home-assistant.io/components/sensor.scrape/ -[sensor.snmp docs]: https://home-assistant.io/components/sensor.snmp/ -[sensor.sonarr docs]: https://home-assistant.io/components/sensor.sonarr/ -[sensor.speedtest docs]: https://home-assistant.io/components/sensor.speedtest/ -[sensor.swiss_public_transport docs]: https://home-assistant.io/components/sensor.swiss_public_transport/ -[sensor.synologydsm docs]: https://home-assistant.io/components/sensor.synologydsm/ -[sensor.sytadin docs]: https://home-assistant.io/components/sensor.sytadin/ -[sensor.toon docs]: https://home-assistant.io/components/sensor.toon/ -[sensor.uk_transport docs]: https://home-assistant.io/components/sensor.uk_transport/ -[sensor.whois docs]: https://home-assistant.io/components/sensor.whois/ -[shopping_list docs]: https://home-assistant.io/components/shopping_list/ -[switch.deluge docs]: https://home-assistant.io/components/switch.deluge/ -[switch.flux docs]: https://home-assistant.io/components/switch.flux/ -[switch.gc100 docs]: https://home-assistant.io/components/switch.gc100/ -[switch.snmp docs]: https://home-assistant.io/components/switch.snmp/ -[switch.template docs]: https://home-assistant.io/components/switch.template/ -[switch.toon docs]: https://home-assistant.io/components/switch.toon/ -[switch.xiaomi_miio docs]: https://home-assistant.io/components/switch.xiaomi_miio/ -[tellduslive docs]: https://home-assistant.io/components/tellduslive/ -[tellstick docs]: https://home-assistant.io/components/tellstick/ -[tesla docs]: https://home-assistant.io/components/tesla/ -[timer docs]: https://home-assistant.io/components/timer/ -[toon docs]: https://home-assistant.io/components/toon/ -[tradfri docs]: https://home-assistant.io/components/tradfri/ -[tts.amazon_polly docs]: https://home-assistant.io/components/tts.amazon_polly/ -[tts.microsoft docs]: https://home-assistant.io/components/tts.microsoft/ -[vacuum.xiaomi_miio docs]: https://home-assistant.io/components/vacuum.xiaomi_miio/ -[vera docs]: https://home-assistant.io/components/vera/ -[wink docs]: https://home-assistant.io/components/wink/ -[xiaomi_aqara docs]: https://home-assistant.io/components/xiaomi_aqara/ +[alarm_control_panel.totalconnect docs]: /components/alarm_control_panel.totalconnect/ +[alexa.smart_home docs]: /components/alexa.smart_home/ +[api docs]: /components/api/ +[automation.event docs]: /docs/automation/trigger/#event-trigger +[automation.numeric_state docs]: /docs/automation/trigger/#numeric-state-trigger +[axis docs]: /components/axis/ +[binary_sensor.axis docs]: /components/binary_sensor.axis/ +[binary_sensor.gc100 docs]: /components/binary_sensor.gc100/ +[binary_sensor.linode docs]: /components/binary_sensor.linode/ +[binary_sensor.random docs]: /components/binary_sensor.random/ +[binary_sensor.rfxtrx docs]: /components/binary_sensor.rfxtrx/ +[binary_sensor.ring docs]: /components/binary_sensor.ring/ +[binary_sensor.tellduslive docs]: /components/binary_sensor.tellduslive/ +[binary_sensor.trend docs]: /components/binary_sensor.trend/ +[binary_sensor.xiaomi_aqara docs]: /components/binary_sensor.xiaomi_aqara/ +[camera docs]: /components/camera/ +[camera.ring docs]: /components/camera.ring/ +[climate.ephember docs]: /components/climate.ephember/ +[climate.generic_thermostat docs]: /components/climate.generic_thermostat/ +[climate.honeywell docs]: /components/climate.honeywell/ +[climate.toon docs]: /components/climate.toon/ +[cloud docs]: /components/cloud/ +[cloud.iot docs]: /components/cloud.iot/ +[cover.template docs]: /components/cover.template/ +[device_tracker docs]: /components/device_tracker/ +[device_tracker.asuswrt docs]: /components/device_tracker.asuswrt/ +[device_tracker.automatic docs]: /components/device_tracker.automatic/ +[device_tracker.geofency docs]: /components/device_tracker.geofency/ +[device_tracker.mikrotik docs]: /components/device_tracker.mikrotik/ +[device_tracker.owntracks docs]: /components/device_tracker.owntracks/ +[device_tracker.snmp docs]: /components/device_tracker.snmp/ +[device_tracker.ubus docs]: /components/device_tracker.ubus/ +[dialogflow docs]: /components/dialogflow/ +[downloader docs]: /components/downloader/ +[duckdns docs]: /components/duckdns/ +[fan.mqtt docs]: /components/fan.mqtt/ +[fan.xiaomi_miio docs]: /components/fan.xiaomi_miio/ +[gc100 docs]: /components/gc100/ +[google_assistant docs]: /components/google_assistant/ +[google_domains docs]: /components/google_domains/ +[hassio docs]: /components/hassio/ +[history docs]: /components/history/ +[http docs]: /components/http/ +[image_processing.openalpr_local docs]: /components/image_processing.openalpr_local/ +[input_number docs]: /components/input_number/ +[input_text docs]: /components/input_text/ +[introduction docs]: /components/introduction/ +[light.hue docs]: /components/light.hue/ +[light.hyperion docs]: /components/light.hyperion/ +[light.mqtt docs]: /components/light.mqtt/ +[light.tradfri docs]: /components/light.tradfri/ +[light.xiaomi_miio docs]: /components/light.xiaomi_miio/ +[light.yeelight docs]: /components/light.yeelight/ +[linode docs]: /components/linode/ +[logbook docs]: /components/logbook/ +[mailbox docs]: /components/mailbox/ +[media_extractor docs]: /components/media_extractor/ +[media_player docs]: /components/media_player/ +[media_player.liveboxplaytv docs]: /components/media_player.liveboxplaytv/ +[media_player.monoprice docs]: /components/media_player.monoprice/ +[media_player.plex docs]: /components/media_player.plex/ +[media_player.russound_rnet docs]: /components/media_player.russound_rnet/ +[media_player.sonos docs]: /components/media_player.sonos/ +[media_player.yamaha docs]: /components/media_player.yamaha/ +[mqtt_statestream docs]: /components/mqtt_statestream/ +[namecheapdns docs]: /components/namecheapdns/ +[no_ip docs]: /components/no_ip/ +[notify.aws_lambda docs]: /components/notify.aws_lambda/ +[notify.aws_sns docs]: /components/notify.aws_sns/ +[notify.aws_sqs docs]: /components/notify.aws_sqs/ +[notify.clickatell docs]: /components/notify.clickatell/ +[notify.sendgrid docs]: /components/notify.sendgrid/ +[notify.yessssms docs]: /components/notify.yessssms/ +[panel_custom docs]: /components/panel_custom/ +[persistent_notification docs]: /components/persistent_notification/ +[plant docs]: /components/plant/ +[raincloud docs]: /components/raincloud/ +[remember_the_milk docs]: /components/remember_the_milk/ +[rfxtrx docs]: /components/rfxtrx/ +[ring docs]: /components/ring/ +[sensor.coinmarketcap docs]: /components/sensor.coinmarketcap/ +[sensor.emoncms docs]: /components/sensor.emoncms/ +[sensor.fail2ban docs]: /components/sensor.fail2ban/ +[sensor.gitter docs]: /components/sensor.gitter/ +[sensor.glances docs]: /components/sensor.glances/ +[sensor.google_travel_time docs]: /components/sensor.google_travel_time/ +[sensor.hddtemp docs]: /components/sensor.hddtemp/ +[sensor.imap docs]: /components/sensor.imap/ +[sensor.irish_rail_transport docs]: /components/sensor.irish_rail_transport/ +[sensor.lastfm docs]: /components/sensor.lastfm/ +[sensor.luftdaten docs]: /components/sensor.luftdaten/ +[sensor.nederlandse_spoorwegen docs]: /components/sensor.nederlandse_spoorwegen/ +[sensor.radarr docs]: /components/sensor.radarr/ +[sensor.rest docs]: /components/sensor.rest/ +[sensor.ring docs]: /components/sensor.ring/ +[sensor.scrape docs]: /components/sensor.scrape/ +[sensor.snmp docs]: /components/sensor.snmp/ +[sensor.sonarr docs]: /components/sensor.sonarr/ +[sensor.speedtest docs]: /components/sensor.speedtest/ +[sensor.swiss_public_transport docs]: /components/sensor.swiss_public_transport/ +[sensor.synologydsm docs]: /components/sensor.synologydsm/ +[sensor.sytadin docs]: /components/sensor.sytadin/ +[sensor.toon docs]: /components/sensor.toon/ +[sensor.uk_transport docs]: /components/sensor.uk_transport/ +[sensor.whois docs]: /components/sensor.whois/ +[shopping_list docs]: /components/shopping_list/ +[switch.deluge docs]: /components/switch.deluge/ +[switch.flux docs]: /components/switch.flux/ +[switch.gc100 docs]: /components/switch.gc100/ +[switch.snmp docs]: /components/switch.snmp/ +[switch.template docs]: /components/switch.template/ +[switch.toon docs]: /components/switch.toon/ +[switch.xiaomi_miio docs]: /components/switch.xiaomi_miio/ +[tellduslive docs]: /components/tellduslive/ +[tellstick docs]: /components/tellstick/ +[tesla docs]: /components/tesla/ +[timer docs]: /components/timer/ +[toon docs]: /components/toon/ +[tradfri docs]: /components/tradfri/ +[tts.amazon_polly docs]: /components/tts.amazon_polly/ +[tts.microsoft docs]: /components/tts.microsoft/ +[vacuum.xiaomi_miio docs]: /components/vacuum.xiaomi_miio/ +[vera docs]: /components/vera/ +[wink docs]: /components/wink/ +[xiaomi_aqara docs]: /components/xiaomi_aqara/ [ikea email]: https://twitter.com/home_assistant/status/925373865802502144 -[wink-auth]: https://home-assistant.io/components/wink/#authenticate-using-developerwinkcomhttpsdeveloperwinkcom +[wink-auth]: /components/wink/#authenticate-using-developerwinkcomhttpsdeveloperwinkcom [#10384]: https://github.com/home-assistant/home-assistant/pull/10384 [#10428]: https://github.com/home-assistant/home-assistant/pull/10428 [@stefan-jonasson]: https://github.com/stefan-jonasson [@tchellomello]: https://github.com/tchellomello -[binary_sensor.ring docs]: https://home-assistant.io/components/binary_sensor.ring/ -[camera.ring docs]: https://home-assistant.io/components/camera.ring/ -[sensor.ring docs]: https://home-assistant.io/components/sensor.ring/ -[tellstick docs]: https://home-assistant.io/components/tellstick/ +[binary_sensor.ring docs]: /components/binary_sensor.ring/ +[camera.ring docs]: /components/camera.ring/ +[sensor.ring docs]: /components/sensor.ring/ +[tellstick docs]: /components/tellstick/ diff --git a/source/_posts/2017-11-05-frontend-translations.markdown b/source/_posts/2017-11-05-frontend-translations.markdown index bf6cc8db75..aefa5588af 100644 --- a/source/_posts/2017-11-05-frontend-translations.markdown +++ b/source/_posts/2017-11-05-frontend-translations.markdown @@ -17,9 +17,9 @@ The Home Assistant sidebar in 12 different languages. ## {% linkable_title Translations %} -As mentioned in the [0.57 release notes](https://home-assistant.io/blog/2017/11/04/release-57/), Home Assistant has launched a translated frontend. With the immediate influx of translations, we’ve made integration with a translation tool a top priority. [@c727] took the initiative to evaluate several tools, and we’re happy to announce that Home Assistant will be partnering with [Lokalise](https://lokalise.co/) to manage our translations! +As mentioned in the [0.57 release notes](/blog/2017/11/04/release-57/), Home Assistant has launched a translated frontend. With the immediate influx of translations, we’ve made integration with a translation tool a top priority. [@c727] took the initiative to evaluate several tools, and we’re happy to announce that Home Assistant will be partnering with [Lokalise](https://lokalise.co/) to manage our translations! -Lokalise allows us to open up translations for all of our multilingual users willing to contribute. Users can join the project using our [public signup link](https://lokalise.co/signup/3420425759f6d6d241f598.13594006/all/), and start translating right away. We’ve created a [translation startup guide](https://home-assistant.io/developers/frontend_translation/) with additional details about how to contribute. Instructions are provided there for how to request a new language. +Lokalise allows us to open up translations for all of our multilingual users willing to contribute. Users can join the project using our [public signup link](https://lokalise.co/signup/3420425759f6d6d241f598.13594006/all/), and start translating right away. We’ve created a [translation startup guide](/developers/frontend_translation/) with additional details about how to contribute. Instructions are provided there for how to request a new language. Now that we have a system in place, expect a lot more of the interface to be translatable soon. We still have some technical hurdles to overcome, but the hardest work is behind us now. The community has already done an outstanding job of providing translations. The future is looking bright! diff --git a/source/_posts/2017-11-18-release-58.markdown b/source/_posts/2017-11-18-release-58.markdown index e930abae6f..d7e7fbbc25 100644 --- a/source/_posts/2017-11-18-release-58.markdown +++ b/source/_posts/2017-11-18-release-58.markdown @@ -25,7 +25,7 @@ Talking about our translators, we now have 445 people with an account to help wi And because more translations is more better, [@robbiet480] has added the iOS app to Lokalise, our translation management platform. The iOS app is currently supported in 7 different languages. -[Learn more about how to help with translations](https://home-assistant.io/blog/2017/11/05/frontend-translations/) +[Learn more about how to help with translations](/blog/2017/11/05/frontend-translations/) ## {% linkable_title Frontend improvements continue %} @@ -381,114 +381,114 @@ Experiencing issues introduced by this release? Please report them in our [issue [@w1ll1am23]: https://github.com/w1ll1am23 [@wardcraigj]: https://github.com/wardcraigj [@ziotibia81]: https://github.com/ziotibia81 -[abode docs]: https://home-assistant.io/components/abode/ -[alarm_control_panel.spc docs]: https://home-assistant.io/components/alarm_control_panel.spc/ -[alarm_control_panel.totalconnect docs]: https://home-assistant.io/components/alarm_control_panel.totalconnect/ -[apple_tv docs]: https://home-assistant.io/components/apple_tv/ -[arlo docs]: https://home-assistant.io/components/arlo/ -[axis docs]: https://home-assistant.io/components/axis/ -[binary_sensor docs]: https://home-assistant.io/components/binary_sensor/ -[binary_sensor.aurora docs]: https://home-assistant.io/components/binary_sensor.aurora/ -[binary_sensor.spc docs]: https://home-assistant.io/components/binary_sensor.spc/ -[binary_sensor.vultr docs]: https://home-assistant.io/components/binary_sensor.vultr/ -[camera.arlo docs]: https://home-assistant.io/components/camera.arlo/ -[climate docs]: https://home-assistant.io/components/climate/ -[climate.eq3btsmart docs]: https://home-assistant.io/components/climate.eq3btsmart/ -[climate.generic_thermostat docs]: https://home-assistant.io/components/climate.generic_thermostat/ -[climate.homematic docs]: https://home-assistant.io/components/climate.homematic/ -[climate.knx docs]: https://home-assistant.io/components/climate.knx/ -[climate.wink docs]: https://home-assistant.io/components/climate.wink/ -[cloud docs]: https://home-assistant.io/components/cloud/ -[cloud.auth_api docs]: https://home-assistant.io/components/cloud.auth_api/ -[cloud.const docs]: https://home-assistant.io/components/cloud.const/ -[cloud.http_api docs]: https://home-assistant.io/components/cloud.http_api/ -[cloud.iot docs]: https://home-assistant.io/components/cloud.iot/ -[config.zwave docs]: https://home-assistant.io/components/config.zwave/ -[configurator docs]: https://home-assistant.io/components/configurator/ -[counter docs]: https://home-assistant.io/components/counter/ -[cover.mqtt docs]: https://home-assistant.io/components/cover.mqtt/ -[device_tracker docs]: https://home-assistant.io/components/device_tracker/ -[device_tracker.hitron_coda docs]: https://home-assistant.io/components/device_tracker.hitron_coda/ -[device_tracker.owntracks docs]: https://home-assistant.io/components/device_tracker.owntracks/ -[device_tracker.snmp docs]: https://home-assistant.io/components/device_tracker.snmp/ -[device_tracker.tile docs]: https://home-assistant.io/components/device_tracker.tile/ -[device_tracker.tplink docs]: https://home-assistant.io/components/device_tracker.tplink/ -[device_tracker.upc_connect docs]: https://home-assistant.io/components/device_tracker.upc_connect/ -[downloader docs]: https://home-assistant.io/components/downloader/ -[gc100 docs]: https://home-assistant.io/components/gc100/ -[google_assistant.smart_home docs]: https://home-assistant.io/components/google_assistant.smart_home/ -[hassio docs]: https://home-assistant.io/components/hassio/ -[influxdb docs]: https://home-assistant.io/components/influxdb/ -[input_datetime docs]: https://home-assistant.io/components/input_datetime/ -[knx docs]: https://home-assistant.io/components/knx/ -[lametric docs]: https://home-assistant.io/components/lametric/ -[light docs]: https://home-assistant.io/components/light/ -[light.tradfri docs]: https://home-assistant.io/components/light.tradfri/ -[light.xiaomi_miio docs]: https://home-assistant.io/components/light.xiaomi_miio/ -[lutron_caseta docs]: https://home-assistant.io/components/lutron_caseta/ -[media_extractor docs]: https://home-assistant.io/components/media_extractor/ -[media_player docs]: https://home-assistant.io/components/media_player/ -[media_player.bluesound docs]: https://home-assistant.io/components/media_player.bluesound/ -[media_player.snapcast docs]: https://home-assistant.io/components/media_player.snapcast/ -[media_player.universal docs]: https://home-assistant.io/components/media_player.universal/ -[media_player.webostv docs]: https://home-assistant.io/components/media_player.webostv/ -[media_player.yamaha_musiccast docs]: https://home-assistant.io/components/media_player.yamaha_musiccast/ -[mqtt docs]: https://home-assistant.io/components/mqtt/ -[mqtt.discovery docs]: https://home-assistant.io/components/mqtt.discovery/ -[mqtt.server docs]: https://home-assistant.io/components/mqtt.server/ -[mqtt_statestream docs]: https://home-assistant.io/components/mqtt_statestream/ -[neato docs]: https://home-assistant.io/components/neato/ -[no_ip docs]: https://home-assistant.io/components/no_ip/ -[notify.apns docs]: https://home-assistant.io/components/notify.apns/ -[notify.free_mobile docs]: https://home-assistant.io/components/notify.free_mobile/ -[notify.html5 docs]: https://home-assistant.io/components/notify.html5/ -[notify.lametric docs]: https://home-assistant.io/components/notify.lametric/ -[notify.simplepush docs]: https://home-assistant.io/components/notify.simplepush/ -[notify.telegram docs]: https://home-assistant.io/components/notify.telegram/ -[python_script docs]: https://home-assistant.io/components/python_script/ -[remote docs]: https://home-assistant.io/components/remote/ -[remote.harmony docs]: https://home-assistant.io/components/remote.harmony/ -[ring docs]: https://home-assistant.io/components/ring/ -[sensor.airvisual docs]: https://home-assistant.io/components/sensor.airvisual/ -[sensor.arlo docs]: https://home-assistant.io/components/sensor.arlo/ -[sensor.haveibeenpwned docs]: https://home-assistant.io/components/sensor.haveibeenpwned/ -[sensor.lacrosse docs]: https://home-assistant.io/components/sensor.lacrosse/ -[sensor.london_air docs]: https://home-assistant.io/components/sensor.london_air/ -[sensor.modbus docs]: https://home-assistant.io/components/sensor.modbus/ -[sensor.neato docs]: https://home-assistant.io/components/sensor.neato/ -[sensor.nederlandse_spoorwegen docs]: https://home-assistant.io/components/sensor.nederlandse_spoorwegen/ -[sensor.pyload docs]: https://home-assistant.io/components/sensor.pyload/ -[sensor.serial docs]: https://home-assistant.io/components/sensor.serial/ -[sensor.snmp docs]: https://home-assistant.io/components/sensor.snmp/ -[sensor.systemmonitor docs]: https://home-assistant.io/components/sensor.systemmonitor/ -[sensor.tibber docs]: https://home-assistant.io/components/sensor.tibber/ -[sensor.viaggiatreno docs]: https://home-assistant.io/components/sensor.viaggiatreno/ -[sensor.vultr docs]: https://home-assistant.io/components/sensor.vultr/ -[sensor.wunderground docs]: https://home-assistant.io/components/sensor.wunderground/ -[sensor.yweather docs]: https://home-assistant.io/components/sensor.yweather/ -[sensor.zamg docs]: https://home-assistant.io/components/sensor.zamg/ -[spc docs]: https://home-assistant.io/components/spc/ -[switch.broadlink docs]: https://home-assistant.io/components/switch.broadlink/ -[switch.hikvisioncam docs]: https://home-assistant.io/components/switch.hikvisioncam/ -[switch.modbus docs]: https://home-assistant.io/components/switch.modbus/ -[switch.neato docs]: https://home-assistant.io/components/switch.neato/ -[switch.snmp docs]: https://home-assistant.io/components/switch.snmp/ -[switch.xiaomi_miio docs]: https://home-assistant.io/components/switch.xiaomi_miio/ -[system_log docs]: https://home-assistant.io/components/system_log/ -[telegram_bot docs]: https://home-assistant.io/components/telegram_bot/ -[telegram_bot.polling docs]: https://home-assistant.io/components/telegram_bot.polling/ -[tradfri docs]: https://home-assistant.io/components/tradfri/ -[tts docs]: https://home-assistant.io/components/tts/ -[tts.google docs]: https://home-assistant.io/components/tts.google/ -[tts.yandextts docs]: https://home-assistant.io/components/tts.yandextts/ -[vacuum.neato docs]: https://home-assistant.io/components/vacuum.neato/ -[verisure docs]: https://home-assistant.io/components/verisure/ -[volvooncall docs]: https://home-assistant.io/components/volvooncall/ -[vultr docs]: https://home-assistant.io/components/vultr/ -[weather docs]: https://home-assistant.io/components/weather/ -[weather.demo docs]: https://home-assistant.io/components/weather.demo/ -[websocket_api docs]: https://home-assistant.io/components/websocket_api/ -[zwave docs]: https://home-assistant.io/components/zwave/ +[abode docs]: /components/abode/ +[alarm_control_panel.spc docs]: /components/alarm_control_panel.spc/ +[alarm_control_panel.totalconnect docs]: /components/alarm_control_panel.totalconnect/ +[apple_tv docs]: /components/apple_tv/ +[arlo docs]: /components/arlo/ +[axis docs]: /components/axis/ +[binary_sensor docs]: /components/binary_sensor/ +[binary_sensor.aurora docs]: /components/binary_sensor.aurora/ +[binary_sensor.spc docs]: /components/binary_sensor.spc/ +[binary_sensor.vultr docs]: /components/binary_sensor.vultr/ +[camera.arlo docs]: /components/camera.arlo/ +[climate docs]: /components/climate/ +[climate.eq3btsmart docs]: /components/climate.eq3btsmart/ +[climate.generic_thermostat docs]: /components/climate.generic_thermostat/ +[climate.homematic docs]: /components/climate.homematic/ +[climate.knx docs]: /components/climate.knx/ +[climate.wink docs]: /components/climate.wink/ +[cloud docs]: /components/cloud/ +[cloud.auth_api docs]: /components/cloud.auth_api/ +[cloud.const docs]: /components/cloud.const/ +[cloud.http_api docs]: /components/cloud.http_api/ +[cloud.iot docs]: /components/cloud.iot/ +[config.zwave docs]: /components/config.zwave/ +[configurator docs]: /components/configurator/ +[counter docs]: /components/counter/ +[cover.mqtt docs]: /components/cover.mqtt/ +[device_tracker docs]: /components/device_tracker/ +[device_tracker.hitron_coda docs]: /components/device_tracker.hitron_coda/ +[device_tracker.owntracks docs]: /components/device_tracker.owntracks/ +[device_tracker.snmp docs]: /components/device_tracker.snmp/ +[device_tracker.tile docs]: /components/device_tracker.tile/ +[device_tracker.tplink docs]: /components/device_tracker.tplink/ +[device_tracker.upc_connect docs]: /components/device_tracker.upc_connect/ +[downloader docs]: /components/downloader/ +[gc100 docs]: /components/gc100/ +[google_assistant.smart_home docs]: /components/google_assistant.smart_home/ +[hassio docs]: /components/hassio/ +[influxdb docs]: /components/influxdb/ +[input_datetime docs]: /components/input_datetime/ +[knx docs]: /components/knx/ +[lametric docs]: /components/lametric/ +[light docs]: /components/light/ +[light.tradfri docs]: /components/light.tradfri/ +[light.xiaomi_miio docs]: /components/light.xiaomi_miio/ +[lutron_caseta docs]: /components/lutron_caseta/ +[media_extractor docs]: /components/media_extractor/ +[media_player docs]: /components/media_player/ +[media_player.bluesound docs]: /components/media_player.bluesound/ +[media_player.snapcast docs]: /components/media_player.snapcast/ +[media_player.universal docs]: /components/media_player.universal/ +[media_player.webostv docs]: /components/media_player.webostv/ +[media_player.yamaha_musiccast docs]: /components/media_player.yamaha_musiccast/ +[mqtt docs]: /components/mqtt/ +[mqtt.discovery docs]: /components/mqtt.discovery/ +[mqtt.server docs]: /components/mqtt.server/ +[mqtt_statestream docs]: /components/mqtt_statestream/ +[neato docs]: /components/neato/ +[no_ip docs]: /components/no_ip/ +[notify.apns docs]: /components/notify.apns/ +[notify.free_mobile docs]: /components/notify.free_mobile/ +[notify.html5 docs]: /components/notify.html5/ +[notify.lametric docs]: /components/notify.lametric/ +[notify.simplepush docs]: /components/notify.simplepush/ +[notify.telegram docs]: /components/notify.telegram/ +[python_script docs]: /components/python_script/ +[remote docs]: /components/remote/ +[remote.harmony docs]: /components/remote.harmony/ +[ring docs]: /components/ring/ +[sensor.airvisual docs]: /components/sensor.airvisual/ +[sensor.arlo docs]: /components/sensor.arlo/ +[sensor.haveibeenpwned docs]: /components/sensor.haveibeenpwned/ +[sensor.lacrosse docs]: /components/sensor.lacrosse/ +[sensor.london_air docs]: /components/sensor.london_air/ +[sensor.modbus docs]: /components/sensor.modbus/ +[sensor.neato docs]: /components/sensor.neato/ +[sensor.nederlandse_spoorwegen docs]: /components/sensor.nederlandse_spoorwegen/ +[sensor.pyload docs]: /components/sensor.pyload/ +[sensor.serial docs]: /components/sensor.serial/ +[sensor.snmp docs]: /components/sensor.snmp/ +[sensor.systemmonitor docs]: /components/sensor.systemmonitor/ +[sensor.tibber docs]: /components/sensor.tibber/ +[sensor.viaggiatreno docs]: /components/sensor.viaggiatreno/ +[sensor.vultr docs]: /components/sensor.vultr/ +[sensor.wunderground docs]: /components/sensor.wunderground/ +[sensor.yweather docs]: /components/sensor.yweather/ +[sensor.zamg docs]: /components/sensor.zamg/ +[spc docs]: /components/spc/ +[switch.broadlink docs]: /components/switch.broadlink/ +[switch.hikvisioncam docs]: /components/switch.hikvisioncam/ +[switch.modbus docs]: /components/switch.modbus/ +[switch.neato docs]: /components/switch.neato/ +[switch.snmp docs]: /components/switch.snmp/ +[switch.xiaomi_miio docs]: /components/switch.xiaomi_miio/ +[system_log docs]: /components/system_log/ +[telegram_bot docs]: /components/telegram_bot/ +[telegram_bot.polling docs]: /components/telegram_bot.polling/ +[tradfri docs]: /components/tradfri/ +[tts docs]: /components/tts/ +[tts.google docs]: /components/tts.google/ +[tts.yandextts docs]: /components/tts.yandextts/ +[vacuum.neato docs]: /components/vacuum.neato/ +[verisure docs]: /components/verisure/ +[volvooncall docs]: /components/volvooncall/ +[vultr docs]: /components/vultr/ +[weather docs]: /components/weather/ +[weather.demo docs]: /components/weather.demo/ +[websocket_api docs]: /components/websocket_api/ +[zwave docs]: /components/zwave/ [#10661]: https://github.com/home-assistant/home-assistant/pull/10661 [#10665]: https://github.com/home-assistant/home-assistant/pull/10665 [#10682]: https://github.com/home-assistant/home-assistant/pull/10682 @@ -497,7 +497,7 @@ Experiencing issues introduced by this release? Please report them in our [issue [@etsinko]: https://github.com/etsinko [@tinloaf]: https://github.com/tinloaf [@titilambert]: https://github.com/titilambert -[remote.harmony docs]: https://home-assistant.io/components/remote.harmony/ -[sensor.hydroquebec docs]: https://home-assistant.io/components/sensor.hydroquebec/ -[sensor.time_date docs]: https://home-assistant.io/components/sensor.time_date/ -[weather.yweather docs]: https://home-assistant.io/components/weather.yweather/ +[remote.harmony docs]: /components/remote.harmony/ +[sensor.hydroquebec docs]: /components/sensor.hydroquebec/ +[sensor.time_date docs]: /components/sensor.time_date/ +[weather.yweather docs]: /components/weather.yweather/ diff --git a/source/_posts/2017-12-03-release-59.markdown b/source/_posts/2017-12-03-release-59.markdown index b68a0dede9..bfadb2646a 100644 --- a/source/_posts/2017-12-03-release-59.markdown +++ b/source/_posts/2017-12-03-release-59.markdown @@ -324,94 +324,94 @@ Experiencing issues introduced by this release? Please report them in our [issue [@wardcraigj]: https://github.com/wardcraigj [@zBart]: https://github.com/zBart [@zhujisheng]: https://github.com/zhujisheng -[alarm_control_panel docs]: https://home-assistant.io/components/alarm_control_panel/ -[alarm_control_panel.arlo docs]: https://home-assistant.io/components/alarm_control_panel.arlo/ -[alarm_control_panel.demo docs]: https://home-assistant.io/components/alarm_control_panel.demo/ -[alarm_control_panel.totalconnect docs]: https://home-assistant.io/components/alarm_control_panel.totalconnect/ -[amcrest docs]: https://home-assistant.io/components/amcrest/ -[automation.state docs]: https://home-assistant.io/docs/automation/trigger/#state-trigger -[binary_sensor docs]: https://home-assistant.io/components/binary_sensor/ -[binary_sensor.homematic docs]: https://home-assistant.io/components/binary_sensor.homematic/ -[camera.amcrest docs]: https://home-assistant.io/components/camera.amcrest/ -[camera.ring docs]: https://home-assistant.io/components/camera.ring/ -[climate docs]: https://home-assistant.io/components/climate/ -[climate.ecobee docs]: https://home-assistant.io/components/climate.ecobee/ -[climate.generic_thermostat docs]: https://home-assistant.io/components/climate.generic_thermostat/ -[climate.hive docs]: https://home-assistant.io/components/climate.hive/ -[climate.honeywell docs]: https://home-assistant.io/components/climate.honeywell/ -[climate.mqtt docs]: https://home-assistant.io/components/climate.mqtt/ -[climate.radiotherm docs]: https://home-assistant.io/components/climate.radiotherm/ -[climate.sensibo docs]: https://home-assistant.io/components/climate.sensibo/ -[cloud docs]: https://home-assistant.io/components/cloud/ -[cloud.auth_api docs]: https://home-assistant.io/components/cloud.auth_api/ -[cloud.iot docs]: https://home-assistant.io/components/cloud.iot/ -[config.group docs]: https://home-assistant.io/components/config.group/ -[configurator docs]: https://home-assistant.io/components/configurator/ -[conversation docs]: https://home-assistant.io/components/conversation/ -[cover.tahoma docs]: https://home-assistant.io/components/cover.tahoma/ -[device_tracker.unifi_direct docs]: https://home-assistant.io/components/device_tracker.unifi_direct/ -[dominos docs]: https://home-assistant.io/components/dominos/ -[doorbird docs]: https://home-assistant.io/components/doorbird/ -[ecobee docs]: https://home-assistant.io/components/ecobee/ -[emulated_hue docs]: https://home-assistant.io/components/emulated_hue/ -[fan.xiaomi_miio docs]: https://home-assistant.io/components/fan.xiaomi_miio/ -[google_assistant.http docs]: https://home-assistant.io/components/google_assistant.http/ -[google_assistant.smart_home docs]: https://home-assistant.io/components/google_assistant.smart_home/ -[hive docs]: https://home-assistant.io/components/hive/ -[homematic docs]: https://home-assistant.io/components/homematic/ -[influxdb docs]: https://home-assistant.io/components/influxdb/ -[knx docs]: https://home-assistant.io/components/knx/ -[light.blinkt docs]: https://home-assistant.io/components/light.blinkt/ -[light.hive docs]: https://home-assistant.io/components/light.hive/ -[light.hue docs]: https://home-assistant.io/components/light.hue/ -[light.tradfri docs]: https://home-assistant.io/components/light.tradfri/ -[light.xiaomi_miio docs]: https://home-assistant.io/components/light.xiaomi_miio/ -[light.yeelight docs]: https://home-assistant.io/components/light.yeelight/ -[media_extractor docs]: https://home-assistant.io/components/media_extractor/ -[media_player.cast docs]: https://home-assistant.io/components/media_player.cast/ -[netatmo docs]: https://home-assistant.io/components/netatmo/ -[notify.lametric docs]: https://home-assistant.io/components/notify.lametric/ -[notify.pushbullet docs]: https://home-assistant.io/components/notify.pushbullet/ -[ring docs]: https://home-assistant.io/components/ring/ -[sensor.amcrest docs]: https://home-assistant.io/components/sensor.amcrest/ -[sensor.currencylayer docs]: https://home-assistant.io/components/sensor.currencylayer/ -[sensor.deutsche_bahn docs]: https://home-assistant.io/components/sensor.deutsche_bahn/ -[sensor.fastdotcom docs]: https://home-assistant.io/components/sensor.fastdotcom/ -[sensor.fritzbox_netmonitor docs]: https://home-assistant.io/components/sensor.fritzbox_netmonitor/ -[sensor.hddtemp docs]: https://home-assistant.io/components/sensor.hddtemp/ -[sensor.hive docs]: https://home-assistant.io/components/sensor.hive/ -[sensor.homematic docs]: https://home-assistant.io/components/sensor.homematic/ -[sensor.sabnzbd docs]: https://home-assistant.io/components/sensor.sabnzbd/ -[sensor.serial docs]: https://home-assistant.io/components/sensor.serial/ -[sensor.tahoma docs]: https://home-assistant.io/components/sensor.tahoma/ -[sensor.tellduslive docs]: https://home-assistant.io/components/sensor.tellduslive/ -[sensor.tellstick docs]: https://home-assistant.io/components/sensor.tellstick/ -[sensor.whois docs]: https://home-assistant.io/components/sensor.whois/ -[sensor.wunderground docs]: https://home-assistant.io/components/sensor.wunderground/ -[sensor.yweather docs]: https://home-assistant.io/components/sensor.yweather/ -[shell_command docs]: https://home-assistant.io/components/shell_command/ -[shopping_list docs]: https://home-assistant.io/components/shopping_list/ -[switch.hive docs]: https://home-assistant.io/components/switch.hive/ -[switch.xiaomi_miio docs]: https://home-assistant.io/components/switch.xiaomi_miio/ -[system_log docs]: https://home-assistant.io/components/system_log/ -[tahoma docs]: https://home-assistant.io/components/tahoma/ -[tellduslive docs]: https://home-assistant.io/components/tellduslive/ -[tellstick docs]: https://home-assistant.io/components/tellstick/ -[tradfri docs]: https://home-assistant.io/components/tradfri/ -[tts docs]: https://home-assistant.io/components/tts/ -[tts.baidu docs]: https://home-assistant.io/components/tts.baidu/ -[tts.microsoft docs]: https://home-assistant.io/components/tts.microsoft/ -[updater docs]: https://home-assistant.io/components/updater/ -[vacuum.xiaomi_miio docs]: https://home-assistant.io/components/vacuum.xiaomi_miio/ -[weather.ecobee docs]: https://home-assistant.io/components/weather.ecobee/ -[zwave docs]: https://home-assistant.io/components/zwave/ +[alarm_control_panel docs]: /components/alarm_control_panel/ +[alarm_control_panel.arlo docs]: /components/alarm_control_panel.arlo/ +[alarm_control_panel.demo docs]: /components/alarm_control_panel.demo/ +[alarm_control_panel.totalconnect docs]: /components/alarm_control_panel.totalconnect/ +[amcrest docs]: /components/amcrest/ +[automation.state docs]: /docs/automation/trigger/#state-trigger +[binary_sensor docs]: /components/binary_sensor/ +[binary_sensor.homematic docs]: /components/binary_sensor.homematic/ +[camera.amcrest docs]: /components/camera.amcrest/ +[camera.ring docs]: /components/camera.ring/ +[climate docs]: /components/climate/ +[climate.ecobee docs]: /components/climate.ecobee/ +[climate.generic_thermostat docs]: /components/climate.generic_thermostat/ +[climate.hive docs]: /components/climate.hive/ +[climate.honeywell docs]: /components/climate.honeywell/ +[climate.mqtt docs]: /components/climate.mqtt/ +[climate.radiotherm docs]: /components/climate.radiotherm/ +[climate.sensibo docs]: /components/climate.sensibo/ +[cloud docs]: /components/cloud/ +[cloud.auth_api docs]: /components/cloud.auth_api/ +[cloud.iot docs]: /components/cloud.iot/ +[config.group docs]: /components/config.group/ +[configurator docs]: /components/configurator/ +[conversation docs]: /components/conversation/ +[cover.tahoma docs]: /components/cover.tahoma/ +[device_tracker.unifi_direct docs]: /components/device_tracker.unifi_direct/ +[dominos docs]: /components/dominos/ +[doorbird docs]: /components/doorbird/ +[ecobee docs]: /components/ecobee/ +[emulated_hue docs]: /components/emulated_hue/ +[fan.xiaomi_miio docs]: /components/fan.xiaomi_miio/ +[google_assistant.http docs]: /components/google_assistant.http/ +[google_assistant.smart_home docs]: /components/google_assistant.smart_home/ +[hive docs]: /components/hive/ +[homematic docs]: /components/homematic/ +[influxdb docs]: /components/influxdb/ +[knx docs]: /components/knx/ +[light.blinkt docs]: /components/light.blinkt/ +[light.hive docs]: /components/light.hive/ +[light.hue docs]: /components/light.hue/ +[light.tradfri docs]: /components/light.tradfri/ +[light.xiaomi_miio docs]: /components/light.xiaomi_miio/ +[light.yeelight docs]: /components/light.yeelight/ +[media_extractor docs]: /components/media_extractor/ +[media_player.cast docs]: /components/media_player.cast/ +[netatmo docs]: /components/netatmo/ +[notify.lametric docs]: /components/notify.lametric/ +[notify.pushbullet docs]: /components/notify.pushbullet/ +[ring docs]: /components/ring/ +[sensor.amcrest docs]: /components/sensor.amcrest/ +[sensor.currencylayer docs]: /components/sensor.currencylayer/ +[sensor.deutsche_bahn docs]: /components/sensor.deutsche_bahn/ +[sensor.fastdotcom docs]: /components/sensor.fastdotcom/ +[sensor.fritzbox_netmonitor docs]: /components/sensor.fritzbox_netmonitor/ +[sensor.hddtemp docs]: /components/sensor.hddtemp/ +[sensor.hive docs]: /components/sensor.hive/ +[sensor.homematic docs]: /components/sensor.homematic/ +[sensor.sabnzbd docs]: /components/sensor.sabnzbd/ +[sensor.serial docs]: /components/sensor.serial/ +[sensor.tahoma docs]: /components/sensor.tahoma/ +[sensor.tellduslive docs]: /components/sensor.tellduslive/ +[sensor.tellstick docs]: /components/sensor.tellstick/ +[sensor.whois docs]: /components/sensor.whois/ +[sensor.wunderground docs]: /components/sensor.wunderground/ +[sensor.yweather docs]: /components/sensor.yweather/ +[shell_command docs]: /components/shell_command/ +[shopping_list docs]: /components/shopping_list/ +[switch.hive docs]: /components/switch.hive/ +[switch.xiaomi_miio docs]: /components/switch.xiaomi_miio/ +[system_log docs]: /components/system_log/ +[tahoma docs]: /components/tahoma/ +[tellduslive docs]: /components/tellduslive/ +[tellstick docs]: /components/tellstick/ +[tradfri docs]: /components/tradfri/ +[tts docs]: /components/tts/ +[tts.baidu docs]: /components/tts.baidu/ +[tts.microsoft docs]: /components/tts.microsoft/ +[updater docs]: /components/updater/ +[vacuum.xiaomi_miio docs]: /components/vacuum.xiaomi_miio/ +[weather.ecobee docs]: /components/weather.ecobee/ +[zwave docs]: /components/zwave/ [#10798]: https://github.com/home-assistant/home-assistant/pull/10798 [#10923]: https://github.com/home-assistant/home-assistant/pull/10923 [#10934]: https://github.com/home-assistant/home-assistant/pull/10934 [#10935]: https://github.com/home-assistant/home-assistant/pull/10935 [@NovapaX]: https://github.com/NovapaX [@wrboyce]: https://github.com/wrboyce -[notify.nfandroidtv docs]: https://home-assistant.io/components/notify.nfandroidtv/ +[notify.nfandroidtv docs]: /components/notify.nfandroidtv/ [#10941]: https://github.com/home-assistant/home-assistant/pull/10941 [#10947]: https://github.com/home-assistant/home-assistant/pull/10947 [#10950]: https://github.com/home-assistant/home-assistant/pull/10950 @@ -424,8 +424,8 @@ Experiencing issues introduced by this release? Please report them in our [issue [@molobrakos]: https://github.com/molobrakos [@w1ll1am23]: https://github.com/w1ll1am23 [@wardcraigj]: https://github.com/wardcraigj -[device_tracker.linksys_ap docs]: https://home-assistant.io/components/device_tracker.linksys_ap/ -[dominos docs]: https://home-assistant.io/components/dominos/ -[media_player.cast docs]: https://home-assistant.io/components/media_player.cast/ -[tellduslive docs]: https://home-assistant.io/components/tellduslive/ -[wink docs]: https://home-assistant.io/components/wink/ +[device_tracker.linksys_ap docs]: /components/device_tracker.linksys_ap/ +[dominos docs]: /components/dominos/ +[media_player.cast docs]: /components/media_player.cast/ +[tellduslive docs]: /components/tellduslive/ +[wink docs]: /components/wink/ diff --git a/source/_posts/2017-12-17-introducing-home-assistant-cloud.markdown b/source/_posts/2017-12-17-introducing-home-assistant-cloud.markdown index 9577ea9b16..d765165e5c 100644 --- a/source/_posts/2017-12-17-introducing-home-assistant-cloud.markdown +++ b/source/_posts/2017-12-17-introducing-home-assistant-cloud.markdown @@ -52,7 +52,7 @@ _Last updated: February 22, 2018_ #### {% linkable_title I thought the Home Assistant crew didn't like the cloud? %} -You are right, [we don't](https://home-assistant.io/blog/2016/01/19/perfect-home-automation/#your-system-should-run-at-home-not-in-the-cloud)! The Home Assistant Cloud is not an alternative to running your local Home Assistant instance. All control and automations are still running locally. +You are right, [we don't](/blog/2016/01/19/perfect-home-automation/#your-system-should-run-at-home-not-in-the-cloud)! The Home Assistant Cloud is not an alternative to running your local Home Assistant instance. All control and automations are still running locally. Instead, the Home Assistant Cloud is an extension of your local instance. It allows to communicate with companies that force us to communicate via a public available cloud endpoint like Amazon Alexa and Google Assistant. diff --git a/source/_posts/2017-12-17-release-60.markdown b/source/_posts/2017-12-17-release-60.markdown index 6f795df119..4cfabc3417 100644 --- a/source/_posts/2017-12-17-release-60.markdown +++ b/source/_posts/2017-12-17-release-60.markdown @@ -300,78 +300,78 @@ Experiencing issues introduced by this release? Please report them in our [issue [@tschmidty69]: https://github.com/tschmidty69 [@uchagani]: https://github.com/uchagani [@ziotibia81]: https://github.com/ziotibia81 -[ads docs]: https://home-assistant.io/components/ads/ -[alarm_control_panel.egardia docs]: https://home-assistant.io/components/alarm_control_panel.egardia/ -[alarm_control_panel.ialarm docs]: https://home-assistant.io/components/alarm_control_panel.ialarm/ -[alarm_control_panel.manual docs]: https://home-assistant.io/components/alarm_control_panel.manual/ -[alarm_control_panel.manual_mqtt docs]: https://home-assistant.io/components/alarm_control_panel.manual_mqtt/ -[alarm_control_panel.totalconnect docs]: https://home-assistant.io/components/alarm_control_panel.totalconnect/ -[alarmdecoder docs]: https://home-assistant.io/components/alarmdecoder/ -[apple_tv docs]: https://home-assistant.io/components/apple_tv/ -[binary_sensor docs]: https://home-assistant.io/components/binary_sensor/ -[binary_sensor.ads docs]: https://home-assistant.io/components/binary_sensor.ads/ -[binary_sensor.isy994 docs]: https://home-assistant.io/components/binary_sensor.isy994/ -[calendar.caldav docs]: https://home-assistant.io/components/calendar.caldav/ -[camera.canary docs]: https://home-assistant.io/components/camera.canary/ -[canary docs]: https://home-assistant.io/components/canary/ -[climate.generic_thermostat docs]: https://home-assistant.io/components/climate.generic_thermostat/ -[climate.tado docs]: https://home-assistant.io/components/climate.tado/ -[cloud docs]: https://home-assistant.io/components/cloud/ -[cloud.const docs]: https://home-assistant.io/components/cloud.const/ -[config.automation docs]: https://home-assistant.io/components/config.automation/ -[cover.tellstick docs]: https://home-assistant.io/components/cover.tellstick/ -[device_tracker docs]: https://home-assistant.io/components/device_tracker/ -[device_tracker.meraki docs]: https://home-assistant.io/components/device_tracker.meraki/ -[ecobee docs]: https://home-assistant.io/components/ecobee/ -[homematic docs]: https://home-assistant.io/components/homematic/ -[hue docs]: https://home-assistant.io/components/hue/ -[isy994 docs]: https://home-assistant.io/components/isy994/ -[keyboard_remote docs]: https://home-assistant.io/components/keyboard_remote/ -[light.ads docs]: https://home-assistant.io/components/light.ads/ -[light.hue docs]: https://home-assistant.io/components/light.hue/ -[light.lifx docs]: https://home-assistant.io/components/light.lifx/ -[light.mochad docs]: https://home-assistant.io/components/light.mochad/ -[light.tplink docs]: https://home-assistant.io/components/light.tplink/ -[light.tradfri docs]: https://home-assistant.io/components/light.tradfri/ -[logbook docs]: https://home-assistant.io/components/logbook/ -[media_extractor docs]: https://home-assistant.io/components/media_extractor/ -[media_player.denonavr docs]: https://home-assistant.io/components/media_player.denonavr/ -[media_player.liveboxplaytv docs]: https://home-assistant.io/components/media_player.liveboxplaytv/ -[media_player.samsungtv docs]: https://home-assistant.io/components/media_player.samsungtv/ -[media_player.sonos docs]: https://home-assistant.io/components/media_player.sonos/ -[media_player.ue_smart_radio docs]: https://home-assistant.io/components/media_player.ue_smart_radio/ -[media_player.webostv docs]: https://home-assistant.io/components/media_player.webostv/ -[media_player.yamaha_musiccast docs]: https://home-assistant.io/components/media_player.yamaha_musiccast/ -[media_player.ziggo_mediabox_xl docs]: https://home-assistant.io/components/media_player.ziggo_mediabox_xl/ -[mochad docs]: https://home-assistant.io/components/mochad/ -[neato docs]: https://home-assistant.io/components/neato/ -[notify.html5 docs]: https://home-assistant.io/components/notify.html5/ -[prometheus docs]: https://home-assistant.io/components/prometheus/ -[scene.vera docs]: https://home-assistant.io/components/scene.vera/ -[sensor.ads docs]: https://home-assistant.io/components/sensor.ads/ -[sensor.alpha_vantage docs]: https://home-assistant.io/components/sensor.alpha_vantage/ -[sensor.canary docs]: https://home-assistant.io/components/sensor.canary/ -[sensor.efergy docs]: https://home-assistant.io/components/sensor.efergy/ -[sensor.eliqonline docs]: https://home-assistant.io/components/sensor.eliqonline/ -[sensor.gearbest docs]: https://home-assistant.io/components/sensor.gearbest/ -[sensor.luftdaten docs]: https://home-assistant.io/components/sensor.luftdaten/ -[sensor.miflora docs]: https://home-assistant.io/components/sensor.miflora/ -[sensor.mqtt docs]: https://home-assistant.io/components/sensor.mqtt/ -[sensor.octoprint docs]: https://home-assistant.io/components/sensor.octoprint/ -[sensor.rest docs]: https://home-assistant.io/components/sensor.rest/ -[sensor.ripple docs]: https://home-assistant.io/components/sensor.ripple/ -[sensor.shodan docs]: https://home-assistant.io/components/sensor.shodan/ -[sensor.systemmonitor docs]: https://home-assistant.io/components/sensor.systemmonitor/ -[sensor.tesla docs]: https://home-assistant.io/components/sensor.tesla/ -[sensor.volvooncall docs]: https://home-assistant.io/components/sensor.volvooncall/ -[snips docs]: https://home-assistant.io/components/snips/ -[switch.ads docs]: https://home-assistant.io/components/switch.ads/ -[switch.mochad docs]: https://home-assistant.io/components/switch.mochad/ -[switch.tplink docs]: https://home-assistant.io/components/switch.tplink/ -[tellstick docs]: https://home-assistant.io/components/tellstick/ -[vera docs]: https://home-assistant.io/components/vera/ -[volvooncall docs]: https://home-assistant.io/components/volvooncall/ -[xiaomi_aqara docs]: https://home-assistant.io/components/xiaomi_aqara/ +[ads docs]: /components/ads/ +[alarm_control_panel.egardia docs]: /components/alarm_control_panel.egardia/ +[alarm_control_panel.ialarm docs]: /components/alarm_control_panel.ialarm/ +[alarm_control_panel.manual docs]: /components/alarm_control_panel.manual/ +[alarm_control_panel.manual_mqtt docs]: /components/alarm_control_panel.manual_mqtt/ +[alarm_control_panel.totalconnect docs]: /components/alarm_control_panel.totalconnect/ +[alarmdecoder docs]: /components/alarmdecoder/ +[apple_tv docs]: /components/apple_tv/ +[binary_sensor docs]: /components/binary_sensor/ +[binary_sensor.ads docs]: /components/binary_sensor.ads/ +[binary_sensor.isy994 docs]: /components/binary_sensor.isy994/ +[calendar.caldav docs]: /components/calendar.caldav/ +[camera.canary docs]: /components/camera.canary/ +[canary docs]: /components/canary/ +[climate.generic_thermostat docs]: /components/climate.generic_thermostat/ +[climate.tado docs]: /components/climate.tado/ +[cloud docs]: /components/cloud/ +[cloud.const docs]: /components/cloud.const/ +[config.automation docs]: /components/config.automation/ +[cover.tellstick docs]: /components/cover.tellstick/ +[device_tracker docs]: /components/device_tracker/ +[device_tracker.meraki docs]: /components/device_tracker.meraki/ +[ecobee docs]: /components/ecobee/ +[homematic docs]: /components/homematic/ +[hue docs]: /components/hue/ +[isy994 docs]: /components/isy994/ +[keyboard_remote docs]: /components/keyboard_remote/ +[light.ads docs]: /components/light.ads/ +[light.hue docs]: /components/light.hue/ +[light.lifx docs]: /components/light.lifx/ +[light.mochad docs]: /components/light.mochad/ +[light.tplink docs]: /components/light.tplink/ +[light.tradfri docs]: /components/light.tradfri/ +[logbook docs]: /components/logbook/ +[media_extractor docs]: /components/media_extractor/ +[media_player.denonavr docs]: /components/media_player.denonavr/ +[media_player.liveboxplaytv docs]: /components/media_player.liveboxplaytv/ +[media_player.samsungtv docs]: /components/media_player.samsungtv/ +[media_player.sonos docs]: /components/media_player.sonos/ +[media_player.ue_smart_radio docs]: /components/media_player.ue_smart_radio/ +[media_player.webostv docs]: /components/media_player.webostv/ +[media_player.yamaha_musiccast docs]: /components/media_player.yamaha_musiccast/ +[media_player.ziggo_mediabox_xl docs]: /components/media_player.ziggo_mediabox_xl/ +[mochad docs]: /components/mochad/ +[neato docs]: /components/neato/ +[notify.html5 docs]: /components/notify.html5/ +[prometheus docs]: /components/prometheus/ +[scene.vera docs]: /components/scene.vera/ +[sensor.ads docs]: /components/sensor.ads/ +[sensor.alpha_vantage docs]: /components/sensor.alpha_vantage/ +[sensor.canary docs]: /components/sensor.canary/ +[sensor.efergy docs]: /components/sensor.efergy/ +[sensor.eliqonline docs]: /components/sensor.eliqonline/ +[sensor.gearbest docs]: /components/sensor.gearbest/ +[sensor.luftdaten docs]: /components/sensor.luftdaten/ +[sensor.miflora docs]: /components/sensor.miflora/ +[sensor.mqtt docs]: /components/sensor.mqtt/ +[sensor.octoprint docs]: /components/sensor.octoprint/ +[sensor.rest docs]: /components/sensor.rest/ +[sensor.ripple docs]: /components/sensor.ripple/ +[sensor.shodan docs]: /components/sensor.shodan/ +[sensor.systemmonitor docs]: /components/sensor.systemmonitor/ +[sensor.tesla docs]: /components/sensor.tesla/ +[sensor.volvooncall docs]: /components/sensor.volvooncall/ +[snips docs]: /components/snips/ +[switch.ads docs]: /components/switch.ads/ +[switch.mochad docs]: /components/switch.mochad/ +[switch.tplink docs]: /components/switch.tplink/ +[tellstick docs]: /components/tellstick/ +[vera docs]: /components/vera/ +[volvooncall docs]: /components/volvooncall/ +[xiaomi_aqara docs]: /components/xiaomi_aqara/ [#11054]: https://github.com/home-assistant/home-assistant/pull/11054 [#11185]: https://github.com/home-assistant/home-assistant/pull/11185 [#11214]: https://github.com/home-assistant/home-assistant/pull/11214 @@ -397,12 +397,12 @@ Experiencing issues introduced by this release? Please report them in our [issue [@rwa]: https://github.com/rwa [@veleek]: https://github.com/veleek [@ziotibia81]: https://github.com/ziotibia81 -[alexa.smart_home docs]: https://home-assistant.io/components/alexa.smart_home/ -[binary_sensor.concord232 docs]: https://home-assistant.io/components/binary_sensor.concord232/ -[binary_sensor.isy994 docs]: https://home-assistant.io/components/binary_sensor.isy994/ -[calendar.caldav docs]: https://home-assistant.io/components/calendar.caldav/ -[homematic docs]: https://home-assistant.io/components/homematic/ -[light.hue docs]: https://home-assistant.io/components/light.hue/ -[lock.sesame docs]: https://home-assistant.io/components/lock.sesame/ -[media_player.webostv docs]: https://home-assistant.io/components/media_player.webostv/ -[switch.modbus docs]: https://home-assistant.io/components/switch.modbus/ +[alexa.smart_home docs]: /components/alexa.smart_home/ +[binary_sensor.concord232 docs]: /components/binary_sensor.concord232/ +[binary_sensor.isy994 docs]: /components/binary_sensor.isy994/ +[calendar.caldav docs]: /components/calendar.caldav/ +[homematic docs]: /components/homematic/ +[light.hue docs]: /components/light.hue/ +[lock.sesame docs]: /components/lock.sesame/ +[media_player.webostv docs]: /components/media_player.webostv/ +[switch.modbus docs]: /components/switch.modbus/ diff --git a/source/_posts/2017-12-28-thank-you.markdown b/source/_posts/2017-12-28-thank-you.markdown index f5632f7d6f..d1cefceb59 100644 --- a/source/_posts/2017-12-28-thank-you.markdown +++ b/source/_posts/2017-12-28-thank-you.markdown @@ -13,7 +13,7 @@ og_image: 2017 is almost over and this means it's time to do a little recap of our 2017. This was a great year for Home Assistant. Again, we were able to stick to our bi-weekly release cycle. There were 25 releases over the year and each release included the work of around 60 contributors. -We got 10.000 stars on [GitHub], reached 10.000 commits in the main repo (over 4300 were made in 2017), got a [Thomas-Krenn award], participated in [Hacktoberfest], we have now almost 1000 integrations (the exact number is 938), we [moved to Discord] and we are up to over 2 million pageviews per month on our forum. Beside that we announced the [Home Assistant cloud] and have regular [Home Assistant Podcasts]. +We got 10.000 stars on [GitHub], reached 10.000 commits in the main repo (over 4300 were made in 2017), got a [Thomas-Krenn award], participated in [Hacktoberfest], we have now almost 1000 integrations (the exact number is 938), we [moved to Discord] and we are up to over 2 million pageviews per month on our forum. Beside that we announced the [Home Assistant cloud] and have regular [Home Assistant Podcasts]. We also do not want to forget to mention [Hass.io] and all the great Hass.io add-ons. @@ -35,7 +35,7 @@ Stay tuned for more Home Assistant awesomeness in 2018. We will keep the pace bu [forum]: https://community.home-assistant.io [GitHub]: https://GitHub.com [Hacktoberfest]: /blog/2017/11/04/release-57/#hacktoberfest -[Hass.io]: https://home-assistant.io/hassio/ +[Hass.io]: /hassio/ [Home Assistant cloud]: /blog/2017/12/17/introducing-home-assistant-cloud/ [Home Assistant Podcasts]: https://hasspodcast.io/ [moved to Discord]: /blog/2017/07/03/home-assistant-is-moving-to-discord/ diff --git a/source/_posts/2018-01-14-release-61.markdown b/source/_posts/2018-01-14-release-61.markdown index f83e933ee7..1cc48aad14 100644 --- a/source/_posts/2018-01-14-release-61.markdown +++ b/source/_posts/2018-01-14-release-61.markdown @@ -106,7 +106,7 @@ Note however, that this feature was replaced by a new ignore_string config optio ([@balloob] - [#11461]) ([cloud docs]) ([alexa.smart_home docs]) (breaking change) - The extension of the `alpha_vantage` requires an update of the configuration as now are exchange data available as well. ([@ChristianKuehnel] - [#11427]) ([sensor.alpha_vantage docs]) (breaking change) - The `prometheus` component now supports pushing all sensors and fixes wrong metrics. If may require that you update your configuration. ([@michaelkuty] - [#11159]) ([prometheus docs]) (breaking change) -- Insteon local devices will now use their address as the `entity_id` and `name`. The friendly name can be customized using the [standard customization configuration](https://home-assistant.io/docs/configuration/customizing-devices/). ([@camrun91] - [#11088]) ([insteon_local docs]) ([fan.insteon_local docs]) ([light.insteon_local docs]) ([switch.insteon_local docs]) (breaking change) +- Insteon local devices will now use their address as the `entity_id` and `name`. The friendly name can be customized using the [standard customization configuration](/docs/configuration/customizing-devices/). ([@camrun91] - [#11088]) ([insteon_local docs]) ([fan.insteon_local docs]) ([light.insteon_local docs]) ([switch.insteon_local docs]) (breaking change) - Google Assistant is no longer configured via `customize` but instead has its configuration under the `google_assistant` entry in your `configuration.yaml`. The attributes will no longer have to be prefixed with `google_assistant_` either. | Old option | New option | @@ -612,168 +612,168 @@ Note however, that this feature was replaced by a new ignore_string config optio [@veleek]: https://github.com/veleek [@w1ll1am23]: https://github.com/w1ll1am23 [@yienxu]: https://github.com/yienxu -[__init__ docs]: https://home-assistant.io/components/__init__/ -[alarm_control_panel.alarmdecoder docs]: https://home-assistant.io/components/alarm_control_panel.alarmdecoder/ -[alarm_control_panel.concord232 docs]: https://home-assistant.io/components/alarm_control_panel.concord232/ -[alarm_control_panel.egardia docs]: https://home-assistant.io/components/alarm_control_panel.egardia/ -[alarmdecoder docs]: https://home-assistant.io/components/alarmdecoder/ -[alexa.intent docs]: https://home-assistant.io/components/alexa.intent/ -[alexa.smart_home docs]: https://home-assistant.io/components/alexa.smart_home/ -[api docs]: https://home-assistant.io/components/api/ -[automation.state docs]: https://home-assistant.io/docs/automation/trigger/#state-trigger -[binary_sensor docs]: https://home-assistant.io/components/binary_sensor/ -[binary_sensor.alarmdecoder docs]: https://home-assistant.io/components/binary_sensor.alarmdecoder/ -[binary_sensor.concord232 docs]: https://home-assistant.io/components/binary_sensor.concord232/ -[binary_sensor.deconz docs]: https://home-assistant.io/components/binary_sensor.deconz/ -[binary_sensor.isy994 docs]: https://home-assistant.io/components/binary_sensor.isy994/ -[binary_sensor.knx docs]: https://home-assistant.io/components/binary_sensor.knx/ -[binary_sensor.rest docs]: https://home-assistant.io/components/binary_sensor.rest/ -[binary_sensor.template docs]: https://home-assistant.io/components/binary_sensor.template/ -[binary_sensor.threshold docs]: https://home-assistant.io/components/binary_sensor.threshold/ -[binary_sensor.trend docs]: https://home-assistant.io/components/binary_sensor.trend/ -[binary_sensor.workday docs]: https://home-assistant.io/components/binary_sensor.workday/ -[camera.doorbird docs]: https://home-assistant.io/components/camera.doorbird/ -[camera.uvc docs]: https://home-assistant.io/components/camera.uvc/ -[climate docs]: https://home-assistant.io/components/climate/ -[climate.daikin docs]: https://home-assistant.io/components/climate.daikin/ -[climate.demo docs]: https://home-assistant.io/components/climate.demo/ -[climate.econet docs]: https://home-assistant.io/components/climate.econet/ -[climate.generic_thermostat docs]: https://home-assistant.io/components/climate.generic_thermostat/ -[climate.hive docs]: https://home-assistant.io/components/climate.hive/ -[climate.homematic docs]: https://home-assistant.io/components/climate.homematic/ -[climate.knx docs]: https://home-assistant.io/components/climate.knx/ -[climate.netatmo docs]: https://home-assistant.io/components/climate.netatmo/ -[climate.sensibo docs]: https://home-assistant.io/components/climate.sensibo/ -[climate.tado docs]: https://home-assistant.io/components/climate.tado/ -[climate.touchline docs]: https://home-assistant.io/components/climate.touchline/ -[cloud docs]: https://home-assistant.io/components/cloud/ -[cloud.auth_api docs]: https://home-assistant.io/components/cloud.auth_api/ -[cloud.http_api docs]: https://home-assistant.io/components/cloud.http_api/ -[cloud.iot docs]: https://home-assistant.io/components/cloud.iot/ -[coinbase docs]: https://home-assistant.io/components/coinbase/ -[conversation docs]: https://home-assistant.io/components/conversation/ -[cover.isy994 docs]: https://home-assistant.io/components/cover.isy994/ -[cover.knx docs]: https://home-assistant.io/components/cover.knx/ -[cover.tahoma docs]: https://home-assistant.io/components/cover.tahoma/ -[cover.template docs]: https://home-assistant.io/components/cover.template/ -[cover.xiaomi_aqara docs]: https://home-assistant.io/components/cover.xiaomi_aqara/ -[deconz docs]: https://home-assistant.io/components/deconz/ -[device_tracker docs]: https://home-assistant.io/components/device_tracker/ -[device_tracker.asuswrt docs]: https://home-assistant.io/components/device_tracker.asuswrt/ -[device_tracker.bluetooth_le_tracker docs]: https://home-assistant.io/components/device_tracker.bluetooth_le_tracker/ -[device_tracker.bluetooth_tracker docs]: https://home-assistant.io/components/device_tracker.bluetooth_tracker/ -[device_tracker.gpslogger docs]: https://home-assistant.io/components/device_tracker.gpslogger/ -[device_tracker.owntracks docs]: https://home-assistant.io/components/device_tracker.owntracks/ -[device_tracker.ping docs]: https://home-assistant.io/components/device_tracker.ping/ -[device_tracker.snmp docs]: https://home-assistant.io/components/device_tracker.snmp/ -[device_tracker.tile docs]: https://home-assistant.io/components/device_tracker.tile/ -[digital_ocean docs]: https://home-assistant.io/components/digital_ocean/ -[fan.insteon_local docs]: https://home-assistant.io/components/fan.insteon_local/ -[fan.isy994 docs]: https://home-assistant.io/components/fan.isy994/ -[fan.xiaomi_miio docs]: https://home-assistant.io/components/fan.xiaomi_miio/ -[google_assistant docs]: https://home-assistant.io/components/google_assistant/ -[google_assistant.http docs]: https://home-assistant.io/components/google_assistant.http/ -[google_assistant.smart_home docs]: https://home-assistant.io/components/google_assistant.smart_home/ -[group docs]: https://home-assistant.io/components/group/ -[hassio docs]: https://home-assistant.io/components/hassio/ -[history docs]: https://home-assistant.io/components/history/ -[hive docs]: https://home-assistant.io/components/hive/ -[homematic docs]: https://home-assistant.io/components/homematic/ -[http docs]: https://home-assistant.io/components/http/ -[image_processing.opencv docs]: https://home-assistant.io/components/image_processing.opencv/ -[input_boolean docs]: https://home-assistant.io/components/input_boolean/ -[input_select docs]: https://home-assistant.io/components/input_select/ -[insteon_local docs]: https://home-assistant.io/components/insteon_local/ -[isy994 docs]: https://home-assistant.io/components/isy994/ -[knx docs]: https://home-assistant.io/components/knx/ -[light.deconz docs]: https://home-assistant.io/components/light.deconz/ -[light.greenwave docs]: https://home-assistant.io/components/light.greenwave/ -[light.hive docs]: https://home-assistant.io/components/light.hive/ -[light.hue docs]: https://home-assistant.io/components/light.hue/ -[light.iglo docs]: https://home-assistant.io/components/light.iglo/ -[light.insteon_local docs]: https://home-assistant.io/components/light.insteon_local/ -[light.isy994 docs]: https://home-assistant.io/components/light.isy994/ -[light.knx docs]: https://home-assistant.io/components/light.knx/ -[light.lifx docs]: https://home-assistant.io/components/light.lifx/ -[light.mqtt docs]: https://home-assistant.io/components/light.mqtt/ -[light.osramlightify docs]: https://home-assistant.io/components/light.osramlightify/ -[light.template docs]: https://home-assistant.io/components/light.template/ -[light.tplink docs]: https://home-assistant.io/components/light.tplink/ -[light.xiaomi_miio docs]: https://home-assistant.io/components/light.xiaomi_miio/ -[light.zha docs]: https://home-assistant.io/components/light.zha/ -[lock.isy994 docs]: https://home-assistant.io/components/lock.isy994/ -[media_extractor docs]: https://home-assistant.io/components/media_extractor/ -[media_player.cast docs]: https://home-assistant.io/components/media_player.cast/ -[media_player.kodi docs]: https://home-assistant.io/components/media_player.kodi/ -[media_player.monoprice docs]: https://home-assistant.io/components/media_player.monoprice/ -[media_player.plex docs]: https://home-assistant.io/components/media_player.plex/ -[media_player.squeezebox docs]: https://home-assistant.io/components/media_player.squeezebox/ -[media_player.yamaha docs]: https://home-assistant.io/components/media_player.yamaha/ -[modbus docs]: https://home-assistant.io/components/modbus/ -[notify.html5 docs]: https://home-assistant.io/components/notify.html5/ -[notify.pushbullet docs]: https://home-assistant.io/components/notify.pushbullet/ -[notify.webostv docs]: https://home-assistant.io/components/notify.webostv/ -[octoprint docs]: https://home-assistant.io/components/octoprint/ -[prometheus docs]: https://home-assistant.io/components/prometheus/ -[python_script docs]: https://home-assistant.io/components/python_script/ -[rainbird docs]: https://home-assistant.io/components/rainbird/ -[remember_the_milk docs]: https://home-assistant.io/components/remember_the_milk/ -[sensor.alpha_vantage docs]: https://home-assistant.io/components/sensor.alpha_vantage/ -[sensor.bitcoin docs]: https://home-assistant.io/components/sensor.bitcoin/ -[sensor.coinbase docs]: https://home-assistant.io/components/sensor.coinbase/ -[sensor.deconz docs]: https://home-assistant.io/components/sensor.deconz/ -[sensor.deutsche_bahn docs]: https://home-assistant.io/components/sensor.deutsche_bahn/ -[sensor.discogs docs]: https://home-assistant.io/components/sensor.discogs/ -[sensor.etherscan docs]: https://home-assistant.io/components/sensor.etherscan/ -[sensor.fido docs]: https://home-assistant.io/components/sensor.fido/ -[sensor.hydroquebec docs]: https://home-assistant.io/components/sensor.hydroquebec/ -[sensor.imap_email_content docs]: https://home-assistant.io/components/sensor.imap_email_content/ -[sensor.irish_rail_transport docs]: https://home-assistant.io/components/sensor.irish_rail_transport/ -[sensor.isy994 docs]: https://home-assistant.io/components/sensor.isy994/ -[sensor.knx docs]: https://home-assistant.io/components/sensor.knx/ -[sensor.luftdaten docs]: https://home-assistant.io/components/sensor.luftdaten/ -[sensor.metoffice docs]: https://home-assistant.io/components/sensor.metoffice/ -[sensor.miflora docs]: https://home-assistant.io/components/sensor.miflora/ -[sensor.mqtt docs]: https://home-assistant.io/components/sensor.mqtt/ -[sensor.openweathermap docs]: https://home-assistant.io/components/sensor.openweathermap/ -[sensor.plex docs]: https://home-assistant.io/components/sensor.plex/ -[sensor.rainbird docs]: https://home-assistant.io/components/sensor.rainbird/ -[sensor.snmp docs]: https://home-assistant.io/components/sensor.snmp/ -[sensor.sochain docs]: https://home-assistant.io/components/sensor.sochain/ -[sensor.statistics docs]: https://home-assistant.io/components/sensor.statistics/ -[sensor.steam_online docs]: https://home-assistant.io/components/sensor.steam_online/ -[sensor.swiss_public_transport docs]: https://home-assistant.io/components/sensor.swiss_public_transport/ -[sensor.systemmonitor docs]: https://home-assistant.io/components/sensor.systemmonitor/ -[sensor.tado docs]: https://home-assistant.io/components/sensor.tado/ -[sensor.template docs]: https://home-assistant.io/components/sensor.template/ -[sensor.transmission docs]: https://home-assistant.io/components/sensor.transmission/ -[sensor.xbox_live docs]: https://home-assistant.io/components/sensor.xbox_live/ -[sensor.zoneminder docs]: https://home-assistant.io/components/sensor.zoneminder/ -[snips docs]: https://home-assistant.io/components/snips/ -[switch.insteon_local docs]: https://home-assistant.io/components/switch.insteon_local/ -[switch.isy994 docs]: https://home-assistant.io/components/switch.isy994/ -[switch.knx docs]: https://home-assistant.io/components/switch.knx/ -[switch.mochad docs]: https://home-assistant.io/components/switch.mochad/ -[switch.rainbird docs]: https://home-assistant.io/components/switch.rainbird/ -[switch.rpi_rf docs]: https://home-assistant.io/components/switch.rpi_rf/ -[switch.snmp docs]: https://home-assistant.io/components/switch.snmp/ -[switch.template docs]: https://home-assistant.io/components/switch.template/ -[switch.tplink docs]: https://home-assistant.io/components/switch.tplink/ -[switch.transmission docs]: https://home-assistant.io/components/switch.transmission/ -[switch.xiaomi_miio docs]: https://home-assistant.io/components/switch.xiaomi_miio/ -[tahoma docs]: https://home-assistant.io/components/tahoma/ -[telegram_bot docs]: https://home-assistant.io/components/telegram_bot/ -[timer docs]: https://home-assistant.io/components/timer/ -[tts.baidu docs]: https://home-assistant.io/components/tts.baidu/ -[tts.marytts docs]: https://home-assistant.io/components/tts.marytts/ -[updater docs]: https://home-assistant.io/components/updater/ -[vacuum.xiaomi_miio docs]: https://home-assistant.io/components/vacuum.xiaomi_miio/ -[weather.darksky docs]: https://home-assistant.io/components/weather.darksky/ -[weather.openweathermap docs]: https://home-assistant.io/components/weather.openweathermap/ -[weather.yweather docs]: https://home-assistant.io/components/weather.yweather/ -[websocket_api docs]: https://home-assistant.io/components/websocket_api/ -[wemo docs]: https://home-assistant.io/components/wemo/ -[zigbee docs]: https://home-assistant.io/components/zigbee/ +[__init__ docs]: /components/__init__/ +[alarm_control_panel.alarmdecoder docs]: /components/alarm_control_panel.alarmdecoder/ +[alarm_control_panel.concord232 docs]: /components/alarm_control_panel.concord232/ +[alarm_control_panel.egardia docs]: /components/alarm_control_panel.egardia/ +[alarmdecoder docs]: /components/alarmdecoder/ +[alexa.intent docs]: /components/alexa.intent/ +[alexa.smart_home docs]: /components/alexa.smart_home/ +[api docs]: /components/api/ +[automation.state docs]: /docs/automation/trigger/#state-trigger +[binary_sensor docs]: /components/binary_sensor/ +[binary_sensor.alarmdecoder docs]: /components/binary_sensor.alarmdecoder/ +[binary_sensor.concord232 docs]: /components/binary_sensor.concord232/ +[binary_sensor.deconz docs]: /components/binary_sensor.deconz/ +[binary_sensor.isy994 docs]: /components/binary_sensor.isy994/ +[binary_sensor.knx docs]: /components/binary_sensor.knx/ +[binary_sensor.rest docs]: /components/binary_sensor.rest/ +[binary_sensor.template docs]: /components/binary_sensor.template/ +[binary_sensor.threshold docs]: /components/binary_sensor.threshold/ +[binary_sensor.trend docs]: /components/binary_sensor.trend/ +[binary_sensor.workday docs]: /components/binary_sensor.workday/ +[camera.doorbird docs]: /components/camera.doorbird/ +[camera.uvc docs]: /components/camera.uvc/ +[climate docs]: /components/climate/ +[climate.daikin docs]: /components/climate.daikin/ +[climate.demo docs]: /components/climate.demo/ +[climate.econet docs]: /components/climate.econet/ +[climate.generic_thermostat docs]: /components/climate.generic_thermostat/ +[climate.hive docs]: /components/climate.hive/ +[climate.homematic docs]: /components/climate.homematic/ +[climate.knx docs]: /components/climate.knx/ +[climate.netatmo docs]: /components/climate.netatmo/ +[climate.sensibo docs]: /components/climate.sensibo/ +[climate.tado docs]: /components/climate.tado/ +[climate.touchline docs]: /components/climate.touchline/ +[cloud docs]: /components/cloud/ +[cloud.auth_api docs]: /components/cloud.auth_api/ +[cloud.http_api docs]: /components/cloud.http_api/ +[cloud.iot docs]: /components/cloud.iot/ +[coinbase docs]: /components/coinbase/ +[conversation docs]: /components/conversation/ +[cover.isy994 docs]: /components/cover.isy994/ +[cover.knx docs]: /components/cover.knx/ +[cover.tahoma docs]: /components/cover.tahoma/ +[cover.template docs]: /components/cover.template/ +[cover.xiaomi_aqara docs]: /components/cover.xiaomi_aqara/ +[deconz docs]: /components/deconz/ +[device_tracker docs]: /components/device_tracker/ +[device_tracker.asuswrt docs]: /components/device_tracker.asuswrt/ +[device_tracker.bluetooth_le_tracker docs]: /components/device_tracker.bluetooth_le_tracker/ +[device_tracker.bluetooth_tracker docs]: /components/device_tracker.bluetooth_tracker/ +[device_tracker.gpslogger docs]: /components/device_tracker.gpslogger/ +[device_tracker.owntracks docs]: /components/device_tracker.owntracks/ +[device_tracker.ping docs]: /components/device_tracker.ping/ +[device_tracker.snmp docs]: /components/device_tracker.snmp/ +[device_tracker.tile docs]: /components/device_tracker.tile/ +[digital_ocean docs]: /components/digital_ocean/ +[fan.insteon_local docs]: /components/fan.insteon_local/ +[fan.isy994 docs]: /components/fan.isy994/ +[fan.xiaomi_miio docs]: /components/fan.xiaomi_miio/ +[google_assistant docs]: /components/google_assistant/ +[google_assistant.http docs]: /components/google_assistant.http/ +[google_assistant.smart_home docs]: /components/google_assistant.smart_home/ +[group docs]: /components/group/ +[hassio docs]: /components/hassio/ +[history docs]: /components/history/ +[hive docs]: /components/hive/ +[homematic docs]: /components/homematic/ +[http docs]: /components/http/ +[image_processing.opencv docs]: /components/image_processing.opencv/ +[input_boolean docs]: /components/input_boolean/ +[input_select docs]: /components/input_select/ +[insteon_local docs]: /components/insteon_local/ +[isy994 docs]: /components/isy994/ +[knx docs]: /components/knx/ +[light.deconz docs]: /components/light.deconz/ +[light.greenwave docs]: /components/light.greenwave/ +[light.hive docs]: /components/light.hive/ +[light.hue docs]: /components/light.hue/ +[light.iglo docs]: /components/light.iglo/ +[light.insteon_local docs]: /components/light.insteon_local/ +[light.isy994 docs]: /components/light.isy994/ +[light.knx docs]: /components/light.knx/ +[light.lifx docs]: /components/light.lifx/ +[light.mqtt docs]: /components/light.mqtt/ +[light.osramlightify docs]: /components/light.osramlightify/ +[light.template docs]: /components/light.template/ +[light.tplink docs]: /components/light.tplink/ +[light.xiaomi_miio docs]: /components/light.xiaomi_miio/ +[light.zha docs]: /components/light.zha/ +[lock.isy994 docs]: /components/lock.isy994/ +[media_extractor docs]: /components/media_extractor/ +[media_player.cast docs]: /components/media_player.cast/ +[media_player.kodi docs]: /components/media_player.kodi/ +[media_player.monoprice docs]: /components/media_player.monoprice/ +[media_player.plex docs]: /components/media_player.plex/ +[media_player.squeezebox docs]: /components/media_player.squeezebox/ +[media_player.yamaha docs]: /components/media_player.yamaha/ +[modbus docs]: /components/modbus/ +[notify.html5 docs]: /components/notify.html5/ +[notify.pushbullet docs]: /components/notify.pushbullet/ +[notify.webostv docs]: /components/notify.webostv/ +[octoprint docs]: /components/octoprint/ +[prometheus docs]: /components/prometheus/ +[python_script docs]: /components/python_script/ +[rainbird docs]: /components/rainbird/ +[remember_the_milk docs]: /components/remember_the_milk/ +[sensor.alpha_vantage docs]: /components/sensor.alpha_vantage/ +[sensor.bitcoin docs]: /components/sensor.bitcoin/ +[sensor.coinbase docs]: /components/sensor.coinbase/ +[sensor.deconz docs]: /components/sensor.deconz/ +[sensor.deutsche_bahn docs]: /components/sensor.deutsche_bahn/ +[sensor.discogs docs]: /components/sensor.discogs/ +[sensor.etherscan docs]: /components/sensor.etherscan/ +[sensor.fido docs]: /components/sensor.fido/ +[sensor.hydroquebec docs]: /components/sensor.hydroquebec/ +[sensor.imap_email_content docs]: /components/sensor.imap_email_content/ +[sensor.irish_rail_transport docs]: /components/sensor.irish_rail_transport/ +[sensor.isy994 docs]: /components/sensor.isy994/ +[sensor.knx docs]: /components/sensor.knx/ +[sensor.luftdaten docs]: /components/sensor.luftdaten/ +[sensor.metoffice docs]: /components/sensor.metoffice/ +[sensor.miflora docs]: /components/sensor.miflora/ +[sensor.mqtt docs]: /components/sensor.mqtt/ +[sensor.openweathermap docs]: /components/sensor.openweathermap/ +[sensor.plex docs]: /components/sensor.plex/ +[sensor.rainbird docs]: /components/sensor.rainbird/ +[sensor.snmp docs]: /components/sensor.snmp/ +[sensor.sochain docs]: /components/sensor.sochain/ +[sensor.statistics docs]: /components/sensor.statistics/ +[sensor.steam_online docs]: /components/sensor.steam_online/ +[sensor.swiss_public_transport docs]: /components/sensor.swiss_public_transport/ +[sensor.systemmonitor docs]: /components/sensor.systemmonitor/ +[sensor.tado docs]: /components/sensor.tado/ +[sensor.template docs]: /components/sensor.template/ +[sensor.transmission docs]: /components/sensor.transmission/ +[sensor.xbox_live docs]: /components/sensor.xbox_live/ +[sensor.zoneminder docs]: /components/sensor.zoneminder/ +[snips docs]: /components/snips/ +[switch.insteon_local docs]: /components/switch.insteon_local/ +[switch.isy994 docs]: /components/switch.isy994/ +[switch.knx docs]: /components/switch.knx/ +[switch.mochad docs]: /components/switch.mochad/ +[switch.rainbird docs]: /components/switch.rainbird/ +[switch.rpi_rf docs]: /components/switch.rpi_rf/ +[switch.snmp docs]: /components/switch.snmp/ +[switch.template docs]: /components/switch.template/ +[switch.tplink docs]: /components/switch.tplink/ +[switch.transmission docs]: /components/switch.transmission/ +[switch.xiaomi_miio docs]: /components/switch.xiaomi_miio/ +[tahoma docs]: /components/tahoma/ +[telegram_bot docs]: /components/telegram_bot/ +[timer docs]: /components/timer/ +[tts.baidu docs]: /components/tts.baidu/ +[tts.marytts docs]: /components/tts.marytts/ +[updater docs]: /components/updater/ +[vacuum.xiaomi_miio docs]: /components/vacuum.xiaomi_miio/ +[weather.darksky docs]: /components/weather.darksky/ +[weather.openweathermap docs]: /components/weather.openweathermap/ +[weather.yweather docs]: /components/weather.yweather/ +[websocket_api docs]: /components/websocket_api/ +[wemo docs]: /components/wemo/ +[zigbee docs]: /components/zigbee/ [#11670]: https://github.com/home-assistant/home-assistant/pull/11670 [#11677]: https://github.com/home-assistant/home-assistant/pull/11677 [#11678]: https://github.com/home-assistant/home-assistant/pull/11678 @@ -784,14 +784,14 @@ Note however, that this feature was replaced by a new ignore_string config optio [@rcloran]: https://github.com/rcloran [@rwa]: https://github.com/rwa [@tinloaf]: https://github.com/tinloaf -[binary_sensor.rfxtrx docs]: https://home-assistant.io/components/binary_sensor.rfxtrx/ -[calendar.todoist docs]: https://home-assistant.io/components/calendar.todoist/ -[history docs]: https://home-assistant.io/components/history/ -[light.zha docs]: https://home-assistant.io/components/light.zha/ -[media_player.snapcast docs]: https://home-assistant.io/components/media_player.snapcast/ -[media_player.soundtouch docs]: https://home-assistant.io/components/media_player.soundtouch/ -[rfxtrx docs]: https://home-assistant.io/components/rfxtrx/ -[sensor.mopar docs]: https://home-assistant.io/components/sensor.mopar/ -[switch.broadlink docs]: https://home-assistant.io/components/switch.broadlink/ -[switch.scsgate docs]: https://home-assistant.io/components/switch.scsgate/ -[zha docs]: https://home-assistant.io/components/zha/ +[binary_sensor.rfxtrx docs]: /components/binary_sensor.rfxtrx/ +[calendar.todoist docs]: /components/calendar.todoist/ +[history docs]: /components/history/ +[light.zha docs]: /components/light.zha/ +[media_player.snapcast docs]: /components/media_player.snapcast/ +[media_player.soundtouch docs]: /components/media_player.soundtouch/ +[rfxtrx docs]: /components/rfxtrx/ +[sensor.mopar docs]: /components/sensor.mopar/ +[switch.broadlink docs]: /components/switch.broadlink/ +[switch.scsgate docs]: /components/switch.scsgate/ +[zha docs]: /components/zha/ diff --git a/source/_posts/2018-01-21-clarification-emulated-hue.markdown b/source/_posts/2018-01-21-clarification-emulated-hue.markdown index 5284113bc5..b1b9138ae7 100644 --- a/source/_posts/2018-01-21-clarification-emulated-hue.markdown +++ b/source/_posts/2018-01-21-clarification-emulated-hue.markdown @@ -31,4 +31,4 @@ More info: [pr1]: https://github.com/home-assistant/home-assistant/pull/4708 [pr2]: https://github.com/home-assistant/home-assistant/pull/5549 -[eh-conf]: https://home-assistant.io/components/emulated_hue/#configuration +[eh-conf]: /components/emulated_hue/#configuration diff --git a/source/_posts/2018-01-27-release-62.markdown b/source/_posts/2018-01-27-release-62.markdown index 8bb54a09f0..1b72621881 100644 --- a/source/_posts/2018-01-27-release-62.markdown +++ b/source/_posts/2018-01-27-release-62.markdown @@ -383,109 +383,109 @@ Experiencing issues introduced by this release? Please report them in our [issue [@ttroy50]: https://github.com/ttroy50 [@w1ll1am23]: https://github.com/w1ll1am23 [@zabuldon]: https://github.com/zabuldon -[alarm_control_panel.mqtt docs]: https://home-assistant.io/components/alarm_control_panel.mqtt/ -[alexa docs]: https://home-assistant.io/components/alexa/ -[asterisk_mbox docs]: https://home-assistant.io/components/asterisk_mbox/ -[axis docs]: https://home-assistant.io/components/axis/ -[binary_sensor.deconz docs]: https://home-assistant.io/components/binary_sensor.deconz/ -[binary_sensor.hive docs]: https://home-assistant.io/components/binary_sensor.hive/ -[binary_sensor.ihc docs]: https://home-assistant.io/components/binary_sensor.ihc/ -[binary_sensor.maxcube docs]: https://home-assistant.io/components/binary_sensor.maxcube/ -[binary_sensor.rfxtrx docs]: https://home-assistant.io/components/binary_sensor.rfxtrx/ -[binary_sensor.wink docs]: https://home-assistant.io/components/binary_sensor.wink/ -[binary_sensor.workday docs]: https://home-assistant.io/components/binary_sensor.workday/ -[binary_sensor.xiaomi_aqara docs]: https://home-assistant.io/components/binary_sensor.xiaomi_aqara/ -[camera.foscam docs]: https://home-assistant.io/components/camera.foscam/ -[camera.onvif docs]: https://home-assistant.io/components/camera.onvif/ -[climate docs]: https://home-assistant.io/components/climate/ -[climate.daikin docs]: https://home-assistant.io/components/climate.daikin/ -[climate.econet docs]: https://home-assistant.io/components/climate.econet/ -[climate.ephember docs]: https://home-assistant.io/components/climate.ephember/ -[climate.eq3btsmart docs]: https://home-assistant.io/components/climate.eq3btsmart/ -[climate.hive docs]: https://home-assistant.io/components/climate.hive/ -[climate.nest docs]: https://home-assistant.io/components/climate.nest/ -[climate.sensibo docs]: https://home-assistant.io/components/climate.sensibo/ -[climate.wink docs]: https://home-assistant.io/components/climate.wink/ -[cover.homematic docs]: https://home-assistant.io/components/cover.homematic/ -[cover.lutron docs]: https://home-assistant.io/components/cover.lutron/ -[cover.tahoma docs]: https://home-assistant.io/components/cover.tahoma/ -[cover.wink docs]: https://home-assistant.io/components/cover.wink/ -[cover.xiaomi_aqara docs]: https://home-assistant.io/components/cover.xiaomi_aqara/ -[deconz docs]: https://home-assistant.io/components/deconz/ -[device_tracker.asuswrt docs]: https://home-assistant.io/components/device_tracker.asuswrt/ -[device_tracker.owntracks docs]: https://home-assistant.io/components/device_tracker.owntracks/ -[device_tracker.tomato docs]: https://home-assistant.io/components/device_tracker.tomato/ -[device_tracker.unifi_direct docs]: https://home-assistant.io/components/device_tracker.unifi_direct/ -[ecobee docs]: https://home-assistant.io/components/ecobee/ -[emulated_hue docs]: https://home-assistant.io/components/emulated_hue/ -[fan.xiaomi_miio docs]: https://home-assistant.io/components/fan.xiaomi_miio/ -[google_assistant docs]: https://home-assistant.io/components/google_assistant/ -[hassio docs]: https://home-assistant.io/components/hassio/ -[hive docs]: https://home-assistant.io/components/hive/ -[homematic docs]: https://home-assistant.io/components/homematic/ -[hue docs]: https://home-assistant.io/components/hue/ -[ihc docs]: https://home-assistant.io/components/ihc/ -[ihc.const docs]: https://home-assistant.io/components/ihc.const/ -[ihc.ihcdevice docs]: https://home-assistant.io/components/ihc.ihcdevice/ -[iota docs]: https://home-assistant.io/components/iota/ -[light.deconz docs]: https://home-assistant.io/components/light.deconz/ -[light.decora docs]: https://home-assistant.io/components/light.decora/ -[light.flux_led docs]: https://home-assistant.io/components/light.flux_led/ -[light.greenwave docs]: https://home-assistant.io/components/light.greenwave/ -[light.hive docs]: https://home-assistant.io/components/light.hive/ -[light.hyperion docs]: https://home-assistant.io/components/light.hyperion/ -[light.ihc docs]: https://home-assistant.io/components/light.ihc/ -[light.tplink docs]: https://home-assistant.io/components/light.tplink/ -[light.wemo docs]: https://home-assistant.io/components/light.wemo/ -[light.xiaomi_aqara docs]: https://home-assistant.io/components/light.xiaomi_aqara/ -[light.xiaomi_miio docs]: https://home-assistant.io/components/light.xiaomi_miio/ -[lutron docs]: https://home-assistant.io/components/lutron/ -[map docs]: https://home-assistant.io/components/map/ -[media_player.samsungtv docs]: https://home-assistant.io/components/media_player.samsungtv/ -[media_player.sonos docs]: https://home-assistant.io/components/media_player.sonos/ -[media_player.yamaha docs]: https://home-assistant.io/components/media_player.yamaha/ -[notify.clicksend docs]: https://home-assistant.io/components/notify.clicksend/ -[notify.prowl docs]: https://home-assistant.io/components/notify.prowl/ -[plant docs]: https://home-assistant.io/components/plant/ -[rfxtrx docs]: https://home-assistant.io/components/rfxtrx/ -[scene docs]: https://home-assistant.io/components/scene/ -[sensor.alpha_vantage docs]: https://home-assistant.io/components/sensor.alpha_vantage/ -[sensor.linux_battery docs]: https://home-assistant.io/components/sensor.linux_battery/ -[sensor.bme680 docs]: https://home-assistant.io/components/sensor.bme680/ -[sensor.deconz docs]: https://home-assistant.io/components/sensor.deconz/ -[sensor.etherscan docs]: https://home-assistant.io/components/sensor.etherscan/ -[sensor.fixer docs]: https://home-assistant.io/components/sensor.fixer/ -[sensor.hive docs]: https://home-assistant.io/components/sensor.hive/ -[sensor.ihc docs]: https://home-assistant.io/components/sensor.ihc/ -[sensor.iota docs]: https://home-assistant.io/components/sensor.iota/ -[sensor.metoffice docs]: https://home-assistant.io/components/sensor.metoffice/ -[sensor.miflora docs]: https://home-assistant.io/components/sensor.miflora/ -[sensor.min_max docs]: https://home-assistant.io/components/sensor.min_max/ -[sensor.mold_indicator docs]: https://home-assistant.io/components/sensor.mold_indicator/ -[mychevy docs]: https://home-assistant.io/components/mychevy/ -[sensor.openweathermap docs]: https://home-assistant.io/components/sensor.openweathermap/ -[sensor.random docs]: https://home-assistant.io/components/sensor.random/ -[sensor.teksavvy docs]: https://home-assistant.io/components/sensor.teksavvy/ -[sensor.xbox_live docs]: https://home-assistant.io/components/sensor.xbox_live/ -[sensor.xiaomi_aqara docs]: https://home-assistant.io/components/sensor.xiaomi_aqara/ -[sensor.yr docs]: https://home-assistant.io/components/sensor.yr/ -[snips docs]: https://home-assistant.io/components/snips/ -[switch.fritzdect docs]: https://home-assistant.io/components/switch.fritzdect/ -[switch.hive docs]: https://home-assistant.io/components/switch.hive/ -[switch.ihc docs]: https://home-assistant.io/components/switch.ihc/ -[switch.snmp docs]: https://home-assistant.io/components/switch.snmp/ -[switch.tplink docs]: https://home-assistant.io/components/switch.tplink/ -[switch.xiaomi_aqara docs]: https://home-assistant.io/components/switch.xiaomi_aqara/ -[switch.xiaomi_miio docs]: https://home-assistant.io/components/switch.xiaomi_miio/ -[system_log docs]: https://home-assistant.io/components/system_log/ -[tahoma docs]: https://home-assistant.io/components/tahoma/ -[tts.google docs]: https://home-assistant.io/components/tts.google/ -[vacuum.xiaomi_miio docs]: https://home-assistant.io/components/vacuum.xiaomi_miio/ -[waterfurnace docs]: https://home-assistant.io/components/waterfurnace/ -[wemo docs]: https://home-assistant.io/components/wemo/ -[wink docs]: https://home-assistant.io/components/wink/ -[xiaomi_aqara docs]: https://home-assistant.io/components/xiaomi_aqara/ -[zwave docs]: https://home-assistant.io/components/zwave/ +[alarm_control_panel.mqtt docs]: /components/alarm_control_panel.mqtt/ +[alexa docs]: /components/alexa/ +[asterisk_mbox docs]: /components/asterisk_mbox/ +[axis docs]: /components/axis/ +[binary_sensor.deconz docs]: /components/binary_sensor.deconz/ +[binary_sensor.hive docs]: /components/binary_sensor.hive/ +[binary_sensor.ihc docs]: /components/binary_sensor.ihc/ +[binary_sensor.maxcube docs]: /components/binary_sensor.maxcube/ +[binary_sensor.rfxtrx docs]: /components/binary_sensor.rfxtrx/ +[binary_sensor.wink docs]: /components/binary_sensor.wink/ +[binary_sensor.workday docs]: /components/binary_sensor.workday/ +[binary_sensor.xiaomi_aqara docs]: /components/binary_sensor.xiaomi_aqara/ +[camera.foscam docs]: /components/camera.foscam/ +[camera.onvif docs]: /components/camera.onvif/ +[climate docs]: /components/climate/ +[climate.daikin docs]: /components/climate.daikin/ +[climate.econet docs]: /components/climate.econet/ +[climate.ephember docs]: /components/climate.ephember/ +[climate.eq3btsmart docs]: /components/climate.eq3btsmart/ +[climate.hive docs]: /components/climate.hive/ +[climate.nest docs]: /components/climate.nest/ +[climate.sensibo docs]: /components/climate.sensibo/ +[climate.wink docs]: /components/climate.wink/ +[cover.homematic docs]: /components/cover.homematic/ +[cover.lutron docs]: /components/cover.lutron/ +[cover.tahoma docs]: /components/cover.tahoma/ +[cover.wink docs]: /components/cover.wink/ +[cover.xiaomi_aqara docs]: /components/cover.xiaomi_aqara/ +[deconz docs]: /components/deconz/ +[device_tracker.asuswrt docs]: /components/device_tracker.asuswrt/ +[device_tracker.owntracks docs]: /components/device_tracker.owntracks/ +[device_tracker.tomato docs]: /components/device_tracker.tomato/ +[device_tracker.unifi_direct docs]: /components/device_tracker.unifi_direct/ +[ecobee docs]: /components/ecobee/ +[emulated_hue docs]: /components/emulated_hue/ +[fan.xiaomi_miio docs]: /components/fan.xiaomi_miio/ +[google_assistant docs]: /components/google_assistant/ +[hassio docs]: /components/hassio/ +[hive docs]: /components/hive/ +[homematic docs]: /components/homematic/ +[hue docs]: /components/hue/ +[ihc docs]: /components/ihc/ +[ihc.const docs]: /components/ihc.const/ +[ihc.ihcdevice docs]: /components/ihc.ihcdevice/ +[iota docs]: /components/iota/ +[light.deconz docs]: /components/light.deconz/ +[light.decora docs]: /components/light.decora/ +[light.flux_led docs]: /components/light.flux_led/ +[light.greenwave docs]: /components/light.greenwave/ +[light.hive docs]: /components/light.hive/ +[light.hyperion docs]: /components/light.hyperion/ +[light.ihc docs]: /components/light.ihc/ +[light.tplink docs]: /components/light.tplink/ +[light.wemo docs]: /components/light.wemo/ +[light.xiaomi_aqara docs]: /components/light.xiaomi_aqara/ +[light.xiaomi_miio docs]: /components/light.xiaomi_miio/ +[lutron docs]: /components/lutron/ +[map docs]: /components/map/ +[media_player.samsungtv docs]: /components/media_player.samsungtv/ +[media_player.sonos docs]: /components/media_player.sonos/ +[media_player.yamaha docs]: /components/media_player.yamaha/ +[notify.clicksend docs]: /components/notify.clicksend/ +[notify.prowl docs]: /components/notify.prowl/ +[plant docs]: /components/plant/ +[rfxtrx docs]: /components/rfxtrx/ +[scene docs]: /components/scene/ +[sensor.alpha_vantage docs]: /components/sensor.alpha_vantage/ +[sensor.linux_battery docs]: /components/sensor.linux_battery/ +[sensor.bme680 docs]: /components/sensor.bme680/ +[sensor.deconz docs]: /components/sensor.deconz/ +[sensor.etherscan docs]: /components/sensor.etherscan/ +[sensor.fixer docs]: /components/sensor.fixer/ +[sensor.hive docs]: /components/sensor.hive/ +[sensor.ihc docs]: /components/sensor.ihc/ +[sensor.iota docs]: /components/sensor.iota/ +[sensor.metoffice docs]: /components/sensor.metoffice/ +[sensor.miflora docs]: /components/sensor.miflora/ +[sensor.min_max docs]: /components/sensor.min_max/ +[sensor.mold_indicator docs]: /components/sensor.mold_indicator/ +[mychevy docs]: /components/mychevy/ +[sensor.openweathermap docs]: /components/sensor.openweathermap/ +[sensor.random docs]: /components/sensor.random/ +[sensor.teksavvy docs]: /components/sensor.teksavvy/ +[sensor.xbox_live docs]: /components/sensor.xbox_live/ +[sensor.xiaomi_aqara docs]: /components/sensor.xiaomi_aqara/ +[sensor.yr docs]: /components/sensor.yr/ +[snips docs]: /components/snips/ +[switch.fritzdect docs]: /components/switch.fritzdect/ +[switch.hive docs]: /components/switch.hive/ +[switch.ihc docs]: /components/switch.ihc/ +[switch.snmp docs]: /components/switch.snmp/ +[switch.tplink docs]: /components/switch.tplink/ +[switch.xiaomi_aqara docs]: /components/switch.xiaomi_aqara/ +[switch.xiaomi_miio docs]: /components/switch.xiaomi_miio/ +[system_log docs]: /components/system_log/ +[tahoma docs]: /components/tahoma/ +[tts.google docs]: /components/tts.google/ +[vacuum.xiaomi_miio docs]: /components/vacuum.xiaomi_miio/ +[waterfurnace docs]: /components/waterfurnace/ +[wemo docs]: /components/wemo/ +[wink docs]: /components/wink/ +[xiaomi_aqara docs]: /components/xiaomi_aqara/ +[zwave docs]: /components/zwave/ [@martinhjelmare]: https://github.com/martinhjelmare [@frenck]: https://github.com/frenck [#11929]: https://github.com/home-assistant/home-assistant/pull/11929 @@ -502,10 +502,10 @@ Experiencing issues introduced by this release? Please report them in our [issue [@scop]: https://github.com/scop [@smoldaner]: https://github.com/smoldaner [@tschmidty69]: https://github.com/tschmidty69 -[climate.daikin docs]: https://home-assistant.io/components/climate.daikin/ -[device_tracker.asuswrt docs]: https://home-assistant.io/components/device_tracker.asuswrt/ -[frontend docs]: https://home-assistant.io/components/frontend/ -[media_player.squeezebox docs]: https://home-assistant.io/components/media_player.squeezebox/ -[remote.harmony docs]: https://home-assistant.io/components/remote.harmony/ -[sensor.deutsche_bahn docs]: https://home-assistant.io/components/sensor.deutsche_bahn/ -[snips docs]: https://home-assistant.io/components/snips/ +[climate.daikin docs]: /components/climate.daikin/ +[device_tracker.asuswrt docs]: /components/device_tracker.asuswrt/ +[frontend docs]: /components/frontend/ +[media_player.squeezebox docs]: /components/media_player.squeezebox/ +[remote.harmony docs]: /components/remote.harmony/ +[sensor.deutsche_bahn docs]: /components/sensor.deutsche_bahn/ +[snips docs]: /components/snips/ diff --git a/source/_posts/2018-02-09-disabling-disqus.markdown b/source/_posts/2018-02-09-disabling-disqus.markdown index 980c035521..6183c238f6 100644 --- a/source/_posts/2018-02-09-disabling-disqus.markdown +++ b/source/_posts/2018-02-09-disabling-disqus.markdown @@ -10,7 +10,7 @@ comments: true categories: Community --- -Last week, starting with the release of [Home Assistant 0.62](https://home-assistant.io/blog/2018/01/27/release-62/), we switched to using our [community forums](https://community.home-assistant.io) for comments on our blog posts. By doing so, people are able to use their existing Home Assistant community accounts to comment on our blog posts and engage with one another. It has been easier for our users to stay in the loop with one less channel to keep track off. +Last week, starting with the release of [Home Assistant 0.62](/blog/2018/01/27/release-62/), we switched to using our [community forums](https://community.home-assistant.io) for comments on our blog posts. By doing so, people are able to use their existing Home Assistant community accounts to comment on our blog posts and engage with one another. It has been easier for our users to stay in the loop with one less channel to keep track off. Previously, we were using the free version of Disqus to power comments on our blog. After the switch, to preserve the old comments, we decided to keep Disqus active on the older blog post pages. However, today we decided to turn them off. diff --git a/source/_posts/2018-02-10-release-63.markdown b/source/_posts/2018-02-10-release-63.markdown index 185b28ad13..dc23d2029f 100644 --- a/source/_posts/2018-02-10-release-63.markdown +++ b/source/_posts/2018-02-10-release-63.markdown @@ -15,7 +15,7 @@ og_image: /images/blog/2018-02-0.63/components.png ## {% linkable_title Date set for dropping Python 3.4 support %} -As [announced in October](https://home-assistant.io/blog/2017/10/06/deprecating-python-3.4-support/), we're going to drop Python 3.4 support in 2018. We've now decided that in two releases, 0.65, the minimum Python version that will be supported is bumped to 3.5.3. This won't impact most users. You are already fine if you're using Hass.io, the latest Debian stable (Stretch) or a derivative of that (Raspbian, Ubuntu). +As [announced in October](/blog/2017/10/06/deprecating-python-3.4-support/), we're going to drop Python 3.4 support in 2018. We've now decided that in two releases, 0.65, the minimum Python version that will be supported is bumped to 3.5.3. This won't impact most users. You are already fine if you're using Hass.io, the latest Debian stable (Stretch) or a derivative of that (Raspbian, Ubuntu). ## {% linkable_title Entity Registry %} @@ -85,10 +85,10 @@ Experiencing issues introduced by this release? Please report them in our [issue - Originally Canary camera is added per location and only displays an image that was captured due to motion. Now it is per device (each location can have multiple devices) with live stream support. ([@snjoetw] - [#11949]) ([canary docs]) ([camera.canary docs]) (breaking change) - Avoid influxdb filling connection pool: The influxdb `retry_queue_limit` configuration variable no longer has any effect and can be removed. ([@amelchio] - [#12182]) ([influxdb docs]) (breaking change) - Some spelling mistakes in default entity names have been fixed in ([@OttoWinter] - [#12041]). This is causing these `entity_id` changes: - - [Seven segments display](https://home-assistant.io/components/image_processing.seven_segments/): `image_processing.seven_segement_ocr_[...]` → `image_processing.seven_segment_ocr_[...]` - - [Rain Bird Switch](https://home-assistant.io/components/switch.rainbird/): `switch.sprinker_[...]` → `switch.sprinkler_[...]` - - [OpenEVSE Sensor](https://home-assistant.io/components/sensor.openevse/): `sensor.ambient_termperature` → `sensor.ambient_temperature` - - [Fido](https://home-assistant.io/components/sensor.fido/): `sensor.[...]_internaltional_remaining` → `sensor.[...]_international remaining` + - [Seven segments display](/components/image_processing.seven_segments/): `image_processing.seven_segement_ocr_[...]` → `image_processing.seven_segment_ocr_[...]` + - [Rain Bird Switch](/components/switch.rainbird/): `switch.sprinker_[...]` → `switch.sprinkler_[...]` + - [OpenEVSE Sensor](/components/sensor.openevse/): `sensor.ambient_termperature` → `sensor.ambient_temperature` + - [Fido](/components/sensor.fido/): `sensor.[...]_internaltional_remaining` → `sensor.[...]_international remaining` - From version 0.64, Home Assistant will by default purge recorded state history that is older than 10 days. If you want to keep your recorded data for longer than that, you must configure the number of days to retain: ```yaml recorder: @@ -503,136 +503,136 @@ Experiencing issues introduced by this release? Please report them in our [issue [@w1ll1am23]: https://github.com/w1ll1am23 [@wardcraigj]: https://github.com/wardcraigj [@zabuldon]: https://github.com/zabuldon -[alexa docs]: https://home-assistant.io/components/alexa/ -[binary_sensor.deconz docs]: https://home-assistant.io/components/binary_sensor.deconz/ -[binary_sensor.mercedesme docs]: https://home-assistant.io/components/binary_sensor.mercedesme/ -[binary_sensor.mqtt docs]: https://home-assistant.io/components/binary_sensor.mqtt/ -[binary_sensor.template docs]: https://home-assistant.io/components/binary_sensor.template/ -[binary_sensor.threshold docs]: https://home-assistant.io/components/binary_sensor.threshold/ -[binary_sensor.zha docs]: https://home-assistant.io/components/binary_sensor.zha/ -[camera.canary docs]: https://home-assistant.io/components/camera.canary/ -[camera.uvc docs]: https://home-assistant.io/components/camera.uvc/ -[camera.xeoma docs]: https://home-assistant.io/components/camera.xeoma/ -[canary docs]: https://home-assistant.io/components/canary/ -[climate.demo docs]: https://home-assistant.io/components/climate.demo/ -[climate.ecobee docs]: https://home-assistant.io/components/climate.ecobee/ -[climate.econet docs]: https://home-assistant.io/components/climate.econet/ -[climate.generic_thermostat docs]: https://home-assistant.io/components/climate.generic_thermostat/ -[climate.heatmiser docs]: https://home-assistant.io/components/climate.heatmiser/ -[climate.melissa docs]: https://home-assistant.io/components/climate.melissa/ -[climate.nest docs]: https://home-assistant.io/components/climate.nest/ -[climate.tado docs]: https://home-assistant.io/components/climate.tado/ -[climate.touchline docs]: https://home-assistant.io/components/climate.touchline/ -[climate.venstar docs]: https://home-assistant.io/components/climate.venstar/ -[cloud docs]: https://home-assistant.io/components/cloud/ -[coinbase docs]: https://home-assistant.io/components/coinbase/ -[cover.mqtt docs]: https://home-assistant.io/components/cover.mqtt/ -[cover.tahoma docs]: https://home-assistant.io/components/cover.tahoma/ -[cover.template docs]: https://home-assistant.io/components/cover.template/ -[deconz docs]: https://home-assistant.io/components/deconz/ -[device_tracker.huawei_router docs]: https://home-assistant.io/components/device_tracker.huawei_router/ -[device_tracker.mercedesme docs]: https://home-assistant.io/components/device_tracker.mercedesme/ -[device_tracker.mikrotik docs]: https://home-assistant.io/components/device_tracker.mikrotik/ -[device_tracker.mqtt docs]: https://home-assistant.io/components/device_tracker.mqtt/ -[device_tracker.owntracks docs]: https://home-assistant.io/components/device_tracker.owntracks/ -[device_tracker.ubus docs]: https://home-assistant.io/components/device_tracker.ubus/ -[doorbird docs]: https://home-assistant.io/components/doorbird/ -[emulated_hue docs]: https://home-assistant.io/components/emulated_hue/ -[fan.xiaomi_miio docs]: https://home-assistant.io/components/fan.xiaomi_miio/ -[feedreader docs]: https://home-assistant.io/components/feedreader/ -[frontend docs]: https://home-assistant.io/components/frontend/ -[goalfeed docs]: https://home-assistant.io/components/goalfeed/ -[google_assistant docs]: https://home-assistant.io/components/google_assistant/ -[group docs]: https://home-assistant.io/components/group/ -[homematic docs]: https://home-assistant.io/components/homematic/ -[http docs]: https://home-assistant.io/components/http/ -[image_processing.openalpr_cloud docs]: https://home-assistant.io/components/image_processing.openalpr_cloud/ -[influxdb docs]: https://home-assistant.io/components/influxdb/ -[input_text docs]: https://home-assistant.io/components/input_text/ -[ios docs]: https://home-assistant.io/components/ios/ -[iota docs]: https://home-assistant.io/components/iota/ -[light.deconz docs]: https://home-assistant.io/components/light.deconz/ -[light.greenwave docs]: https://home-assistant.io/components/light.greenwave/ -[light.lifx docs]: https://home-assistant.io/components/light.lifx/ -[light.limitlessled docs]: https://home-assistant.io/components/light.limitlessled/ -[light.template docs]: https://home-assistant.io/components/light.template/ -[light.xiaomi_aqara docs]: https://home-assistant.io/components/light.xiaomi_aqara/ -[light.xiaomi_miio docs]: https://home-assistant.io/components/light.xiaomi_miio/ -[light.zha docs]: https://home-assistant.io/components/light.zha/ -[lock docs]: https://home-assistant.io/components/lock/ -[media_extractor docs]: https://home-assistant.io/components/media_extractor/ -[media_player docs]: https://home-assistant.io/components/media_player/ -[media_player.bluesound docs]: https://home-assistant.io/components/media_player.bluesound/ -[media_player.clementine docs]: https://home-assistant.io/components/media_player.clementine/ -[media_player.itunes docs]: https://home-assistant.io/components/media_player.itunes/ -[media_player.mediaroom docs]: https://home-assistant.io/components/media_player.mediaroom/ -[media_player.panasonic_viera docs]: https://home-assistant.io/components/media_player.panasonic_viera/ -[media_player.philips_js docs]: https://home-assistant.io/components/media_player.philips_js/ -[media_player.plex docs]: https://home-assistant.io/components/media_player.plex/ -[media_player.samsungtv docs]: https://home-assistant.io/components/media_player.samsungtv/ -[media_player.squeezebox docs]: https://home-assistant.io/components/media_player.squeezebox/ -[media_player.vlc docs]: https://home-assistant.io/components/media_player.vlc/ -[media_player.volumio docs]: https://home-assistant.io/components/media_player.volumio/ -[media_player.webostv docs]: https://home-assistant.io/components/media_player.webostv/ -[melissa docs]: https://home-assistant.io/components/melissa/ -[mercedesme docs]: https://home-assistant.io/components/mercedesme/ -[mochad docs]: https://home-assistant.io/components/mochad/ -[notify.gntp docs]: https://home-assistant.io/components/notify.gntp/ -[notify.kodi docs]: https://home-assistant.io/components/notify.kodi/ -[notify.pushsafer docs]: https://home-assistant.io/components/notify.pushsafer/ -[notify.twitter docs]: https://home-assistant.io/components/notify.twitter/ -[panel_iframe docs]: https://home-assistant.io/components/panel_iframe/ -[plant docs]: https://home-assistant.io/components/plant/ -[remote.xiaomi_miio docs]: https://home-assistant.io/components/remote.xiaomi_miio/ -[rfxtrx docs]: https://home-assistant.io/components/rfxtrx/ -[sensor.alpha_vantage docs]: https://home-assistant.io/components/sensor.alpha_vantage/ -[sensor.broadlink docs]: https://home-assistant.io/components/sensor.broadlink/ -[sensor.canary docs]: https://home-assistant.io/components/sensor.canary/ -[sensor.coinbase docs]: https://home-assistant.io/components/sensor.coinbase/ -[sensor.coinmarketcap docs]: https://home-assistant.io/components/sensor.coinmarketcap/ -[sensor.darksky docs]: https://home-assistant.io/components/sensor.darksky/ -[sensor.deconz docs]: https://home-assistant.io/components/sensor.deconz/ -[sensor.deutsche_bahn docs]: https://home-assistant.io/components/sensor.deutsche_bahn/ -[sensor.fritzbox_callmonitor docs]: https://home-assistant.io/components/sensor.fritzbox_callmonitor/ -[sensor.melissa docs]: https://home-assistant.io/components/sensor.melissa/ -[sensor.mercedesme docs]: https://home-assistant.io/components/sensor.mercedesme/ -[sensor.miflora docs]: https://home-assistant.io/components/sensor.miflora/ -[sensor.onewire docs]: https://home-assistant.io/components/sensor.onewire/ -[sensor.pollen docs]: https://home-assistant.io/components/sensor.pollen/ -[sensor.qnap docs]: https://home-assistant.io/components/sensor.qnap/ -[sensor.radarr docs]: https://home-assistant.io/components/sensor.radarr/ -[sensor.sonarr docs]: https://home-assistant.io/components/sensor.sonarr/ -[sensor.sql docs]: https://home-assistant.io/components/sensor.sql/ -[sensor.statistics docs]: https://home-assistant.io/components/sensor.statistics/ -[sensor.synologydsm docs]: https://home-assistant.io/components/sensor.synologydsm/ -[sensor.systemmonitor docs]: https://home-assistant.io/components/sensor.systemmonitor/ -[sensor.tahoma docs]: https://home-assistant.io/components/sensor.tahoma/ -[sensor.template docs]: https://home-assistant.io/components/sensor.template/ -[sensor.tesla docs]: https://home-assistant.io/components/sensor.tesla/ -[sensor.xiaomi_aqara docs]: https://home-assistant.io/components/sensor.xiaomi_aqara/ -[sensor.zha docs]: https://home-assistant.io/components/sensor.zha/ -[spc docs]: https://home-assistant.io/components/spc/ -[switch.broadlink docs]: https://home-assistant.io/components/switch.broadlink/ -[switch.flux docs]: https://home-assistant.io/components/switch.flux/ -[switch.pulseaudio_loopback docs]: https://home-assistant.io/components/switch.pulseaudio_loopback/ -[switch.template docs]: https://home-assistant.io/components/switch.template/ -[switch.tplink docs]: https://home-assistant.io/components/switch.tplink/ -[switch.wake_on_lan docs]: https://home-assistant.io/components/switch.wake_on_lan/ -[switch.xiaomi_miio docs]: https://home-assistant.io/components/switch.xiaomi_miio/ -[system_log docs]: https://home-assistant.io/components/system_log/ -[tado docs]: https://home-assistant.io/components/tado/ -[tahoma docs]: https://home-assistant.io/components/tahoma/ -[tesla docs]: https://home-assistant.io/components/tesla/ -[tts docs]: https://home-assistant.io/components/tts/ -[vacuum.xiaomi_miio docs]: https://home-assistant.io/components/vacuum.xiaomi_miio/ -[wake_on_lan docs]: https://home-assistant.io/components/wake_on_lan/ -[waterfurnace docs]: https://home-assistant.io/components/waterfurnace/ -[weather.openweathermap docs]: https://home-assistant.io/components/weather.openweathermap/ -[weblink docs]: https://home-assistant.io/components/weblink/ -[websocket_api docs]: https://home-assistant.io/components/websocket_api/ -[zha docs]: https://home-assistant.io/components/zha/ -[zha.const docs]: https://home-assistant.io/components/zha.const/ -[zwave docs]: https://home-assistant.io/components/zwave/ +[alexa docs]: /components/alexa/ +[binary_sensor.deconz docs]: /components/binary_sensor.deconz/ +[binary_sensor.mercedesme docs]: /components/binary_sensor.mercedesme/ +[binary_sensor.mqtt docs]: /components/binary_sensor.mqtt/ +[binary_sensor.template docs]: /components/binary_sensor.template/ +[binary_sensor.threshold docs]: /components/binary_sensor.threshold/ +[binary_sensor.zha docs]: /components/binary_sensor.zha/ +[camera.canary docs]: /components/camera.canary/ +[camera.uvc docs]: /components/camera.uvc/ +[camera.xeoma docs]: /components/camera.xeoma/ +[canary docs]: /components/canary/ +[climate.demo docs]: /components/climate.demo/ +[climate.ecobee docs]: /components/climate.ecobee/ +[climate.econet docs]: /components/climate.econet/ +[climate.generic_thermostat docs]: /components/climate.generic_thermostat/ +[climate.heatmiser docs]: /components/climate.heatmiser/ +[climate.melissa docs]: /components/climate.melissa/ +[climate.nest docs]: /components/climate.nest/ +[climate.tado docs]: /components/climate.tado/ +[climate.touchline docs]: /components/climate.touchline/ +[climate.venstar docs]: /components/climate.venstar/ +[cloud docs]: /components/cloud/ +[coinbase docs]: /components/coinbase/ +[cover.mqtt docs]: /components/cover.mqtt/ +[cover.tahoma docs]: /components/cover.tahoma/ +[cover.template docs]: /components/cover.template/ +[deconz docs]: /components/deconz/ +[device_tracker.huawei_router docs]: /components/device_tracker.huawei_router/ +[device_tracker.mercedesme docs]: /components/device_tracker.mercedesme/ +[device_tracker.mikrotik docs]: /components/device_tracker.mikrotik/ +[device_tracker.mqtt docs]: /components/device_tracker.mqtt/ +[device_tracker.owntracks docs]: /components/device_tracker.owntracks/ +[device_tracker.ubus docs]: /components/device_tracker.ubus/ +[doorbird docs]: /components/doorbird/ +[emulated_hue docs]: /components/emulated_hue/ +[fan.xiaomi_miio docs]: /components/fan.xiaomi_miio/ +[feedreader docs]: /components/feedreader/ +[frontend docs]: /components/frontend/ +[goalfeed docs]: /components/goalfeed/ +[google_assistant docs]: /components/google_assistant/ +[group docs]: /components/group/ +[homematic docs]: /components/homematic/ +[http docs]: /components/http/ +[image_processing.openalpr_cloud docs]: /components/image_processing.openalpr_cloud/ +[influxdb docs]: /components/influxdb/ +[input_text docs]: /components/input_text/ +[ios docs]: /components/ios/ +[iota docs]: /components/iota/ +[light.deconz docs]: /components/light.deconz/ +[light.greenwave docs]: /components/light.greenwave/ +[light.lifx docs]: /components/light.lifx/ +[light.limitlessled docs]: /components/light.limitlessled/ +[light.template docs]: /components/light.template/ +[light.xiaomi_aqara docs]: /components/light.xiaomi_aqara/ +[light.xiaomi_miio docs]: /components/light.xiaomi_miio/ +[light.zha docs]: /components/light.zha/ +[lock docs]: /components/lock/ +[media_extractor docs]: /components/media_extractor/ +[media_player docs]: /components/media_player/ +[media_player.bluesound docs]: /components/media_player.bluesound/ +[media_player.clementine docs]: /components/media_player.clementine/ +[media_player.itunes docs]: /components/media_player.itunes/ +[media_player.mediaroom docs]: /components/media_player.mediaroom/ +[media_player.panasonic_viera docs]: /components/media_player.panasonic_viera/ +[media_player.philips_js docs]: /components/media_player.philips_js/ +[media_player.plex docs]: /components/media_player.plex/ +[media_player.samsungtv docs]: /components/media_player.samsungtv/ +[media_player.squeezebox docs]: /components/media_player.squeezebox/ +[media_player.vlc docs]: /components/media_player.vlc/ +[media_player.volumio docs]: /components/media_player.volumio/ +[media_player.webostv docs]: /components/media_player.webostv/ +[melissa docs]: /components/melissa/ +[mercedesme docs]: /components/mercedesme/ +[mochad docs]: /components/mochad/ +[notify.gntp docs]: /components/notify.gntp/ +[notify.kodi docs]: /components/notify.kodi/ +[notify.pushsafer docs]: /components/notify.pushsafer/ +[notify.twitter docs]: /components/notify.twitter/ +[panel_iframe docs]: /components/panel_iframe/ +[plant docs]: /components/plant/ +[remote.xiaomi_miio docs]: /components/remote.xiaomi_miio/ +[rfxtrx docs]: /components/rfxtrx/ +[sensor.alpha_vantage docs]: /components/sensor.alpha_vantage/ +[sensor.broadlink docs]: /components/sensor.broadlink/ +[sensor.canary docs]: /components/sensor.canary/ +[sensor.coinbase docs]: /components/sensor.coinbase/ +[sensor.coinmarketcap docs]: /components/sensor.coinmarketcap/ +[sensor.darksky docs]: /components/sensor.darksky/ +[sensor.deconz docs]: /components/sensor.deconz/ +[sensor.deutsche_bahn docs]: /components/sensor.deutsche_bahn/ +[sensor.fritzbox_callmonitor docs]: /components/sensor.fritzbox_callmonitor/ +[sensor.melissa docs]: /components/sensor.melissa/ +[sensor.mercedesme docs]: /components/sensor.mercedesme/ +[sensor.miflora docs]: /components/sensor.miflora/ +[sensor.onewire docs]: /components/sensor.onewire/ +[sensor.pollen docs]: /components/sensor.pollen/ +[sensor.qnap docs]: /components/sensor.qnap/ +[sensor.radarr docs]: /components/sensor.radarr/ +[sensor.sonarr docs]: /components/sensor.sonarr/ +[sensor.sql docs]: /components/sensor.sql/ +[sensor.statistics docs]: /components/sensor.statistics/ +[sensor.synologydsm docs]: /components/sensor.synologydsm/ +[sensor.systemmonitor docs]: /components/sensor.systemmonitor/ +[sensor.tahoma docs]: /components/sensor.tahoma/ +[sensor.template docs]: /components/sensor.template/ +[sensor.tesla docs]: /components/sensor.tesla/ +[sensor.xiaomi_aqara docs]: /components/sensor.xiaomi_aqara/ +[sensor.zha docs]: /components/sensor.zha/ +[spc docs]: /components/spc/ +[switch.broadlink docs]: /components/switch.broadlink/ +[switch.flux docs]: /components/switch.flux/ +[switch.pulseaudio_loopback docs]: /components/switch.pulseaudio_loopback/ +[switch.template docs]: /components/switch.template/ +[switch.tplink docs]: /components/switch.tplink/ +[switch.wake_on_lan docs]: /components/switch.wake_on_lan/ +[switch.xiaomi_miio docs]: /components/switch.xiaomi_miio/ +[system_log docs]: /components/system_log/ +[tado docs]: /components/tado/ +[tahoma docs]: /components/tahoma/ +[tesla docs]: /components/tesla/ +[tts docs]: /components/tts/ +[vacuum.xiaomi_miio docs]: /components/vacuum.xiaomi_miio/ +[wake_on_lan docs]: /components/wake_on_lan/ +[waterfurnace docs]: /components/waterfurnace/ +[weather.openweathermap docs]: /components/weather.openweathermap/ +[weblink docs]: /components/weblink/ +[websocket_api docs]: /components/websocket_api/ +[zha docs]: /components/zha/ +[zha.const docs]: /components/zha.const/ +[zwave docs]: /components/zwave/ [#12292]: https://github.com/home-assistant/home-assistant/pull/12292 [#12313]: https://github.com/home-assistant/home-assistant/pull/12313 [#12314]: https://github.com/home-assistant/home-assistant/pull/12314 @@ -642,10 +642,10 @@ Experiencing issues introduced by this release? Please report them in our [issue [#12330]: https://github.com/home-assistant/home-assistant/pull/12330 [@balloob]: https://github.com/balloob [@lucasweb78]: https://github.com/lucasweb78 -[alexa docs]: https://home-assistant.io/components/alexa/ -[binary_sensor.netatmo docs]: https://home-assistant.io/components/binary_sensor.netatmo/ -[camera.netatmo docs]: https://home-assistant.io/components/camera.netatmo/ -[sensor.netatmo docs]: https://home-assistant.io/components/sensor.netatmo/ +[alexa docs]: /components/alexa/ +[binary_sensor.netatmo docs]: /components/binary_sensor.netatmo/ +[camera.netatmo docs]: /components/camera.netatmo/ +[sensor.netatmo docs]: /components/sensor.netatmo/ [#12342]: https://github.com/home-assistant/home-assistant/pull/12342 [#12346]: https://github.com/home-assistant/home-assistant/pull/12346 [#12368]: https://github.com/home-assistant/home-assistant/pull/12368 @@ -656,14 +656,14 @@ Experiencing issues introduced by this release? Please report them in our [issue [@amelchio]: https://github.com/amelchio [@citruz]: https://github.com/citruz [@sdague]: https://github.com/sdague -[binary_sensor.mercedesme docs]: https://home-assistant.io/components/binary_sensor.mercedesme/ -[device_tracker.mercedesme docs]: https://home-assistant.io/components/device_tracker.mercedesme/ -[light.limitlessled docs]: https://home-assistant.io/components/light.limitlessled/ -[media_player.yamaha docs]: https://home-assistant.io/components/media_player.yamaha/ -[mercedesme docs]: https://home-assistant.io/components/mercedesme/ -[sensor.eddystone_temperature docs]: https://home-assistant.io/components/sensor.eddystone_temperature/ -[sensor.mercedesme docs]: https://home-assistant.io/components/sensor.mercedesme/ -[sensor.wunderground docs]: https://home-assistant.io/components/sensor.wunderground/ +[binary_sensor.mercedesme docs]: /components/binary_sensor.mercedesme/ +[device_tracker.mercedesme docs]: /components/device_tracker.mercedesme/ +[light.limitlessled docs]: /components/light.limitlessled/ +[media_player.yamaha docs]: /components/media_player.yamaha/ +[mercedesme docs]: /components/mercedesme/ +[sensor.eddystone_temperature docs]: /components/sensor.eddystone_temperature/ +[sensor.mercedesme docs]: /components/sensor.mercedesme/ +[sensor.wunderground docs]: /components/sensor.wunderground/ [#12392]: https://github.com/home-assistant/home-assistant/pull/12392 [#12421]: https://github.com/home-assistant/home-assistant/pull/12421 [#12435]: https://github.com/home-assistant/home-assistant/pull/12435 @@ -678,13 +678,13 @@ Experiencing issues introduced by this release? Please report them in our [issue [@dgomes]: https://github.com/dgomes [@ryanm101]: https://github.com/ryanm101 [@syssi]: https://github.com/syssi -[fan.xiaomi_miio docs]: https://home-assistant.io/components/fan.xiaomi_miio/ -[isy994 docs]: https://home-assistant.io/components/isy994/ -[light.template docs]: https://home-assistant.io/components/light.template/ -[light.xiaomi_miio docs]: https://home-assistant.io/components/light.xiaomi_miio/ -[media_player.plex docs]: https://home-assistant.io/components/media_player.plex/ -[remote.xiaomi_miio docs]: https://home-assistant.io/components/remote.xiaomi_miio/ -[sensor.sql docs]: https://home-assistant.io/components/sensor.sql/ -[sensor.yr docs]: https://home-assistant.io/components/sensor.yr/ -[switch.xiaomi_miio docs]: https://home-assistant.io/components/switch.xiaomi_miio/ -[vacuum.xiaomi_miio docs]: https://home-assistant.io/components/vacuum.xiaomi_miio/ +[fan.xiaomi_miio docs]: /components/fan.xiaomi_miio/ +[isy994 docs]: /components/isy994/ +[light.template docs]: /components/light.template/ +[light.xiaomi_miio docs]: /components/light.xiaomi_miio/ +[media_player.plex docs]: /components/media_player.plex/ +[remote.xiaomi_miio docs]: /components/remote.xiaomi_miio/ +[sensor.sql docs]: /components/sensor.sql/ +[sensor.yr docs]: /components/sensor.yr/ +[switch.xiaomi_miio docs]: /components/switch.xiaomi_miio/ +[vacuum.xiaomi_miio docs]: /components/vacuum.xiaomi_miio/ diff --git a/source/_posts/2018-02-26-release-64.markdown b/source/_posts/2018-02-26-release-64.markdown index c745d771fd..bdfd104d72 100644 --- a/source/_posts/2018-02-26-release-64.markdown +++ b/source/_posts/2018-02-26-release-64.markdown @@ -15,11 +15,11 @@ og_image: /images/blog/2018-02-0.64/components.png 🎉 1000 integrations, 1000 integrations, 1000 integrations! 🎉 -That's right, Home Assistant 0.64 is here! In case you have missed our latest [Cloud update](https://home-assistant.io/blog/2018/02/19/cloud-update/), the Home Assistant Alexa skill is now live in all regions and we're working with Google in getting the Smart Home skill for Google Assistant approved. Exciting times! +That's right, Home Assistant 0.64 is here! In case you have missed our latest [Cloud update](/blog/2018/02/19/cloud-update/), the Home Assistant Alexa skill is now live in all regions and we're working with Google in getting the Smart Home skill for Google Assistant approved. Exciting times! In the meanwhile, some great new integrations have landed, including yet another car 🚗 This time it's BMW. -This is going to be the last release that supports Python 3.4. Starting with the next release, the minimum version required will be Python 3.5.3. [Learn more here.](https://home-assistant.io/blog/2017/10/06/deprecating-python-3.4-support/) +This is going to be the last release that supports Python 3.4. Starting with the next release, the minimum version required will be Python 3.5.3. [Learn more here.](/blog/2017/10/06/deprecating-python-3.4-support/) ## {% linkable_title HomeKit %} @@ -482,111 +482,111 @@ Experiencing issues introduced by this release? Please report them in our [issue [@frenck]: https://github.com/frenck [@pvizeli]: https://github.com/pvizeli [@ryanm101]: https://github.com/ryanm101 -[alexa docs]: https://home-assistant.io/components/alexa/ -[august docs]: https://home-assistant.io/components/august/ -[binary_sensor.august docs]: https://home-assistant.io/components/binary_sensor.august/ -[binary_sensor.bloomsky docs]: https://home-assistant.io/components/binary_sensor.bloomsky/ -[binary_sensor.deconz docs]: https://home-assistant.io/components/binary_sensor.deconz/ -[binary_sensor.knx docs]: https://home-assistant.io/components/binary_sensor.knx/ -[bmw_connected_drive docs]: https://home-assistant.io/components/bmw_connected_drive/ -[calendar.caldav docs]: https://home-assistant.io/components/calendar.caldav/ -[camera.august docs]: https://home-assistant.io/components/camera.august/ -[camera.bloomsky docs]: https://home-assistant.io/components/camera.bloomsky/ -[camera.doorbird docs]: https://home-assistant.io/components/camera.doorbird/ -[camera.onvif docs]: https://home-assistant.io/components/camera.onvif/ -[camera.rpi_camera docs]: https://home-assistant.io/components/camera.rpi_camera/ -[climate.eq3btsmart docs]: https://home-assistant.io/components/climate.eq3btsmart/ -[climate.knx docs]: https://home-assistant.io/components/climate.knx/ -[climate.melissa docs]: https://home-assistant.io/components/climate.melissa/ -[cloud docs]: https://home-assistant.io/components/cloud/ -[config docs]: https://home-assistant.io/components/config/ -[conversation docs]: https://home-assistant.io/components/conversation/ -[cover.knx docs]: https://home-assistant.io/components/cover.knx/ -[cover.opengarage docs]: https://home-assistant.io/components/cover.opengarage/ -[deconz docs]: https://home-assistant.io/components/deconz/ -[device_tracker.asuswrt docs]: https://home-assistant.io/components/device_tracker.asuswrt/ -[device_tracker.automatic docs]: https://home-assistant.io/components/device_tracker.automatic/ -[device_tracker.bmw_connected_drive docs]: https://home-assistant.io/components/device_tracker.bmw_connected_drive/ -[device_tracker.nmap_tracker docs]: https://home-assistant.io/components/device_tracker.nmap_tracker/ -[device_tracker.unifi docs]: https://home-assistant.io/components/device_tracker.unifi/ -[fan.xiaomi_miio docs]: https://home-assistant.io/components/fan.xiaomi_miio/ -[frontend docs]: https://home-assistant.io/components/frontend/ -[google_assistant docs]: https://home-assistant.io/components/google_assistant/ -[hassio docs]: https://home-assistant.io/components/hassio/ -[history docs]: https://home-assistant.io/components/history/ -[homekit docs]: https://home-assistant.io/components/homekit/ -[homekit.accessories docs]: https://home-assistant.io/components/homekit.accessories/ -[homekit.const docs]: https://home-assistant.io/components/homekit.const/ -[homekit.covers docs]: https://home-assistant.io/components/homekit.covers/ -[homekit.sensors docs]: https://home-assistant.io/components/homekit.sensors/ -[http docs]: https://home-assistant.io/components/http/ -[input_datetime docs]: https://home-assistant.io/components/input_datetime/ -[isy994 docs]: https://home-assistant.io/components/isy994/ -[knx docs]: https://home-assistant.io/components/knx/ -[light.deconz docs]: https://home-assistant.io/components/light.deconz/ -[light.iglo docs]: https://home-assistant.io/components/light.iglo/ -[light.knx docs]: https://home-assistant.io/components/light.knx/ -[light.limitlessled docs]: https://home-assistant.io/components/light.limitlessled/ -[light.xiaomi_miio docs]: https://home-assistant.io/components/light.xiaomi_miio/ -[lock.august docs]: https://home-assistant.io/components/lock.august/ -[lock.zwave docs]: https://home-assistant.io/components/lock.zwave/ -[logbook docs]: https://home-assistant.io/components/logbook/ -[media_extractor docs]: https://home-assistant.io/components/media_extractor/ -[media_player.bluesound docs]: https://home-assistant.io/components/media_player.bluesound/ -[media_player.braviatv_psk docs]: https://home-assistant.io/components/media_player.braviatv_psk/ -[media_player.cast docs]: https://home-assistant.io/components/media_player.cast/ -[media_player.denonavr docs]: https://home-assistant.io/components/media_player.denonavr/ -[media_player.frontier_silicon docs]: https://home-assistant.io/components/media_player.frontier_silicon/ -[media_player.panasonic_viera docs]: https://home-assistant.io/components/media_player.panasonic_viera/ -[media_player.sonos docs]: https://home-assistant.io/components/media_player.sonos/ -[media_player.xiaomi_tv docs]: https://home-assistant.io/components/media_player.xiaomi_tv/ -[melissa docs]: https://home-assistant.io/components/melissa/ -[mqtt docs]: https://home-assistant.io/components/mqtt/ -[mqtt_eventstream docs]: https://home-assistant.io/components/mqtt_eventstream/ -[notify.html5 docs]: https://home-assistant.io/components/notify.html5/ -[notify.knx docs]: https://home-assistant.io/components/notify.knx/ -[notify.lametric docs]: https://home-assistant.io/components/notify.lametric/ -[panel_iframe docs]: https://home-assistant.io/components/panel_iframe/ -[remote.xiaomi_miio docs]: https://home-assistant.io/components/remote.xiaomi_miio/ -[scene docs]: https://home-assistant.io/components/scene/ -[sensor.airvisual docs]: https://home-assistant.io/components/sensor.airvisual/ -[sensor.alpha_vantage docs]: https://home-assistant.io/components/sensor.alpha_vantage/ -[sensor.bloomsky docs]: https://home-assistant.io/components/sensor.bloomsky/ -[sensor.bmw_connected_drive docs]: https://home-assistant.io/components/sensor.bmw_connected_drive/ -[sensor.buienradar docs]: https://home-assistant.io/components/sensor.buienradar/ -[sensor.deconz docs]: https://home-assistant.io/components/sensor.deconz/ -[sensor.fastdotcom docs]: https://home-assistant.io/components/sensor.fastdotcom/ -[sensor.fedex docs]: https://home-assistant.io/components/sensor.fedex/ -[sensor.filesize docs]: https://home-assistant.io/components/sensor.filesize/ -[sensor.folder docs]: https://home-assistant.io/components/sensor.folder/ -[sensor.knx docs]: https://home-assistant.io/components/sensor.knx/ -[sensor.pollen docs]: https://home-assistant.io/components/sensor.pollen/ -[sensor.rfxtrx docs]: https://home-assistant.io/components/sensor.rfxtrx/ -[sensor.sabnzbd docs]: https://home-assistant.io/components/sensor.sabnzbd/ -[sensor.sma docs]: https://home-assistant.io/components/sensor.sma/ -[sensor.smappee docs]: https://home-assistant.io/components/sensor.smappee/ -[sensor.speedtest docs]: https://home-assistant.io/components/sensor.speedtest/ -[sensor.spotcrime docs]: https://home-assistant.io/components/sensor.spotcrime/ -[sensor.startca docs]: https://home-assistant.io/components/sensor.startca/ -[sensor.template docs]: https://home-assistant.io/components/sensor.template/ -[sensor.tibber docs]: https://home-assistant.io/components/sensor.tibber/ -[sensor.wunderground docs]: https://home-assistant.io/components/sensor.wunderground/ -[sensor.zha docs]: https://home-assistant.io/components/sensor.zha/ -[shopping_list docs]: https://home-assistant.io/components/shopping_list/ -[smappee docs]: https://home-assistant.io/components/smappee/ -[switch.knx docs]: https://home-assistant.io/components/switch.knx/ -[switch.rainmachine docs]: https://home-assistant.io/components/switch.rainmachine/ -[switch.smappee docs]: https://home-assistant.io/components/switch.smappee/ -[switch.xiaomi_miio docs]: https://home-assistant.io/components/switch.xiaomi_miio/ -[tahoma docs]: https://home-assistant.io/components/tahoma/ -[telegram_bot docs]: https://home-assistant.io/components/telegram_bot/ -[usps docs]: https://home-assistant.io/components/usps/ -[vacuum.xiaomi_miio docs]: https://home-assistant.io/components/vacuum.xiaomi_miio/ -[vera docs]: https://home-assistant.io/components/vera/ -[weather.buienradar docs]: https://home-assistant.io/components/weather.buienradar/ -[weblink docs]: https://home-assistant.io/components/weblink/ -[xiaomi_aqara docs]: https://home-assistant.io/components/xiaomi_aqara/ -[zha docs]: https://home-assistant.io/components/zha/ +[alexa docs]: /components/alexa/ +[august docs]: /components/august/ +[binary_sensor.august docs]: /components/binary_sensor.august/ +[binary_sensor.bloomsky docs]: /components/binary_sensor.bloomsky/ +[binary_sensor.deconz docs]: /components/binary_sensor.deconz/ +[binary_sensor.knx docs]: /components/binary_sensor.knx/ +[bmw_connected_drive docs]: /components/bmw_connected_drive/ +[calendar.caldav docs]: /components/calendar.caldav/ +[camera.august docs]: /components/camera.august/ +[camera.bloomsky docs]: /components/camera.bloomsky/ +[camera.doorbird docs]: /components/camera.doorbird/ +[camera.onvif docs]: /components/camera.onvif/ +[camera.rpi_camera docs]: /components/camera.rpi_camera/ +[climate.eq3btsmart docs]: /components/climate.eq3btsmart/ +[climate.knx docs]: /components/climate.knx/ +[climate.melissa docs]: /components/climate.melissa/ +[cloud docs]: /components/cloud/ +[config docs]: /components/config/ +[conversation docs]: /components/conversation/ +[cover.knx docs]: /components/cover.knx/ +[cover.opengarage docs]: /components/cover.opengarage/ +[deconz docs]: /components/deconz/ +[device_tracker.asuswrt docs]: /components/device_tracker.asuswrt/ +[device_tracker.automatic docs]: /components/device_tracker.automatic/ +[device_tracker.bmw_connected_drive docs]: /components/device_tracker.bmw_connected_drive/ +[device_tracker.nmap_tracker docs]: /components/device_tracker.nmap_tracker/ +[device_tracker.unifi docs]: /components/device_tracker.unifi/ +[fan.xiaomi_miio docs]: /components/fan.xiaomi_miio/ +[frontend docs]: /components/frontend/ +[google_assistant docs]: /components/google_assistant/ +[hassio docs]: /components/hassio/ +[history docs]: /components/history/ +[homekit docs]: /components/homekit/ +[homekit.accessories docs]: /components/homekit.accessories/ +[homekit.const docs]: /components/homekit.const/ +[homekit.covers docs]: /components/homekit.covers/ +[homekit.sensors docs]: /components/homekit.sensors/ +[http docs]: /components/http/ +[input_datetime docs]: /components/input_datetime/ +[isy994 docs]: /components/isy994/ +[knx docs]: /components/knx/ +[light.deconz docs]: /components/light.deconz/ +[light.iglo docs]: /components/light.iglo/ +[light.knx docs]: /components/light.knx/ +[light.limitlessled docs]: /components/light.limitlessled/ +[light.xiaomi_miio docs]: /components/light.xiaomi_miio/ +[lock.august docs]: /components/lock.august/ +[lock.zwave docs]: /components/lock.zwave/ +[logbook docs]: /components/logbook/ +[media_extractor docs]: /components/media_extractor/ +[media_player.bluesound docs]: /components/media_player.bluesound/ +[media_player.braviatv_psk docs]: /components/media_player.braviatv_psk/ +[media_player.cast docs]: /components/media_player.cast/ +[media_player.denonavr docs]: /components/media_player.denonavr/ +[media_player.frontier_silicon docs]: /components/media_player.frontier_silicon/ +[media_player.panasonic_viera docs]: /components/media_player.panasonic_viera/ +[media_player.sonos docs]: /components/media_player.sonos/ +[media_player.xiaomi_tv docs]: /components/media_player.xiaomi_tv/ +[melissa docs]: /components/melissa/ +[mqtt docs]: /components/mqtt/ +[mqtt_eventstream docs]: /components/mqtt_eventstream/ +[notify.html5 docs]: /components/notify.html5/ +[notify.knx docs]: /components/notify.knx/ +[notify.lametric docs]: /components/notify.lametric/ +[panel_iframe docs]: /components/panel_iframe/ +[remote.xiaomi_miio docs]: /components/remote.xiaomi_miio/ +[scene docs]: /components/scene/ +[sensor.airvisual docs]: /components/sensor.airvisual/ +[sensor.alpha_vantage docs]: /components/sensor.alpha_vantage/ +[sensor.bloomsky docs]: /components/sensor.bloomsky/ +[sensor.bmw_connected_drive docs]: /components/sensor.bmw_connected_drive/ +[sensor.buienradar docs]: /components/sensor.buienradar/ +[sensor.deconz docs]: /components/sensor.deconz/ +[sensor.fastdotcom docs]: /components/sensor.fastdotcom/ +[sensor.fedex docs]: /components/sensor.fedex/ +[sensor.filesize docs]: /components/sensor.filesize/ +[sensor.folder docs]: /components/sensor.folder/ +[sensor.knx docs]: /components/sensor.knx/ +[sensor.pollen docs]: /components/sensor.pollen/ +[sensor.rfxtrx docs]: /components/sensor.rfxtrx/ +[sensor.sabnzbd docs]: /components/sensor.sabnzbd/ +[sensor.sma docs]: /components/sensor.sma/ +[sensor.smappee docs]: /components/sensor.smappee/ +[sensor.speedtest docs]: /components/sensor.speedtest/ +[sensor.spotcrime docs]: /components/sensor.spotcrime/ +[sensor.startca docs]: /components/sensor.startca/ +[sensor.template docs]: /components/sensor.template/ +[sensor.tibber docs]: /components/sensor.tibber/ +[sensor.wunderground docs]: /components/sensor.wunderground/ +[sensor.zha docs]: /components/sensor.zha/ +[shopping_list docs]: /components/shopping_list/ +[smappee docs]: /components/smappee/ +[switch.knx docs]: /components/switch.knx/ +[switch.rainmachine docs]: /components/switch.rainmachine/ +[switch.smappee docs]: /components/switch.smappee/ +[switch.xiaomi_miio docs]: /components/switch.xiaomi_miio/ +[tahoma docs]: /components/tahoma/ +[telegram_bot docs]: /components/telegram_bot/ +[usps docs]: /components/usps/ +[vacuum.xiaomi_miio docs]: /components/vacuum.xiaomi_miio/ +[vera docs]: /components/vera/ +[weather.buienradar docs]: /components/weather.buienradar/ +[weblink docs]: /components/weblink/ +[xiaomi_aqara docs]: /components/xiaomi_aqara/ +[zha docs]: /components/zha/ [#12635]: https://github.com/home-assistant/home-assistant/pull/12635 [#12645]: https://github.com/home-assistant/home-assistant/pull/12645 [#12657]: https://github.com/home-assistant/home-assistant/pull/12657 @@ -614,17 +614,17 @@ Experiencing issues introduced by this release? Please report them in our [issue [@tumik]: https://github.com/tumik [@fanthos]: https://github.com/fanthos [@PhilRW]: https://github.com/PhilRW -[binary_sensor.deconz docs]: https://home-assistant.io/components/binary_sensor.deconz/ -[deconz docs]: https://home-assistant.io/components/deconz/ -[light.iglo docs]: https://home-assistant.io/components/light.iglo/ -[media_player.cast docs]: https://home-assistant.io/components/media_player.cast/ -[media_player.denonavr docs]: https://home-assistant.io/components/media_player.denonavr/ -[mysensors docs]: https://home-assistant.io/components/mysensors/ -[remote.harmony docs]: https://home-assistant.io/components/remote.harmony/ -[sensor.alpha_vantage docs]: https://home-assistant.io/components/sensor.alpha_vantage/ -[tahoma docs]: https://home-assistant.io/components/tahoma/ -[vacuum.roomba docs]: https://home-assistant.io/components/vacuum.roomba/ -[zha docs]: https://home-assistant.io/components/zha/ +[binary_sensor.deconz docs]: /components/binary_sensor.deconz/ +[deconz docs]: /components/deconz/ +[light.iglo docs]: /components/light.iglo/ +[media_player.cast docs]: /components/media_player.cast/ +[media_player.denonavr docs]: /components/media_player.denonavr/ +[mysensors docs]: /components/mysensors/ +[remote.harmony docs]: /components/remote.harmony/ +[sensor.alpha_vantage docs]: /components/sensor.alpha_vantage/ +[tahoma docs]: /components/tahoma/ +[vacuum.roomba docs]: /components/vacuum.roomba/ +[zha docs]: /components/zha/ [#12759]: https://github.com/home-assistant/home-assistant/pull/12759 [#12762]: https://github.com/home-assistant/home-assistant/pull/12762 [#12764]: https://github.com/home-assistant/home-assistant/pull/12764 @@ -641,14 +641,14 @@ Experiencing issues introduced by this release? Please report them in our [issue [@happyleavesaoc]: https://github.com/happyleavesaoc [@ryanm101]: https://github.com/ryanm101 [@uchagani]: https://github.com/uchagani -[binary_sensor.rfxtrx docs]: https://home-assistant.io/components/binary_sensor.rfxtrx/ -[bmw_connected_drive docs]: https://home-assistant.io/components/bmw_connected_drive/ -[logbook docs]: https://home-assistant.io/components/logbook/ -[media_player.plex docs]: https://home-assistant.io/components/media_player.plex/ -[media_player.samsungtv docs]: https://home-assistant.io/components/media_player.samsungtv/ -[media_player.sonos docs]: https://home-assistant.io/components/media_player.sonos/ -[sensor.fedex docs]: https://home-assistant.io/components/sensor.fedex/ -[sensor.pollen docs]: https://home-assistant.io/components/sensor.pollen/ +[binary_sensor.rfxtrx docs]: /components/binary_sensor.rfxtrx/ +[bmw_connected_drive docs]: /components/bmw_connected_drive/ +[logbook docs]: /components/logbook/ +[media_player.plex docs]: /components/media_player.plex/ +[media_player.samsungtv docs]: /components/media_player.samsungtv/ +[media_player.sonos docs]: /components/media_player.sonos/ +[sensor.fedex docs]: /components/sensor.fedex/ +[sensor.pollen docs]: /components/sensor.pollen/ [#12810]: https://github.com/home-assistant/home-assistant/pull/12810 [#12837]: https://github.com/home-assistant/home-assistant/pull/12837 [#12840]: https://github.com/home-assistant/home-assistant/pull/12840 @@ -656,6 +656,6 @@ Experiencing issues introduced by this release? Please report them in our [issue [@andrey-git]: https://github.com/andrey-git [@balloob]: https://github.com/balloob [@kellerza]: https://github.com/kellerza -[climate.sensibo docs]: https://home-assistant.io/components/climate.sensibo/ -[cloud docs]: https://home-assistant.io/components/cloud/ -[hue docs]: https://home-assistant.io/components/hue/ \ No newline at end of file +[climate.sensibo docs]: /components/climate.sensibo/ +[cloud docs]: /components/cloud/ +[hue docs]: /components/hue/ \ No newline at end of file diff --git a/source/_posts/2018-03-09-release-65.markdown b/source/_posts/2018-03-09-release-65.markdown index 213ecb8b92..ebf590affd 100644 --- a/source/_posts/2018-03-09-release-65.markdown +++ b/source/_posts/2018-03-09-release-65.markdown @@ -13,7 +13,7 @@ og_image: /images/blog/2018-03-0.65/entity-registry-name.gif -Release 0.65 has arrived and oh boy, is it awesome. First off, in case you have missed the previous release notes and [announcements](https://home-assistant.io/blog/2017/10/06/deprecating-python-3.4-support/): **Starting with this release, Home Assistant has dropped support for Python 3.4. The minimum supported version is now Python 3.5.3.** If you are on Hass.io or Docker, you'll automatically be running the latest and greatest. If you're on an older Hassbian installation or did your own Linux setup you'll need to upgrade to at least Python 3.5.3. +Release 0.65 has arrived and oh boy, is it awesome. First off, in case you have missed the previous release notes and [announcements](/blog/2017/10/06/deprecating-python-3.4-support/): **Starting with this release, Home Assistant has dropped support for Python 3.4. The minimum supported version is now Python 3.5.3.** If you are on Hass.io or Docker, you'll automatically be running the latest and greatest. If you're on an older Hassbian installation or did your own Linux setup you'll need to upgrade to at least Python 3.5.3. ## {% linkable_title Naming entities %} @@ -161,6 +161,14 @@ intent_script: - Avoid Sonos error when joining with self ([@amelchio] - [#13196]) ([media_player.sonos docs]) - Fix input_boolean Google Assistant serialize error ([@balloob] - [#13220]) ([google_assistant docs]) +## {% linkable_title Release 0.65.6 - March 21 %} + +- More robust MJPEG parser. Fixes #13138. ([@PhracturedBlue] - [#13226]) ([camera.proxy docs]) +- Tado: don't reference unset hass var ([@balloob] - [#13237]) ([device_tracker docs]) +- Fix Sonos join/unjoin in scripts ([@amelchio] - [#13248]) ([media_player.sonos docs]) +- Fix Sonos radio stations with ampersand ([@amelchio] - [#13293]) ([media_player.sonos docs]) +- Do not include unavailable entities in Google Assistant SYNC ([@balloob] - [#13358]) ([google_assistant docs]) ([light.demo docs]) + ## {% linkable_title If you need help... %} ...don't hesitate to use our very active [forums](https://community.home-assistant.io/) or join us for a little [chat](https://discord.gg/c5DvZ4e). The release notes have comments enabled but it's preferred if you use the former communication channels. Thanks. @@ -172,7 +180,7 @@ Experiencing issues introduced by this release? Please report them in our [issue ## {% linkable_title Breaking Changes %} -- Insteon PLM: If you have created platform overrides in your configuration.yaml file to change a your INSTEON device to map to a different Home Assistant platform, that mapping will no longer be in effect. Please see the new device override capabilities in the [insteon_plm documentation](https://home-assistant.io/components/insteon_plm/). ([@teharris1] - [#12534]) ([insteon_plm docs]) ([binary_sensor.insteon_plm docs]) ([fan.insteon_plm docs]) ([light.insteon_plm docs]) ([sensor.insteon_plm docs]) ([switch.insteon_plm docs]) (breaking change) +- Insteon PLM: If you have created platform overrides in your configuration.yaml file to change a your INSTEON device to map to a different Home Assistant platform, that mapping will no longer be in effect. Please see the new device override capabilities in the [insteon_plm documentation](/components/insteon_plm/). ([@teharris1] - [#12534]) ([insteon_plm docs]) ([binary_sensor.insteon_plm docs]) ([fan.insteon_plm docs]) ([light.insteon_plm docs]) ([sensor.insteon_plm docs]) ([switch.insteon_plm docs]) (breaking change) - AirVisual's air index unit is AQI (Air Quality Index), not PSI (Pressure per Square Inch). ([@chilicheech] - [#12730]) ([sensor.airvisual docs]) (breaking change) - TekSavvy Sensor: The sensor entity id for peak upload usage used to be `sensor.teksavvy_on_peak_upload_` this has been changed to `sensor.teksavvy_on_peak_upload`. The `usage` title was shared between and therefore indeterminate between GB and % usage. Therefore % usage entity ID has been changed to `sensor.teksavvy_usage_ratio` ([@mikeodr] - [#12325]) ([sensor.teksavvy docs]) (breaking change) - Egardia redesign - generic component and sensor support ([@jeroenterheerdt] - [#11994]) ([egardia docs]) ([alarm_control_panel.egardia docs]) ([binary_sensor.egardia docs]) (breaking change) (new-platform) @@ -534,121 +542,121 @@ Experiencing issues introduced by this release? Please report them in our [issue [@teharris1]: https://github.com/teharris1 [@thejta]: https://github.com/thejta [@turbokongen]: https://github.com/turbokongen -[alarm_control_panel.alarmdotcom docs]: https://home-assistant.io/components/alarm_control_panel.alarmdotcom/ -[alarm_control_panel.concord232 docs]: https://home-assistant.io/components/alarm_control_panel.concord232/ -[alarm_control_panel.egardia docs]: https://home-assistant.io/components/alarm_control_panel.egardia/ -[api docs]: https://home-assistant.io/components/api/ -[august docs]: https://home-assistant.io/components/august/ -[binary_sensor docs]: https://home-assistant.io/components/binary_sensor/ -[binary_sensor.concord232 docs]: https://home-assistant.io/components/binary_sensor.concord232/ -[binary_sensor.egardia docs]: https://home-assistant.io/components/binary_sensor.egardia/ -[binary_sensor.hikvision docs]: https://home-assistant.io/components/binary_sensor.hikvision/ -[binary_sensor.insteon_plm docs]: https://home-assistant.io/components/binary_sensor.insteon_plm/ -[binary_sensor.isy994 docs]: https://home-assistant.io/components/binary_sensor.isy994/ -[binary_sensor.knx docs]: https://home-assistant.io/components/binary_sensor.knx/ -[binary_sensor.upcloud docs]: https://home-assistant.io/components/binary_sensor.upcloud/ -[binary_sensor.zha docs]: https://home-assistant.io/components/binary_sensor.zha/ -[camera.onvif docs]: https://home-assistant.io/components/camera.onvif/ -[camera.proxy docs]: https://home-assistant.io/components/camera.proxy/ -[camera.rpi_camera docs]: https://home-assistant.io/components/camera.rpi_camera/ -[camera.yi docs]: https://home-assistant.io/components/camera.yi/ -[canary docs]: https://home-assistant.io/components/canary/ -[climate docs]: https://home-assistant.io/components/climate/ -[climate.nest docs]: https://home-assistant.io/components/climate.nest/ -[climate.wink docs]: https://home-assistant.io/components/climate.wink/ -[cloud docs]: https://home-assistant.io/components/cloud/ -[coinbase docs]: https://home-assistant.io/components/coinbase/ -[config docs]: https://home-assistant.io/components/config/ -[conversation docs]: https://home-assistant.io/components/conversation/ -[demo docs]: https://home-assistant.io/components/demo/ -[device_tracker docs]: https://home-assistant.io/components/device_tracker/ -[device_tracker.asuswrt docs]: https://home-assistant.io/components/device_tracker.asuswrt/ -[device_tracker.icloud docs]: https://home-assistant.io/components/device_tracker.icloud/ -[device_tracker.tesla docs]: https://home-assistant.io/components/device_tracker.tesla/ -[device_tracker.ubus docs]: https://home-assistant.io/components/device_tracker.ubus/ -[egardia docs]: https://home-assistant.io/components/egardia/ -[fan.insteon_plm docs]: https://home-assistant.io/components/fan.insteon_plm/ -[frontend docs]: https://home-assistant.io/components/frontend/ -[google_assistant docs]: https://home-assistant.io/components/google_assistant/ -[group docs]: https://home-assistant.io/components/group/ -[homekit docs]: https://home-assistant.io/components/homekit/ -[http docs]: https://home-assistant.io/components/http/ -[hue docs]: https://home-assistant.io/components/hue/ -[ihc docs]: https://home-assistant.io/components/ihc/ -[influxdb docs]: https://home-assistant.io/components/influxdb/ -[insteon_plm docs]: https://home-assistant.io/components/insteon_plm/ -[knx docs]: https://home-assistant.io/components/knx/ -[light docs]: https://home-assistant.io/components/light/ -[light.demo docs]: https://home-assistant.io/components/light.demo/ -[light.group docs]: https://home-assistant.io/components/light.group/ -[light.group docs]: https://home-assistant.io/components/light.group/ -[light.hue docs]: https://home-assistant.io/components/light.hue/ -[light.hyperion docs]: https://home-assistant.io/components/light.hyperion/ -[light.insteon_plm docs]: https://home-assistant.io/components/light.insteon_plm/ -[light.knx docs]: https://home-assistant.io/components/light.knx/ -[light.lifx docs]: https://home-assistant.io/components/light.lifx/ -[light.limitlessled docs]: https://home-assistant.io/components/light.limitlessled/ -[light.xiaomi_miio docs]: https://home-assistant.io/components/light.xiaomi_miio/ -[light.zha docs]: https://home-assistant.io/components/light.zha/ -[logbook docs]: https://home-assistant.io/components/logbook/ -[media_player.apple_tv docs]: https://home-assistant.io/components/media_player.apple_tv/ -[media_player.cast docs]: https://home-assistant.io/components/media_player.cast/ -[media_player.channels docs]: https://home-assistant.io/components/media_player.channels/ -[media_player.emby docs]: https://home-assistant.io/components/media_player.emby/ -[media_player.plex docs]: https://home-assistant.io/components/media_player.plex/ -[media_player.songpal docs]: https://home-assistant.io/components/media_player.songpal/ -[media_player.sonos docs]: https://home-assistant.io/components/media_player.sonos/ -[mqtt docs]: https://home-assistant.io/components/mqtt/ -[notify.html5 docs]: https://home-assistant.io/components/notify.html5/ -[notify.synology_chat docs]: https://home-assistant.io/components/notify.synology_chat/ -[remote.xiaomi_miio docs]: https://home-assistant.io/components/remote.xiaomi_miio/ -[rest_command docs]: https://home-assistant.io/components/rest_command/ -[scene docs]: https://home-assistant.io/components/scene/ -[sensor.airvisual docs]: https://home-assistant.io/components/sensor.airvisual/ -[sensor.citybikes docs]: https://home-assistant.io/components/sensor.citybikes/ -[sensor.filter docs]: https://home-assistant.io/components/sensor.filter/ -[sensor.fitbit docs]: https://home-assistant.io/components/sensor.fitbit/ -[sensor.folder docs]: https://home-assistant.io/components/sensor.folder/ -[sensor.history_stats docs]: https://home-assistant.io/components/sensor.history_stats/ -[sensor.imap docs]: https://home-assistant.io/components/sensor.imap/ -[sensor.insteon_plm docs]: https://home-assistant.io/components/sensor.insteon_plm/ -[sensor.luftdaten docs]: https://home-assistant.io/components/sensor.luftdaten/ -[sensor.netatmo docs]: https://home-assistant.io/components/sensor.netatmo/ -[sensor.plex docs]: https://home-assistant.io/components/sensor.plex/ -[sensor.pollen docs]: https://home-assistant.io/components/sensor.pollen/ -[sensor.rest docs]: https://home-assistant.io/components/sensor.rest/ -[sensor.sense docs]: https://home-assistant.io/components/sensor.sense/ -[sensor.serial_pm docs]: https://home-assistant.io/components/sensor.serial_pm/ -[sensor.simulated docs]: https://home-assistant.io/components/sensor.simulated/ -[sensor.sql docs]: https://home-assistant.io/components/sensor.sql/ -[sensor.systemmonitor docs]: https://home-assistant.io/components/sensor.systemmonitor/ -[sensor.teksavvy docs]: https://home-assistant.io/components/sensor.teksavvy/ -[sensor.tesla docs]: https://home-assistant.io/components/sensor.tesla/ -[sensor.tibber docs]: https://home-assistant.io/components/sensor.tibber/ -[sensor.xbox_live docs]: https://home-assistant.io/components/sensor.xbox_live/ -[sensor.xiaomi_aqara docs]: https://home-assistant.io/components/sensor.xiaomi_aqara/ -[sensor.zestimate docs]: https://home-assistant.io/components/sensor.zestimate/ -[shopping_list docs]: https://home-assistant.io/components/shopping_list/ -[switch.edimax docs]: https://home-assistant.io/components/switch.edimax/ -[switch.insteon_plm docs]: https://home-assistant.io/components/switch.insteon_plm/ -[switch.rest docs]: https://home-assistant.io/components/switch.rest/ -[switch.tesla docs]: https://home-assistant.io/components/switch.tesla/ -[switch.upcloud docs]: https://home-assistant.io/components/switch.upcloud/ -[switch.volvooncall docs]: https://home-assistant.io/components/switch.volvooncall/ -[switch.xiaomi_aqara docs]: https://home-assistant.io/components/switch.xiaomi_aqara/ -[switch.xiaomi_miio docs]: https://home-assistant.io/components/switch.xiaomi_miio/ -[switch.zha docs]: https://home-assistant.io/components/switch.zha/ -[telegram_bot.broadcast docs]: https://home-assistant.io/components/telegram_bot.broadcast/ -[telegram_bot.polling docs]: https://home-assistant.io/components/telegram_bot.polling/ -[telegram_bot.webhooks docs]: https://home-assistant.io/components/telegram_bot.webhooks/ -[upcloud docs]: https://home-assistant.io/components/upcloud/ -[vacuum.xiaomi_miio docs]: https://home-assistant.io/components/vacuum.xiaomi_miio/ -[weather docs]: https://home-assistant.io/components/weather/ -[weather.darksky docs]: https://home-assistant.io/components/weather.darksky/ -[xiaomi_aqara docs]: https://home-assistant.io/components/xiaomi_aqara/ -[zabbix docs]: https://home-assistant.io/components/zabbix/ -[zha docs]: https://home-assistant.io/components/zha/ -[zwave docs]: https://home-assistant.io/components/zwave/ +[alarm_control_panel.alarmdotcom docs]: /components/alarm_control_panel.alarmdotcom/ +[alarm_control_panel.concord232 docs]: /components/alarm_control_panel.concord232/ +[alarm_control_panel.egardia docs]: /components/alarm_control_panel.egardia/ +[api docs]: /components/api/ +[august docs]: /components/august/ +[binary_sensor docs]: /components/binary_sensor/ +[binary_sensor.concord232 docs]: /components/binary_sensor.concord232/ +[binary_sensor.egardia docs]: /components/binary_sensor.egardia/ +[binary_sensor.hikvision docs]: /components/binary_sensor.hikvision/ +[binary_sensor.insteon_plm docs]: /components/binary_sensor.insteon_plm/ +[binary_sensor.isy994 docs]: /components/binary_sensor.isy994/ +[binary_sensor.knx docs]: /components/binary_sensor.knx/ +[binary_sensor.upcloud docs]: /components/binary_sensor.upcloud/ +[binary_sensor.zha docs]: /components/binary_sensor.zha/ +[camera.onvif docs]: /components/camera.onvif/ +[camera.proxy docs]: /components/camera.proxy/ +[camera.rpi_camera docs]: /components/camera.rpi_camera/ +[camera.yi docs]: /components/camera.yi/ +[canary docs]: /components/canary/ +[climate docs]: /components/climate/ +[climate.nest docs]: /components/climate.nest/ +[climate.wink docs]: /components/climate.wink/ +[cloud docs]: /components/cloud/ +[coinbase docs]: /components/coinbase/ +[config docs]: /components/config/ +[conversation docs]: /components/conversation/ +[demo docs]: /components/demo/ +[device_tracker docs]: /components/device_tracker/ +[device_tracker.asuswrt docs]: /components/device_tracker.asuswrt/ +[device_tracker.icloud docs]: /components/device_tracker.icloud/ +[device_tracker.tesla docs]: /components/device_tracker.tesla/ +[device_tracker.ubus docs]: /components/device_tracker.ubus/ +[egardia docs]: /components/egardia/ +[fan.insteon_plm docs]: /components/fan.insteon_plm/ +[frontend docs]: /components/frontend/ +[google_assistant docs]: /components/google_assistant/ +[group docs]: /components/group/ +[homekit docs]: /components/homekit/ +[http docs]: /components/http/ +[hue docs]: /components/hue/ +[ihc docs]: /components/ihc/ +[influxdb docs]: /components/influxdb/ +[insteon_plm docs]: /components/insteon_plm/ +[knx docs]: /components/knx/ +[light docs]: /components/light/ +[light.demo docs]: /components/light.demo/ +[light.group docs]: /components/light.group/ +[light.group docs]: /components/light.group/ +[light.hue docs]: /components/light.hue/ +[light.hyperion docs]: /components/light.hyperion/ +[light.insteon_plm docs]: /components/light.insteon_plm/ +[light.knx docs]: /components/light.knx/ +[light.lifx docs]: /components/light.lifx/ +[light.limitlessled docs]: /components/light.limitlessled/ +[light.xiaomi_miio docs]: /components/light.xiaomi_miio/ +[light.zha docs]: /components/light.zha/ +[logbook docs]: /components/logbook/ +[media_player.apple_tv docs]: /components/media_player.apple_tv/ +[media_player.cast docs]: /components/media_player.cast/ +[media_player.channels docs]: /components/media_player.channels/ +[media_player.emby docs]: /components/media_player.emby/ +[media_player.plex docs]: /components/media_player.plex/ +[media_player.songpal docs]: /components/media_player.songpal/ +[media_player.sonos docs]: /components/media_player.sonos/ +[mqtt docs]: /components/mqtt/ +[notify.html5 docs]: /components/notify.html5/ +[notify.synology_chat docs]: /components/notify.synology_chat/ +[remote.xiaomi_miio docs]: /components/remote.xiaomi_miio/ +[rest_command docs]: /components/rest_command/ +[scene docs]: /components/scene/ +[sensor.airvisual docs]: /components/sensor.airvisual/ +[sensor.citybikes docs]: /components/sensor.citybikes/ +[sensor.filter docs]: /components/sensor.filter/ +[sensor.fitbit docs]: /components/sensor.fitbit/ +[sensor.folder docs]: /components/sensor.folder/ +[sensor.history_stats docs]: /components/sensor.history_stats/ +[sensor.imap docs]: /components/sensor.imap/ +[sensor.insteon_plm docs]: /components/sensor.insteon_plm/ +[sensor.luftdaten docs]: /components/sensor.luftdaten/ +[sensor.netatmo docs]: /components/sensor.netatmo/ +[sensor.plex docs]: /components/sensor.plex/ +[sensor.pollen docs]: /components/sensor.pollen/ +[sensor.rest docs]: /components/sensor.rest/ +[sensor.sense docs]: /components/sensor.sense/ +[sensor.serial_pm docs]: /components/sensor.serial_pm/ +[sensor.simulated docs]: /components/sensor.simulated/ +[sensor.sql docs]: /components/sensor.sql/ +[sensor.systemmonitor docs]: /components/sensor.systemmonitor/ +[sensor.teksavvy docs]: /components/sensor.teksavvy/ +[sensor.tesla docs]: /components/sensor.tesla/ +[sensor.tibber docs]: /components/sensor.tibber/ +[sensor.xbox_live docs]: /components/sensor.xbox_live/ +[sensor.xiaomi_aqara docs]: /components/sensor.xiaomi_aqara/ +[sensor.zestimate docs]: /components/sensor.zestimate/ +[shopping_list docs]: /components/shopping_list/ +[switch.edimax docs]: /components/switch.edimax/ +[switch.insteon_plm docs]: /components/switch.insteon_plm/ +[switch.rest docs]: /components/switch.rest/ +[switch.tesla docs]: /components/switch.tesla/ +[switch.upcloud docs]: /components/switch.upcloud/ +[switch.volvooncall docs]: /components/switch.volvooncall/ +[switch.xiaomi_aqara docs]: /components/switch.xiaomi_aqara/ +[switch.xiaomi_miio docs]: /components/switch.xiaomi_miio/ +[switch.zha docs]: /components/switch.zha/ +[telegram_bot.broadcast docs]: /components/telegram_bot.broadcast/ +[telegram_bot.polling docs]: /components/telegram_bot.polling/ +[telegram_bot.webhooks docs]: /components/telegram_bot.webhooks/ +[upcloud docs]: /components/upcloud/ +[vacuum.xiaomi_miio docs]: /components/vacuum.xiaomi_miio/ +[weather docs]: /components/weather/ +[weather.darksky docs]: /components/weather.darksky/ +[xiaomi_aqara docs]: /components/xiaomi_aqara/ +[zabbix docs]: /components/zabbix/ +[zha docs]: /components/zha/ +[zwave docs]: /components/zwave/ [#13020]: https://github.com/home-assistant/home-assistant/pull/13020 [#13024]: https://github.com/home-assistant/home-assistant/pull/13024 [#13027]: https://github.com/home-assistant/home-assistant/pull/13027 @@ -657,9 +665,9 @@ Experiencing issues introduced by this release? Please report them in our [issue [@balloob]: https://github.com/balloob [@cdce8p]: https://github.com/cdce8p [@kellerza]: https://github.com/kellerza -[device_tracker docs]: https://home-assistant.io/components/device_tracker/ -[google_assistant docs]: https://home-assistant.io/components/google_assistant/ -[homekit docs]: https://home-assistant.io/components/homekit/ +[device_tracker docs]: /components/device_tracker/ +[google_assistant docs]: /components/google_assistant/ +[homekit docs]: /components/homekit/ [#12996]: https://github.com/home-assistant/home-assistant/pull/12996 [#13037]: https://github.com/home-assistant/home-assistant/pull/13037 [#13038]: https://github.com/home-assistant/home-assistant/pull/13038 @@ -676,13 +684,13 @@ Experiencing issues introduced by this release? Please report them in our [issue [@armills]: https://github.com/armills [@ptarjan]: https://github.com/ptarjan [@syssi]: https://github.com/syssi -[climate.sensibo docs]: https://home-assistant.io/components/climate.sensibo/ -[light.lifx docs]: https://home-assistant.io/components/light.lifx/ -[light.yeelight docs]: https://home-assistant.io/components/light.yeelight/ -[sensor.sabnzbd docs]: https://home-assistant.io/components/sensor.sabnzbd/ -[sensor.sql docs]: https://home-assistant.io/components/sensor.sql/ -[wink docs]: https://home-assistant.io/components/wink/ -[xiaomi_aqara docs]: https://home-assistant.io/components/xiaomi_aqara/ +[climate.sensibo docs]: /components/climate.sensibo/ +[light.lifx docs]: /components/light.lifx/ +[light.yeelight docs]: /components/light.yeelight/ +[sensor.sabnzbd docs]: /components/sensor.sabnzbd/ +[sensor.sql docs]: /components/sensor.sql/ +[wink docs]: /components/wink/ +[xiaomi_aqara docs]: /components/xiaomi_aqara/ [#12939]: https://github.com/home-assistant/home-assistant/pull/12939 [#13058]: https://github.com/home-assistant/home-assistant/pull/13058 [#13062]: https://github.com/home-assistant/home-assistant/pull/13062 @@ -699,16 +707,16 @@ Experiencing issues introduced by this release? Please report them in our [issue [@jesserockz]: https://github.com/jesserockz [@pavoni]: https://github.com/pavoni [@snjoetw]: https://github.com/snjoetw -[camera.arlo docs]: https://home-assistant.io/components/camera.arlo/ -[camera.synology docs]: https://home-assistant.io/components/camera.synology/ -[climate.generic_thermostat docs]: https://home-assistant.io/components/climate.generic_thermostat/ -[device_tracker.tado docs]: https://home-assistant.io/components/device_tracker.tado/ -[knx docs]: https://home-assistant.io/components/knx/ -[light.hue docs]: https://home-assistant.io/components/light.hue/ -[light.iglo docs]: https://home-assistant.io/components/light.iglo/ -[media_player.cast docs]: https://home-assistant.io/components/media_player.cast/ -[media_player.kodi docs]: https://home-assistant.io/components/media_player.kodi/ -[vera docs]: https://home-assistant.io/components/vera/ +[camera.arlo docs]: /components/camera.arlo/ +[camera.synology docs]: /components/camera.synology/ +[climate.generic_thermostat docs]: /components/climate.generic_thermostat/ +[device_tracker.tado docs]: /components/device_tracker.tado/ +[knx docs]: /components/knx/ +[light.hue docs]: /components/light.hue/ +[light.iglo docs]: /components/light.iglo/ +[media_player.cast docs]: /components/media_player.cast/ +[media_player.kodi docs]: /components/media_player.kodi/ +[vera docs]: /components/vera/ [#13106]: https://github.com/home-assistant/home-assistant/pull/13106 [#13109]: https://github.com/home-assistant/home-assistant/pull/13109 [#13114]: https://github.com/home-assistant/home-assistant/pull/13114 @@ -716,11 +724,11 @@ Experiencing issues introduced by this release? Please report them in our [issue [@arsaboo]: https://github.com/arsaboo [@balloob]: https://github.com/balloob [@jeroenterheerdt]: https://github.com/jeroenterheerdt -[alarm_control_panel.egardia docs]: https://home-assistant.io/components/alarm_control_panel.egardia/ -[arlo docs]: https://home-assistant.io/components/arlo/ -[hue docs]: https://home-assistant.io/components/hue/ -[light.hue docs]: https://home-assistant.io/components/light.hue/ -[switch.wemo docs]: https://home-assistant.io/components/switch.wemo/ +[alarm_control_panel.egardia docs]: /components/alarm_control_panel.egardia/ +[arlo docs]: /components/arlo/ +[hue docs]: /components/hue/ +[light.hue docs]: /components/light.hue/ +[switch.wemo docs]: /components/switch.wemo/ [#13162]: https://github.com/home-assistant/home-assistant/pull/13162 [#13174]: https://github.com/home-assistant/home-assistant/pull/13174 [#13195]: https://github.com/home-assistant/home-assistant/pull/13195 @@ -730,7 +738,20 @@ Experiencing issues introduced by this release? Please report them in our [issue [@arsaboo]: https://github.com/arsaboo [@balloob]: https://github.com/balloob [@cdce8p]: https://github.com/cdce8p -[arlo docs]: https://home-assistant.io/components/arlo/ -[google_assistant docs]: https://home-assistant.io/components/google_assistant/ -[homekit docs]: https://home-assistant.io/components/homekit/ -[media_player.sonos docs]: https://home-assistant.io/components/media_player.sonos/ +[arlo docs]: /components/arlo/ +[google_assistant docs]: /components/google_assistant/ +[homekit docs]: /components/homekit/ +[media_player.sonos docs]: /components/media_player.sonos/ +[#13226]: https://github.com/home-assistant/home-assistant/pull/13226 +[#13237]: https://github.com/home-assistant/home-assistant/pull/13237 +[#13248]: https://github.com/home-assistant/home-assistant/pull/13248 +[#13293]: https://github.com/home-assistant/home-assistant/pull/13293 +[#13358]: https://github.com/home-assistant/home-assistant/pull/13358 +[@PhracturedBlue]: https://github.com/PhracturedBlue +[@amelchio]: https://github.com/amelchio +[@balloob]: https://github.com/balloob +[camera.proxy docs]: /components/camera.proxy/ +[device_tracker docs]: /components/device_tracker/ +[google_assistant docs]: /components/google_assistant/ +[light.demo docs]: /components/light.demo/ +[media_player.sonos docs]: /components/media_player.sonos/ diff --git a/source/_posts/2018-03-24-new-release-schedule.markdown b/source/_posts/2018-03-24-new-release-schedule.markdown new file mode 100644 index 0000000000..d39d8d3633 --- /dev/null +++ b/source/_posts/2018-03-24-new-release-schedule.markdown @@ -0,0 +1,32 @@ +--- +layout: post +title: "Updated release schedule" +description: "We're adding a beta period of a week before marking each release as final." +date: 2018-03-24 00:01:00 +date_formatted: "March 24, 2018" +author: Paulus Schoutsen +author_twitter: balloob +comments: true +categories: Announcements +og_image: /images/blog/2018-03-release-schedule/social.png +--- + +So this weekend we're going to shake things a little up. Instead of releasing a new version today, we've released a beta version of the new version: 0.66.0.beta0. After a week of being in beta, the version will be promoted to be the new stable release. While the beta is live, we will accept contributions on the dev branch for the next version as usual. + +

    +Diagram showing the updates release cycle containing a week extra time before release. +Diagram of the new release schedule +

    + +The goal is to create a more stable first release without the need for a quick follow up hot fix. So if you want to be able to access the new features faster but don't mind the risk of running into the occasional bug, get yourself on the beta channel today: + + - Hass.io users will be able to enable the dev channel in the system settings. + - For Docker users, the beta's will be published under the `rc` tag. + - Beta's are also published to PyPi. Because it is a beta release, it will not be installed by Pip unless explictely specified in the install command: `pip3 install --pre --upgrade homeassistant`. + +The documentation for the beta version can be found at [https://rc.home-assistant.io/](https://rc.home-assistant.io/). + +If you find issues with either the code or the docs of the pre-release, please open an issue in the [appropriate place](/help/#bugs-feature-requests-and-alike) or, even better, submit a pull request to fix it. diff --git a/source/_posts/2018-03-29-fedora-atomic.markdown b/source/_posts/2018-03-29-fedora-atomic.markdown new file mode 100644 index 0000000000..30750c6342 --- /dev/null +++ b/source/_posts/2018-03-29-fedora-atomic.markdown @@ -0,0 +1,143 @@ +--- +layout: post +title: "Using Fedora Atomic with Home Assistant" +description: "Running Home Assistant on a Fedora Atomic host." +date: 2018-03-29 22:00:00 +date_formatted: "March 29, 2018" +author: Fabian Affolter +author_twitter: fabaff +comments: true +categories: Announcements +og_image: /images/blog/2018-03-fedora-atomic/social.png +--- + + +The Hackerspace [Eastermundigen](http://www.eastermundigen.ch/) is often my real-world playground for Home Assistant-related topics which sometimes more belong in the industrial automation area than in a home. Also, it gives me access to devices which I don't have like 3D printers, laser cutters, connected power strips and a like. In the past the local Home Assistant instance there was running on an old [CubieBoard2](http://cubieboard.org/) with [Fedora ARM](https://arm.fedoraproject.org/). It was one of several systems which were running 24/7. To reduce the electricity costs we decided to consolidate the physical systems to only two. One for storage and one for all other services. + + + +This blog post contains the details of the setup. They may be useful for others as well. Our new system is running Fedora 27 from [Project Atomic](http://www.projectatomic.io). We will not cover the setup of an Atomic host and the details of Project Atomic itself. For more details, have a look at [Benjamin Affolter](https://twitter.com/bliemli)'s [blog post](https://www.puzzle.ch/blog/articles/2017/09/28/atomic-host-basic-setup-and-usage) which also covers some of the basics. + +The installation process of an Atomic host is pretty much the same as for Fedora Server or Fedora Workstation. Either create a Live USB device or use PXE to get the installation going. E.g., lauch iPXE and chainload [netboot.yxz](https://netboot.xyz/) with `chain --autofree https://boot.netboot.xyz`. Then let `anaconda` guide you through the setup. + +After the first boot, copy the SSH keys, use `visudo` to add users and perform the usual steps you do for a new system. We only allow SSH with keys, are enforcing the usage of `sudo`, need special network settings and a couple of other things. But those configuration settings are irrelevant for a setup in a local network. + +If the system is up and running then check if you are using the latest release. + +```bash +$ sudo atomic host status +State: idle; auto updates disabled +Deployments: +● ostree://fedora-atomic:fedora/27/x86_64/atomic-host + Version: 27.100 (2018-03-13 17:19:44) + Commit: 326f62b93a5cc836c97d31e73a71b6b6b6955c0f225f7651b52a693718e6aa91 + GPGSignature: Valid signature by 860E19B0AFA800A1751881A6F55E7430F5282EE4 +``` + +The release is 27.100. The latest is 27.105. So, let's update the host and reboot it. + +```bash +$ sudo atomic host upgrade +$ sudo systemctl reboot +``` + +You can also see that Docker is already running. No installation needed. + +```bash +$ sudo systemctl status docker +● docker.service - Docker Application Container Engine + Loaded: loaded (/usr/lib/systemd/system/docker.service; enabled; vendor preset: disabled) + Active: active (running) since Thu 2018-03-28 15:44:04 CEST; 35min ago +... +``` + +Further we will cover how it works for Home Assistant and [Mosquitto](https://mosquitto.org/). For a small setup using [kubernetes](https://kubernetes.io) seems a bit overkill. Thus, we decided to stick to `systemd`. + +Instead of `docker` we can use the command-line tool [`atomic`](http://www.projectatomic.io/docs/usr-bin-atomic/) to perform a lot of tasks. Download the images for the containers. We are pulling the images from [Docker Hub](https://hub.docker.com/), thus we need to add the registry to use. + +```bash +$ sudo atomic install docker.io/​homeassistant/home-assistant +$ sudo atomic install docker.io/eclipse-mosquitto +``` + +Both containers need additional directories for persistent storage. + +```bash +$ sudo mkdir -p /opt/home-assistant +$ sudo mkdir -p /opt/mosquitto/{config,data,log} +``` + +We need a copy of `mosquitto.conf` to run Mosquitto later: + +```bash +$ sudo curl -o /opt/mosquitto/config/mosquitto.conf \ + https://raw.githubusercontent.com/eclipse/mosquitto/master/mosquitto.conf +``` + +To handle the containers we created service unit files for the [Home Assistant](https://hub.docker.com/r/homeassistant/home-assistant/) and the [Mosquitto](https://hub.docker.com/_/eclipse-mosquitto/) container. For Home Assistant and Mosquitto the file can looks like the sample below. Further details about the `ExecStart` line can be found in the documentation about a [Docker](/docs/installation/docker/) setup. For Home Assistant + +```bash +$ su +# cat <<'EOF' >> /etc/systemd/system/home-assistant.service +[Unit] +Description=Home Assistant +Requires=docker.service +Wants=docker.service +After=docker.service + +[Service] +Restart=on-failure +RestartSec=10 +ExecStart=/usr/bin/docker run --rm --name %p -v /opt/home-assistant:/config:Z -v /etc/localtime:/etc/localtime:ro --network host homeassistant/home-assistant +ExecStop=-/usr/bin/docker stop -t 30 %p + +[Install] +WantedBy=multi-user.target +EOF +``` + +and for Mosquitto. + +```bash +# cat <<'EOF' >> /etc/systemd/system/mosquitto.service +[Unit] +Description=Mosquitto MQTT docker container +Requires=docker.service +Wants=docker.service +After=docker.service + +[Service] +Restart=on-failure +RestartSec=10 +ExecStart=/usr/bin/docker run --name %p -v mosquitto.conf:/opt/mosquitto/config/mosquitto.conf -v /opt/mosquitto/data:/opt/mosquitto/data -v /opt/mosquitto/log:/mosquitto/log -p 1883:1883 -p 9001:9001 eclipse-mosquitto +ExecStop=/usr/bin/docker stop -t 2 %p +ExecStopPost=/usr/bin/docker rm -f %p + +[Install] +WantedBy=multi-user.target +EOF +``` + +Exit to be not longer `root`. + +```bash +# exit +``` + +Reload `systemd` to make it aware of the new configurations. + +```bash +$ sudo systemctl daemon-reload +``` + +Now, both container can be controlled by `systemctl`. + +```bash +$ sudo systemctl enable home-assistant.service --now +$ sudo systemctl enable mosquitto.service --now +``` + +Check with `$ sudo systemctl status [name].service` if there are error or the services are running. + +The deployment of [NGINX](https://nginx.org/en/) as webserver for static content, [grafana](https://grafana.com/) and [InfluxBD](https://www.influxdata.com/) works the same way as for Home Assistant and Mosquitto. To get a proper [traefik](https://traefik.io/) setup additional reading and work is required. + diff --git a/source/_posts/2018-03-30-release-66.markdown b/source/_posts/2018-03-30-release-66.markdown new file mode 100644 index 0000000000..26aba182be --- /dev/null +++ b/source/_posts/2018-03-30-release-66.markdown @@ -0,0 +1,571 @@ +--- +layout: post +title: "0.66: VeSync switches, HomematicIP, and a group cover." +description: "Fabulous release 0.66 has landed! Tons of fixes, improvements and joy." +date: 2018-03-30 00:01:00 +date_formatted: "March 30, 2018" +author: Paulus Schoutsen +author_twitter: balloob +comments: true +categories: Release-Notes +og_image: /images/blog/2018-03-0.66/components.png +--- + + + +This is the first release with our new release schedule. During the extra week we had a total of 4 beta releases with a total of [26 fixes](https://github.com/home-assistant/home-assistant/milestone/128?closed=1). So this should be the most stable release yet! + +It's also a release that is full of goodies. 80 people contributed over 223 fixes, improvements and new integrations during the last 2 weeks of this release 😎 I want to highlight the work of two people who are doing an amazing job: [@NovapaX] has been doing a great job triaging and fixing weird quirks and bugs in the frontend. And I want to give a shout out to [@armills] who has enabled backend translations. This means that a bunch of things that did not have translations yet, will now soon be translatable. We're planning some cool things with this! + +A quick note if you are using Philips Hue and a Hue custom component: it will no longer work due to the internal changes to the Hue platform. Remove the custom component to ensure that your Hue lights keep working. + +## New Platforms + +- Add new platform for VeSync switches ([@markperdue] - [#13000]) ([switch.vesync docs]) (new-platform) +- HomeKit Restructure (new config options) ([@cdce8p] - [#12997]) ([homekit docs]) (breaking change) (new-platform) +- Added cover.group platform (replaces #12303) ([@cdce8p] - [#12692]) ([cover.group docs]) (new-platform) +- Add extra sensors for BMW ConnectedDrive ([@gerard33] - [#12591]) ([bmw_connected_drive docs]) ([binary_sensor.bmw_connected_drive docs]) ([lock.bmw_connected_drive docs]) ([sensor.bmw_connected_drive docs]) (new-platform) +- Homekit: New supported devices ([@cdce8p] - [#13244]) ([homekit docs]) (new-platform) +- Adding Foobot device sensor ([@reefab] - [#12417]) ([sensor.foobot docs]) (new-platform) +- Added Stride notification component ([@BioSehnsucht] - [#13221]) ([notify docs]) (new-platform) +- Xiaomi MiIO Sensor: Xiaomi Air Quality Monitor (PM2.5) integration ([@syssi] - [#13264]) ([sensor.xiaomi_miio docs]) (new-platform) +- Add initial support fo HomematicIP components ([@mxworm] - [#12761]) ([homematicip docs]) ([sensor.homematicip docs]) (new-platform) +- Support for security systems controlled by IFTTT ([@maxclaey] - [#12975]) ([alarm_control_panel.ifttt docs]) (new-platform) +- Zigbee fan ([@igorbernstein2] - [#12289]) ([zha docs]) ([fan.zha docs]) (new-platform) +- Adding a discoverable Samsung Syncthru Printer sensor platform ([@nielstron] - [#13134]) ([sensor.syncthru docs]) (new-platform) +- Add trafikverket_weatherstation sensor platform ([@Qxlkdr] - [#12115]) ([sensor.trafikverket_weatherstation docs]) (new-platform) +- Security fix & lock for HomeMatic ([@PH89] - [#11980]) ([homematic docs]) ([lock docs]) ([lock.homematic docs]) (breaking change) (new-platform) + +## {% linkable_title Release 0.66.1 - April 1 %} + +- Update frontend to fix climate and chart issues ([@NovapaX] & [@c727]) +- Fix mqtt_json color commands ([@armills] - [#13617]) ([light.mqtt_json docs]) +- Add pincode fallback ([@cdce8p] - [#13587]) ([homekit docs]) +- Fix mysensors sensor type lookup ([@MartinHjelmare] - [#13574]) ([sensor.mysensors docs]) + +## {% linkable_title If you need help... %} + +...don't hesitate to use our very active [forums](https://community.home-assistant.io/) or join us for a little [chat](https://discord.gg/c5DvZ4e). The release notes have comments enabled but it's preferred if you use the former communication channels. Thanks. + +## {% linkable_title Reporting Issues %} + +Experiencing issues introduced by this release? Please report them in our [issue tracker](https://github.com/home-assistant/home-assistant/issues). Make sure to fill in all fields of the issue template. + + +## Breaking Changes + +- Refactor Hue: If you specify a bridge in your config, the `host` key is now required and needs to be a valid ip address. Option `allow_in_emulated_hue` has been removed. Exclude the lights via the emulated hue config. Due to the internal changes of how the Hue integration works, any Hue custom component will no longer work. ([@balloob] - [#13043]) ([hue docs]) ([light.hue docs]) (breaking change) +- Z-Wave: In version 0.47, the opt-in `new_entity_ids` configuration was added to Z-Wave to smooth the transition through the change. Support for old entity IDs is now removed, and the configuration is no longer necessary. If you are migrating from 0.63 or higher, your entity IDs will already be stored in the Entity Registry and no changes are required. If not, [entity IDs can now be manually configured using the Entity Registry](/docs/configuration/entity-registry/) if necessary. ([@armills] - [#12652]) ([zwave docs]) (breaking change) +- Spotcrime sensor: This update changes the sensor to require a user supplied API key as a configuration entry. The default key has been removed from the Spotcrime package and has also been modified to accept a user supplied API key.([@jcconnell] - [#12926]) ([sensor.spotcrime docs]) (breaking change) +- Smappee sensor: Fixed SI units for current consumption. Total consumption should be in kWh. not kW. ([@vandenberghev] - [#13190]) ([sensor.smappee docs]) (breaking change) +- System monitor sensor: Used and available swap space reported by the system monitor component is now measured in MiB instead of GiB. ([@DanNixon] - [#13148]) ([sensor.systemmonitor docs]) (breaking change) +- HomeKit: The `pincode` parameter is deprecated, since the `HomeKit` component will now generate one for you and display it as a persistence notification during setup. Additionally the default `port` changed to `51827` to avoid potential conflicts with `homebridge`. Lastly to fix a major bug, we needed to change the way accessory ids are generated. This means that in turn all previous accessory settings will need to be repeated. To avoid future conflicts, it is highly recommended to remove the `Home Assistant Bridge` from the `Home` app and repeat the setup process. ([HomeKit Setup](/components/homekit/#setup)) ([@cdce8p] - [#12997]) ([homekit docs]) (breaking change) (new-platform) +- Tibber: The name and the entity id for the Tibber sensor will now be the same as the nickname from the app. Default nick name is the address. So if you have not changed the nickname in the app, everything should be as before. ([@clementhk] - [#13231]) ([sensor.tibber docs]) (breaking change) +- Darsky sensor: Fix the incorrect unit of measurement for the 'Precip Intensity' and 'Daily Max Precip Intensity' for IS units according to the dark sky api documentation.([@cgtobi] - [#13415]) ([sensor.darksky docs]) (breaking change) +- HomeMatic: Locks are now under the lock component ([@PH89] - [#11980]) ([homematic docs]) ([lock docs]) ([lock.homematic docs]) (breaking change) (new-platform) + +## All changes + +- New lazytox.py script ([@kellerza] - [#12862]) +- Update netdisco to 1.3.0 ([@balloob] - [#13007]) +- remove rounding of temperature reading ([@hthiery] - [#13018]) ([sensor.lacrosse docs]) +- Make lazytox script executable ([@OttoWinter] - [#13040]) +- python-miio version bumped. ([@syssi] - [#13055]) ([fan.xiaomi_miio docs]) ([light.xiaomi_miio docs]) ([remote.xiaomi_miio docs]) ([switch.xiaomi_miio docs]) ([vacuum.xiaomi_miio docs]) +- Glances Docker Sensors ([@timmo001] - [#13026]) ([sensor.glances docs]) +- Script/lint, Lazytox: Fix issue to ignore delete files ([@cdce8p] - [#13051]) +- Sensor template don't exit early on TemplateError ([@OttoWinter] - [#13041]) ([sensor.template docs]) +- Better errors for unknown secrets ([@kellerza] - [#13072]) +- Remove Z-Wave old/new entity_id attributes ([@armills] - [#12652]) ([zwave docs]) (breaking change) +- Make Sensibo climate registry_entity compliant ([@andrey-git] - [#13086]) ([climate.sensibo docs]) +- Rename homeassistant.util.async to .async_ ([@smurfix] - [#13088]) +- Config flow translations ([@armills] - [#13066]) +- Lint script tweaks ([@armills] - [#13093]) +- asyncio.ensure_future Python 3.5 ([@OttoWinter] - [#13141]) ([spc docs]) +- Upgrade aiohttp to 3.0.7 ([@fabaff] - [#13119]) +- Upgrade astral to 1.6 ([@fabaff] - [#13120]) +- fix: Support different JointSpace API versions ([@FezVrasta] - [#13084]) ([media_player.philips_js docs]) +- update to async/await ([@perosb] - [#13137]) ([zha docs]) ([light.zha docs]) +- Upgrade mypy to 0.570 ([@fabaff] - [#13128]) +- Upgrade TwitterAPI to 2.4.10 ([@fabaff] - [#13126]) ([notify docs]) +- Upgrade youtube_dl to 2018.03.10 ([@fabaff] - [#13124]) ([media_extractor docs]) +- Upgrade zeroconf to 0.20.0 ([@fabaff] - [#13123]) ([zeroconf docs]) +- Upgrade schiene to 0.22 ([@fabaff] - [#13121]) ([sensor.deutsche_bahn docs]) +- Remove crazy JSON encoding things that are no longer used ([@balloob] - [#13029]) ([http docs]) ([websocket_api docs]) +- Disable Monkey Patch for 3.6.3+ ([@OttoWinter] - [#13150]) +- Upgrade Sphinx to 1.7.1 ([@fabaff] - [#13127]) +- upgrade tibber libary to 0.4.0 to use aiohttp 3.0 ([@danielhiversen] - [#13164]) ([sensor.tibber docs]) +- Change iglo port to cv.port validator ([@jesserockz] - [#13163]) ([light.iglo docs]) +- deConz rewrite to use async await syntax ([@Kane610] - [#13151]) ([deconz docs]) ([binary_sensor.deconz docs]) ([light.deconz docs]) ([scene.deconz docs]) ([sensor.deconz docs]) +- Upgrade holidays to 0.9.4 ([@OttoWinter] - [#13167]) ([binary_sensor.workday docs]) +- upcloud: Provide unique ID for server entities ([@scop] - [#13181]) ([upcloud docs]) +- Added IPAreaThermostat and an exception-list for HM_IGNORE_DISCOVERY_NODE ([@a-wolter] - [#13171]) ([homematic docs]) ([sensor.homematic docs]) +- Improve MQTT failed connection error message ([@OttoWinter] - [#13184]) ([mqtt docs]) +- Upgrade pytest to 3.4.2 ([@OttoWinter] - [#13169]) +- Channels clean ups ([@maddox] - [#12967]) ([media_player.channels docs]) +- Fix freegeoip ([@pvizeli] - [#13193]) +- Python Spotcrime sensor requires API key, fixes include/exclude ([@jcconnell] - [#12926]) ([sensor.spotcrime docs]) (breaking change) +- Add new platform for VeSync switches ([@markperdue] - [#13000]) ([switch.vesync docs]) (new-platform) +- Fixed SI units for current consumption ([@vandenberghev] - [#13190]) ([sensor.smappee docs]) (breaking change) +- Report swap in MiB ([@DanNixon] - [#13148]) ([sensor.systemmonitor docs]) (breaking change) +- Fix history API ([@balloob] - [#13214]) ([history docs]) +- Add notifications to downloader.py ([@engrbm87] - [#12961]) ([downloader docs]) +- HomeKit Restructure (new config options) ([@cdce8p] - [#12997]) ([homekit docs]) (breaking change) (new-platform) +- deCONZ - Add support for consumption and power sensors ([@Kane610] - [#13218]) ([deconz docs]) ([binary_sensor.deconz docs]) ([sensor.deconz docs]) +- Change Hass.io icon to home-assistant ([@c727] - [#13230]) ([hassio docs]) +- Add docstring ([@fabaff] - [#13232]) ([sensor.crimereports docs]) +- Python 3.5 adjustments ([@OttoWinter] - [#13173]) ([mysensors docs]) +- Added cover.group platform (replaces #12303) ([@cdce8p] - [#12692]) ([cover.group docs]) (new-platform) +- Tibber use appNickname as name ([@clementhk] - [#13231]) ([sensor.tibber docs]) (breaking change) +- media_content_type attribute display fix ([@kuzin2006] - [#13204]) ([media_player.kodi docs]) +- Edimax component reports wrong power values ([@andreipop2005] - [#13011]) ([switch.edimax docs]) +- myStrom: Add RGB support to Wifi bulbs ([@the-glu] - [#13194]) ([light.mystrom docs]) +- Fix logbook JSON serialize issue ([@balloob] - [#13229]) ([logbook docs]) +- Try to fix caldav ([@maxlaverse] - [#13236]) ([calendar.caldav docs]) +- Cleanup Sonos platform setup ([@amelchio] - [#13225]) ([media_player.sonos docs]) +- Fix 'dict' object has no attribute 'strftime' ([@Juggels] - [#13215]) ([calendar.todoist docs]) +- Fix aiohttp deprecation warnings ([@balloob] - [#13240]) +- Add extra sensors for BMW ConnectedDrive ([@gerard33] - [#12591]) ([bmw_connected_drive docs]) ([binary_sensor.bmw_connected_drive docs]) ([lock.bmw_connected_drive docs]) ([sensor.bmw_connected_drive docs]) (new-platform) +- Homekit: New supported devices ([@cdce8p] - [#13244]) ([homekit docs]) (new-platform) +- Adding Foobot device sensor ([@reefab] - [#12417]) ([sensor.foobot docs]) (new-platform) +- Fix for not setting up the camera if it is offline during setup phase ([@karlkar] - [#13082]) ([camera.onvif docs]) +- Added Stride notification component ([@BioSehnsucht] - [#13221]) ([notify docs]) (new-platform) +- Homekit: Use util functions for unit conversion ([@cdce8p] - [#13253]) ([homekit docs]) +- Use the first, not the last volume controller when multiple are available on songpal ([@rytilahti] - [#13222]) ([media_player.songpal docs]) +- Xiaomi MiIO Switch: Power Strip support improved ([@syssi] - [#12917]) ([switch.xiaomi_miio docs]) +- Xiaomi MiIO light: Philips Eyecare Smart Lamp 2 integration ([@syssi] - [#12883]) ([light.xiaomi_miio docs]) +- Fix guide link in CONTRIBUTING.md ([@JensTimmerman] - [#13272]) +- Xiaomi MiIO Remote: Unique id added ([@syssi] - [#13266]) ([remote.xiaomi_miio docs]) +- Xiaomi MiIO Sensor: Xiaomi Air Quality Monitor (PM2.5) integration ([@syssi] - [#13264]) ([sensor.xiaomi_miio docs]) (new-platform) +- Refactor Hue: phue -> aiohue ([@balloob] - [#13043]) ([hue docs]) ([light.hue docs]) (breaking change) +- Unused xiaomi miio sensor method removed ([@syssi] - [#13281]) ([sensor.xiaomi_miio docs]) +- Changed to async/await ([@thrawnarn] - [#13246]) ([media_player.bluesound docs]) +- Python 3.5 async with ([@OttoWinter] - [#13283]) +- Fix WUnderground duplicate entity ids ([@OttoWinter] - [#13285]) ([sensor.wunderground docs]) +- Upgrade aiohttp to 3.0.9 ([@fabaff] - [#13288]) +- Upgrade aiohttp_cors to 0.7.0 ([@fabaff] - [#13289]) ([http docs]) +- Upgrade sqlalchemy to 1.2.5 ([@fabaff] - [#13292]) ([sensor.sql docs]) +- Upgrade TwitterAPI to 2.5.0 ([@fabaff] - [#13287]) ([notify docs]) +- Upgrade numpy to 1.14.2 ([@fabaff] - [#13291]) ([binary_sensor.trend docs]) ([image_processing.opencv docs]) +- Upgrade python-telegram-bot to 10.0.1 ([@fabaff] - [#13294]) ([telegram_bot docs]) +- Upgrade python-forecastio to 1.4.0 ([@cgtobi] - [#13282]) ([weather.darksky docs]) +- Delete .gitmodules ([@pvizeli] - [#13295]) +- Update to latest python-nest ([@cburgess] - [#12590]) ([nest docs]) +- Upgrade async_timeout to 2.0.1 ([@fabaff] - [#13290]) +- Add initial support fo HomematicIP components ([@mxworm] - [#12761]) ([homematicip docs]) ([sensor.homematicip docs]) (new-platform) +- Added Time based SMA to Filter Sensor ([@dgomes] - [#13104]) ([sensor.filter docs]) +- Support for security systems controlled by IFTTT ([@maxclaey] - [#12975]) ([alarm_control_panel.ifttt docs]) (new-platform) +- Add ecobee fan mode ([@uchagani] - [#12732]) ([ecobee docs]) ([climate.ecobee docs]) +- Zigbee fan ([@igorbernstein2] - [#12289]) ([zha docs]) ([fan.zha docs]) (new-platform) +- Update plex.py ([@chronm] - [#12157]) ([sensor.plex docs]) +- Support MQTT Lock discovery ([@molobrakos] - [#13303]) ([mqtt docs]) ([lock.mqtt docs]) +- Adding a discoverable Samsung Syncthru Printer sensor platform ([@nielstron] - [#13134]) ([sensor.syncthru docs]) (new-platform) +- Use hue/sat as internal light color interface ([@armills] - [#11288]) ([light docs]) +- Superfluous None ([@dgomes] - [#13326]) ([sensor.filter docs]) +- pytest 3.4.0 cache gitignore ([@OttoWinter] - [#13308]) +- Add trafikverket_weatherstation sensor platform ([@Qxlkdr] - [#12115]) ([sensor.trafikverket_weatherstation docs]) (new-platform) +- zha: catch the exception from bellows if a device isn't available. ([@perosb] - [#13314]) ([light.zha docs]) ([switch.zha docs]) +- Plex unavailable client cleanup ([@ryanm101] - [#13156]) ([media_player.plex docs]) +- Perform check_config service in current process ([@kellerza] - [#13017]) +- Added switch for DoorBird second relay ([@sjvc] - [#13339]) ([doorbird docs]) ([switch.doorbird docs]) +- Add min and max price as attribute for Tibber sensor ([@danielhiversen] - [#13313]) ([sensor.tibber docs]) +- Bugfix: Zwave set_config_parameter failed when config list contained int ([@turbokongen] - [#13301]) ([zwave docs]) +- Update pyhomematic to 0.1.40 ([@danielperna84] - [#13354]) ([homematic docs]) +- Fix mysensors light turn on hs color ([@MartinHjelmare] - [#13349]) ([light.mysensors docs]) +- Add a polling fallback for Sonos ([@amelchio] - [#13310]) ([media_player.sonos docs]) +- Fix retrieval of track URL into medi_content_id ([@ih8gates] - [#13333]) ([media_player.spotify docs]) +- Homekit Bugfix: Use get instead of indexing ([@maxclaey] - [#13353]) ([homekit docs]) +- Configuration options for IFTTT alarm control panel ([@maxclaey] - [#13352]) ([alarm_control_panel.ifttt docs]) +- Add the possibility to filter on line(s) in Västtrafik Public Transport sensor ([@ThomasSvedberg] - [#13317]) ([sensor.vasttrafik docs]) +- Fix mysensors RGBW ([@MartinHjelmare] - [#13364]) ([light.mysensors docs]) +- Add watt to mysensors switch attributes ([@MartinHjelmare] - [#13370]) +- Mediaroom async ([@dgomes] - [#13321]) ([media_player.mediaroom docs]) +- Add language parameter to darksky sensor ([@cgtobi] - [#13297]) ([sensor.darksky docs]) ([weather.darksky docs]) +- Fixing Egardia 'home armed' state not shown correctly. ([@jeroenterheerdt] - [#13335]) +- Include all config flow translations with backend translations ([@balloob] - [#13394]) +- Avoid breaking change for BMW ConnectedDrive sensors in #12591 ([@gerard33] - [#13380]) ([binary_sensor.bmw_connected_drive docs]) ([lock.bmw_connected_drive docs]) ([sensor.bmw_connected_drive docs]) +- Support setting icon when configuring MQTT entity ([@molobrakos] - [#13304]) ([sensor.mqtt docs]) ([switch.mqtt docs]) +- Enhance mysensors sensor units and icons ([@MartinHjelmare] - [#13365]) ([sensor.mysensors docs]) +- Fix incorrect unit of measurement for precip_intensity. ([@cgtobi] - [#13415]) ([sensor.darksky docs]) (breaking change) +- Fix Sonos playing Sveriges Radio ([@amelchio] - [#13401]) ([media_player.sonos docs]) +- Cache LaMetric devices for offline use ([@PhilRW] - [#13379]) +- Enhance mysensors binary sensor device classes ([@MartinHjelmare] - [#13367]) ([binary_sensor.mysensors docs]) +- Switched to async/await. Bumped pyxeoma version ([@jeradM] - [#13404]) ([camera.xeoma docs]) +- Added default return value for HS_Color ([@cdce8p] - [#13395]) ([homekit docs]) +- Hue: Use the currently active color mode ([@armills] - [#13376]) ([light docs]) ([light.hue docs]) +- Cleanup homematicip_cloud ([@mxworm] - [#13356]) ([homematicip_cloud docs]) ([sensor.homematicip_cloud docs]) +- Add send sticker service to telegram bot ([@syssi] - [#13387]) ([telegram_bot docs]) +- Google assistant sync ([@balloob] - [#13392]) ([cloud docs]) +- Fix current_cover_position ([@cdce8p] - [#13135]) ([cover.template docs]) +- Switched values to downcase. ([@diminishedprime] - [#13406]) +- Cast Integration Cleanup ([@OttoWinter] - [#13275]) ([media_player.cast docs]) +- Security fix & lock for HomeMatic ([@PH89] - [#11980]) ([homematic docs]) ([lock docs]) ([lock.homematic docs]) (breaking change) (new-platform) +- Log invalid templates in script delays ([@amelchio] - [#13423]) +- LimitlessLED hs_color fixes ([@amelchio] - [#13425]) ([light.limitlessled docs]) +- Hyperion: fix typo ([@a-andre] - [#13429]) ([light.hyperion docs]) +- HomeKit: Bugfix & improved logging ([@cdce8p] - [#13431]) ([homekit docs]) +- Improve detection of entity names in templates ([@amelchio] - [#13432]) +- Add version bump script ([@balloob] - [#13447]) +- Add extra check for ESSID field in case there's a wired connection ([@Zepheus] - [#13459]) ([device_tracker docs]) +- Fix encoding errors in mikrotik device tracker ([@bdurrer] - [#13464]) ([device_tracker docs]) +- Hue: Convert XY to HS color if HS not present ([@balloob] - [#13465]) ([light.hue docs]) +- Fix ID (fixes #13444) ([@fabaff] - [#13471]) ([media_player.mpchc docs]) +- Upgrade aiohue and fix race condition ([@balloob] - [#13475]) ([hue docs]) +- version should contain just 'b' not 'beta' ([@balloob] - [#13476]) +- Fix Google Calendar caching when offline ([@PhilRW] - [#13375]) ([calendar.google docs]) +- Homekit: Bugfix Thermostat Fahrenheit support ([@cdce8p] - [#13477]) ([homekit docs]) +- Validate basic customize entries ([@cdce8p] - [#13478]) +- Homekit: Fix security systems ([@cdce8p] - [#13499]) ([homekit docs]) +- python-miio version bumped (Closes: 13449) ([@syssi] - [#13511]) ([fan.xiaomi_miio docs]) ([light.xiaomi_miio docs]) ([remote.xiaomi_miio docs]) ([sensor.xiaomi_miio docs]) ([switch.xiaomi_miio docs]) ([vacuum.xiaomi_miio docs]) +- Fix mysensors light supported features ([@MartinHjelmare] - [#13512]) ([light.mysensors docs]) +- Fix Insteon Leak Sensor ([@teharris1] - [#13515]) +- HomeKit: Fix setting light brightness ([@cdce8p] - [#13518]) ([homekit docs]) +- Construct version pinned ([@syssi] - [#13528]) ([climate.eq3btsmart docs]) ([fan.xiaomi_miio docs]) ([light.xiaomi_miio docs]) ([remote.xiaomi_miio docs]) ([sensor.eddystone_temperature docs]) ([sensor.xiaomi_miio docs]) ([switch.xiaomi_miio docs]) ([vacuum.xiaomi_miio docs]) +- Don't add Falsy items to list #13412 ([@kellerza] - [#13536]) +- Check whitelisted paths #13107 ([@kellerza] - [#13154]) +- Fix FLUX_LED error when no color is set ([@dramamoose] - [#13527]) ([light.flux_led docs]) + +[#11288]: https://github.com/home-assistant/home-assistant/pull/11288 +[#11980]: https://github.com/home-assistant/home-assistant/pull/11980 +[#12115]: https://github.com/home-assistant/home-assistant/pull/12115 +[#12157]: https://github.com/home-assistant/home-assistant/pull/12157 +[#12289]: https://github.com/home-assistant/home-assistant/pull/12289 +[#12417]: https://github.com/home-assistant/home-assistant/pull/12417 +[#12590]: https://github.com/home-assistant/home-assistant/pull/12590 +[#12591]: https://github.com/home-assistant/home-assistant/pull/12591 +[#12652]: https://github.com/home-assistant/home-assistant/pull/12652 +[#12692]: https://github.com/home-assistant/home-assistant/pull/12692 +[#12732]: https://github.com/home-assistant/home-assistant/pull/12732 +[#12761]: https://github.com/home-assistant/home-assistant/pull/12761 +[#12862]: https://github.com/home-assistant/home-assistant/pull/12862 +[#12883]: https://github.com/home-assistant/home-assistant/pull/12883 +[#12917]: https://github.com/home-assistant/home-assistant/pull/12917 +[#12926]: https://github.com/home-assistant/home-assistant/pull/12926 +[#12961]: https://github.com/home-assistant/home-assistant/pull/12961 +[#12967]: https://github.com/home-assistant/home-assistant/pull/12967 +[#12975]: https://github.com/home-assistant/home-assistant/pull/12975 +[#12997]: https://github.com/home-assistant/home-assistant/pull/12997 +[#13000]: https://github.com/home-assistant/home-assistant/pull/13000 +[#13007]: https://github.com/home-assistant/home-assistant/pull/13007 +[#13011]: https://github.com/home-assistant/home-assistant/pull/13011 +[#13017]: https://github.com/home-assistant/home-assistant/pull/13017 +[#13018]: https://github.com/home-assistant/home-assistant/pull/13018 +[#13026]: https://github.com/home-assistant/home-assistant/pull/13026 +[#13029]: https://github.com/home-assistant/home-assistant/pull/13029 +[#13040]: https://github.com/home-assistant/home-assistant/pull/13040 +[#13041]: https://github.com/home-assistant/home-assistant/pull/13041 +[#13043]: https://github.com/home-assistant/home-assistant/pull/13043 +[#13051]: https://github.com/home-assistant/home-assistant/pull/13051 +[#13055]: https://github.com/home-assistant/home-assistant/pull/13055 +[#13066]: https://github.com/home-assistant/home-assistant/pull/13066 +[#13072]: https://github.com/home-assistant/home-assistant/pull/13072 +[#13082]: https://github.com/home-assistant/home-assistant/pull/13082 +[#13084]: https://github.com/home-assistant/home-assistant/pull/13084 +[#13086]: https://github.com/home-assistant/home-assistant/pull/13086 +[#13088]: https://github.com/home-assistant/home-assistant/pull/13088 +[#13093]: https://github.com/home-assistant/home-assistant/pull/13093 +[#13104]: https://github.com/home-assistant/home-assistant/pull/13104 +[#13119]: https://github.com/home-assistant/home-assistant/pull/13119 +[#13120]: https://github.com/home-assistant/home-assistant/pull/13120 +[#13121]: https://github.com/home-assistant/home-assistant/pull/13121 +[#13123]: https://github.com/home-assistant/home-assistant/pull/13123 +[#13124]: https://github.com/home-assistant/home-assistant/pull/13124 +[#13126]: https://github.com/home-assistant/home-assistant/pull/13126 +[#13127]: https://github.com/home-assistant/home-assistant/pull/13127 +[#13128]: https://github.com/home-assistant/home-assistant/pull/13128 +[#13134]: https://github.com/home-assistant/home-assistant/pull/13134 +[#13135]: https://github.com/home-assistant/home-assistant/pull/13135 +[#13137]: https://github.com/home-assistant/home-assistant/pull/13137 +[#13141]: https://github.com/home-assistant/home-assistant/pull/13141 +[#13148]: https://github.com/home-assistant/home-assistant/pull/13148 +[#13150]: https://github.com/home-assistant/home-assistant/pull/13150 +[#13151]: https://github.com/home-assistant/home-assistant/pull/13151 +[#13154]: https://github.com/home-assistant/home-assistant/pull/13154 +[#13156]: https://github.com/home-assistant/home-assistant/pull/13156 +[#13163]: https://github.com/home-assistant/home-assistant/pull/13163 +[#13164]: https://github.com/home-assistant/home-assistant/pull/13164 +[#13167]: https://github.com/home-assistant/home-assistant/pull/13167 +[#13169]: https://github.com/home-assistant/home-assistant/pull/13169 +[#13171]: https://github.com/home-assistant/home-assistant/pull/13171 +[#13173]: https://github.com/home-assistant/home-assistant/pull/13173 +[#13181]: https://github.com/home-assistant/home-assistant/pull/13181 +[#13184]: https://github.com/home-assistant/home-assistant/pull/13184 +[#13190]: https://github.com/home-assistant/home-assistant/pull/13190 +[#13193]: https://github.com/home-assistant/home-assistant/pull/13193 +[#13194]: https://github.com/home-assistant/home-assistant/pull/13194 +[#13204]: https://github.com/home-assistant/home-assistant/pull/13204 +[#13214]: https://github.com/home-assistant/home-assistant/pull/13214 +[#13215]: https://github.com/home-assistant/home-assistant/pull/13215 +[#13218]: https://github.com/home-assistant/home-assistant/pull/13218 +[#13221]: https://github.com/home-assistant/home-assistant/pull/13221 +[#13222]: https://github.com/home-assistant/home-assistant/pull/13222 +[#13225]: https://github.com/home-assistant/home-assistant/pull/13225 +[#13229]: https://github.com/home-assistant/home-assistant/pull/13229 +[#13230]: https://github.com/home-assistant/home-assistant/pull/13230 +[#13231]: https://github.com/home-assistant/home-assistant/pull/13231 +[#13232]: https://github.com/home-assistant/home-assistant/pull/13232 +[#13236]: https://github.com/home-assistant/home-assistant/pull/13236 +[#13240]: https://github.com/home-assistant/home-assistant/pull/13240 +[#13244]: https://github.com/home-assistant/home-assistant/pull/13244 +[#13246]: https://github.com/home-assistant/home-assistant/pull/13246 +[#13253]: https://github.com/home-assistant/home-assistant/pull/13253 +[#13264]: https://github.com/home-assistant/home-assistant/pull/13264 +[#13266]: https://github.com/home-assistant/home-assistant/pull/13266 +[#13272]: https://github.com/home-assistant/home-assistant/pull/13272 +[#13275]: https://github.com/home-assistant/home-assistant/pull/13275 +[#13281]: https://github.com/home-assistant/home-assistant/pull/13281 +[#13282]: https://github.com/home-assistant/home-assistant/pull/13282 +[#13283]: https://github.com/home-assistant/home-assistant/pull/13283 +[#13285]: https://github.com/home-assistant/home-assistant/pull/13285 +[#13287]: https://github.com/home-assistant/home-assistant/pull/13287 +[#13288]: https://github.com/home-assistant/home-assistant/pull/13288 +[#13289]: https://github.com/home-assistant/home-assistant/pull/13289 +[#13290]: https://github.com/home-assistant/home-assistant/pull/13290 +[#13291]: https://github.com/home-assistant/home-assistant/pull/13291 +[#13292]: https://github.com/home-assistant/home-assistant/pull/13292 +[#13294]: https://github.com/home-assistant/home-assistant/pull/13294 +[#13295]: https://github.com/home-assistant/home-assistant/pull/13295 +[#13297]: https://github.com/home-assistant/home-assistant/pull/13297 +[#13301]: https://github.com/home-assistant/home-assistant/pull/13301 +[#13303]: https://github.com/home-assistant/home-assistant/pull/13303 +[#13304]: https://github.com/home-assistant/home-assistant/pull/13304 +[#13308]: https://github.com/home-assistant/home-assistant/pull/13308 +[#13310]: https://github.com/home-assistant/home-assistant/pull/13310 +[#13313]: https://github.com/home-assistant/home-assistant/pull/13313 +[#13314]: https://github.com/home-assistant/home-assistant/pull/13314 +[#13317]: https://github.com/home-assistant/home-assistant/pull/13317 +[#13321]: https://github.com/home-assistant/home-assistant/pull/13321 +[#13326]: https://github.com/home-assistant/home-assistant/pull/13326 +[#13333]: https://github.com/home-assistant/home-assistant/pull/13333 +[#13335]: https://github.com/home-assistant/home-assistant/pull/13335 +[#13339]: https://github.com/home-assistant/home-assistant/pull/13339 +[#13349]: https://github.com/home-assistant/home-assistant/pull/13349 +[#13352]: https://github.com/home-assistant/home-assistant/pull/13352 +[#13353]: https://github.com/home-assistant/home-assistant/pull/13353 +[#13354]: https://github.com/home-assistant/home-assistant/pull/13354 +[#13356]: https://github.com/home-assistant/home-assistant/pull/13356 +[#13364]: https://github.com/home-assistant/home-assistant/pull/13364 +[#13365]: https://github.com/home-assistant/home-assistant/pull/13365 +[#13367]: https://github.com/home-assistant/home-assistant/pull/13367 +[#13370]: https://github.com/home-assistant/home-assistant/pull/13370 +[#13375]: https://github.com/home-assistant/home-assistant/pull/13375 +[#13376]: https://github.com/home-assistant/home-assistant/pull/13376 +[#13379]: https://github.com/home-assistant/home-assistant/pull/13379 +[#13380]: https://github.com/home-assistant/home-assistant/pull/13380 +[#13387]: https://github.com/home-assistant/home-assistant/pull/13387 +[#13392]: https://github.com/home-assistant/home-assistant/pull/13392 +[#13394]: https://github.com/home-assistant/home-assistant/pull/13394 +[#13395]: https://github.com/home-assistant/home-assistant/pull/13395 +[#13401]: https://github.com/home-assistant/home-assistant/pull/13401 +[#13404]: https://github.com/home-assistant/home-assistant/pull/13404 +[#13406]: https://github.com/home-assistant/home-assistant/pull/13406 +[#13415]: https://github.com/home-assistant/home-assistant/pull/13415 +[#13423]: https://github.com/home-assistant/home-assistant/pull/13423 +[#13425]: https://github.com/home-assistant/home-assistant/pull/13425 +[#13429]: https://github.com/home-assistant/home-assistant/pull/13429 +[#13431]: https://github.com/home-assistant/home-assistant/pull/13431 +[#13432]: https://github.com/home-assistant/home-assistant/pull/13432 +[#13447]: https://github.com/home-assistant/home-assistant/pull/13447 +[#13459]: https://github.com/home-assistant/home-assistant/pull/13459 +[#13464]: https://github.com/home-assistant/home-assistant/pull/13464 +[#13465]: https://github.com/home-assistant/home-assistant/pull/13465 +[#13471]: https://github.com/home-assistant/home-assistant/pull/13471 +[#13475]: https://github.com/home-assistant/home-assistant/pull/13475 +[#13476]: https://github.com/home-assistant/home-assistant/pull/13476 +[#13477]: https://github.com/home-assistant/home-assistant/pull/13477 +[#13478]: https://github.com/home-assistant/home-assistant/pull/13478 +[#13499]: https://github.com/home-assistant/home-assistant/pull/13499 +[#13511]: https://github.com/home-assistant/home-assistant/pull/13511 +[#13512]: https://github.com/home-assistant/home-assistant/pull/13512 +[#13515]: https://github.com/home-assistant/home-assistant/pull/13515 +[#13518]: https://github.com/home-assistant/home-assistant/pull/13518 +[#13527]: https://github.com/home-assistant/home-assistant/pull/13527 +[#13528]: https://github.com/home-assistant/home-assistant/pull/13528 +[#13536]: https://github.com/home-assistant/home-assistant/pull/13536 +[@BioSehnsucht]: https://github.com/BioSehnsucht +[@DanNixon]: https://github.com/DanNixon +[@FezVrasta]: https://github.com/FezVrasta +[@JensTimmerman]: https://github.com/JensTimmerman +[@Juggels]: https://github.com/Juggels +[@Kane610]: https://github.com/Kane610 +[@MartinHjelmare]: https://github.com/MartinHjelmare +[@OttoWinter]: https://github.com/OttoWinter +[@PH89]: https://github.com/PH89 +[@PhilRW]: https://github.com/PhilRW +[@Qxlkdr]: https://github.com/Qxlkdr +[@ThomasSvedberg]: https://github.com/ThomasSvedberg +[@Zepheus]: https://github.com/Zepheus +[@a-andre]: https://github.com/a-andre +[@a-wolter]: https://github.com/a-wolter +[@amelchio]: https://github.com/amelchio +[@andreipop2005]: https://github.com/andreipop2005 +[@andrey-git]: https://github.com/andrey-git +[@armills]: https://github.com/armills +[@balloob]: https://github.com/balloob +[@bdurrer]: https://github.com/bdurrer +[@c727]: https://github.com/c727 +[@cburgess]: https://github.com/cburgess +[@cdce8p]: https://github.com/cdce8p +[@cgtobi]: https://github.com/cgtobi +[@chronm]: https://github.com/chronm +[@clementhk]: https://github.com/clementhk +[@danielhiversen]: https://github.com/danielhiversen +[@danielperna84]: https://github.com/danielperna84 +[@dgomes]: https://github.com/dgomes +[@diminishedprime]: https://github.com/diminishedprime +[@dramamoose]: https://github.com/dramamoose +[@engrbm87]: https://github.com/engrbm87 +[@fabaff]: https://github.com/fabaff +[@gerard33]: https://github.com/gerard33 +[@hthiery]: https://github.com/hthiery +[@igorbernstein2]: https://github.com/igorbernstein2 +[@ih8gates]: https://github.com/ih8gates +[@jcconnell]: https://github.com/jcconnell +[@jeradM]: https://github.com/jeradM +[@jeroenterheerdt]: https://github.com/jeroenterheerdt +[@jesserockz]: https://github.com/jesserockz +[@karlkar]: https://github.com/karlkar +[@kellerza]: https://github.com/kellerza +[@kuzin2006]: https://github.com/kuzin2006 +[@maddox]: https://github.com/maddox +[@markperdue]: https://github.com/markperdue +[@maxclaey]: https://github.com/maxclaey +[@maxlaverse]: https://github.com/maxlaverse +[@molobrakos]: https://github.com/molobrakos +[@mxworm]: https://github.com/mxworm +[@nielstron]: https://github.com/nielstron +[@perosb]: https://github.com/perosb +[@pvizeli]: https://github.com/pvizeli +[@reefab]: https://github.com/reefab +[@ryanm101]: https://github.com/ryanm101 +[@rytilahti]: https://github.com/rytilahti +[@scop]: https://github.com/scop +[@sjvc]: https://github.com/sjvc +[@smurfix]: https://github.com/smurfix +[@syssi]: https://github.com/syssi +[@teharris1]: https://github.com/teharris1 +[@the-glu]: https://github.com/the-glu +[@thrawnarn]: https://github.com/thrawnarn +[@timmo001]: https://github.com/timmo001 +[@turbokongen]: https://github.com/turbokongen +[@uchagani]: https://github.com/uchagani +[@vandenberghev]: https://github.com/vandenberghev +[alarm_control_panel.ifttt docs]: /components/alarm_control_panel.ifttt/ +[binary_sensor.bmw_connected_drive docs]: /components/binary_sensor.bmw_connected_drive/ +[binary_sensor.deconz docs]: /components/binary_sensor.deconz/ +[binary_sensor.mysensors docs]: /components/binary_sensor.mysensors/ +[binary_sensor.trend docs]: /components/binary_sensor.trend/ +[binary_sensor.workday docs]: /components/binary_sensor.workday/ +[bmw_connected_drive docs]: /components/bmw_connected_drive/ +[calendar.caldav docs]: /components/calendar.caldav/ +[calendar.google docs]: /components/calendar.google/ +[calendar.todoist docs]: /components/calendar.todoist/ +[camera.onvif docs]: /components/camera.onvif/ +[camera.xeoma docs]: /components/camera.xeoma/ +[climate.ecobee docs]: /components/climate.ecobee/ +[climate.eq3btsmart docs]: /components/climate.eq3btsmart/ +[climate.sensibo docs]: /components/climate.sensibo/ +[cloud docs]: /components/cloud/ +[cover.group docs]: /components/cover.group/ +[cover.template docs]: /components/cover.template/ +[deconz docs]: /components/deconz/ +[device_tracker docs]: /components/device_tracker/ +[doorbird docs]: /components/doorbird/ +[downloader docs]: /components/downloader/ +[ecobee docs]: /components/ecobee/ +[fan.xiaomi_miio docs]: /components/fan.xiaomi_miio/ +[fan.zha docs]: /components/fan.zha/ +[hassio docs]: /components/hassio/ +[history docs]: /components/history/ +[homekit docs]: /components/homekit/ +[homematic docs]: /components/homematic/ +[homematicip docs]: /components/homematicip/ +[homematicip_cloud docs]: /components/homematicip_cloud/ +[http docs]: /components/http/ +[hue docs]: /components/hue/ +[image_processing.opencv docs]: /components/image_processing.opencv/ +[light docs]: /components/light/ +[light.deconz docs]: /components/light.deconz/ +[light.flux_led docs]: /components/light.flux_led/ +[light.hue docs]: /components/light.hue/ +[light.hyperion docs]: /components/light.hyperion/ +[light.iglo docs]: /components/light.iglo/ +[light.limitlessled docs]: /components/light.limitlessled/ +[light.mysensors docs]: /components/light.mysensors/ +[light.mystrom docs]: /components/light.mystrom/ +[light.xiaomi_miio docs]: /components/light.xiaomi_miio/ +[light.zha docs]: /components/light.zha/ +[lock docs]: /components/lock/ +[lock.bmw_connected_drive docs]: /components/lock.bmw_connected_drive/ +[lock.homematic docs]: /components/lock.homematic/ +[lock.mqtt docs]: /components/lock.mqtt/ +[logbook docs]: /components/logbook/ +[media_extractor docs]: /components/media_extractor/ +[media_player.bluesound docs]: /components/media_player.bluesound/ +[media_player.cast docs]: /components/media_player.cast/ +[media_player.channels docs]: /components/media_player.channels/ +[media_player.kodi docs]: /components/media_player.kodi/ +[@NovapaX]: https://github.com/NovapaX +[media_player.mediaroom docs]: /components/media_player.mediaroom/ +[media_player.mpchc docs]: /components/media_player.mpchc/ +[media_player.philips_js docs]: /components/media_player.philips_js/ +[media_player.plex docs]: /components/media_player.plex/ +[media_player.songpal docs]: /components/media_player.songpal/ +[media_player.sonos docs]: /components/media_player.sonos/ +[media_player.spotify docs]: /components/media_player.spotify/ +[mqtt docs]: /components/mqtt/ +[mysensors docs]: /components/mysensors/ +[nest docs]: /components/nest/ +[notify docs]: /components/notify/ +[remote.xiaomi_miio docs]: /components/remote.xiaomi_miio/ +[scene.deconz docs]: /components/scene.deconz/ +[sensor.bmw_connected_drive docs]: /components/sensor.bmw_connected_drive/ +[sensor.crimereports docs]: /components/sensor.crimereports/ +[sensor.darksky docs]: /components/sensor.darksky/ +[sensor.deconz docs]: /components/sensor.deconz/ +[sensor.deutsche_bahn docs]: /components/sensor.deutsche_bahn/ +[sensor.eddystone_temperature docs]: /components/sensor.eddystone_temperature/ +[sensor.filter docs]: /components/sensor.filter/ +[sensor.foobot docs]: /components/sensor.foobot/ +[sensor.glances docs]: /components/sensor.glances/ +[sensor.homematic docs]: /components/sensor.homematic/ +[sensor.homematicip docs]: /components/sensor.homematicip/ +[sensor.homematicip_cloud docs]: /components/sensor.homematicip_cloud/ +[sensor.lacrosse docs]: /components/sensor.lacrosse/ +[sensor.mqtt docs]: /components/sensor.mqtt/ +[sensor.mysensors docs]: /components/sensor.mysensors/ +[sensor.plex docs]: /components/sensor.plex/ +[sensor.smappee docs]: /components/sensor.smappee/ +[sensor.spotcrime docs]: /components/sensor.spotcrime/ +[sensor.sql docs]: /components/sensor.sql/ +[sensor.syncthru docs]: /components/sensor.syncthru/ +[sensor.systemmonitor docs]: /components/sensor.systemmonitor/ +[sensor.template docs]: /components/sensor.template/ +[sensor.tibber docs]: /components/sensor.tibber/ +[sensor.trafikverket_weatherstation docs]: /components/sensor.trafikverket_weatherstation/ +[sensor.vasttrafik docs]: /components/sensor.vasttrafik/ +[sensor.wunderground docs]: /components/sensor.wunderground/ +[sensor.xiaomi_miio docs]: /components/sensor.xiaomi_miio/ +[spc docs]: /components/spc/ +[switch.doorbird docs]: /components/switch.doorbird/ +[switch.edimax docs]: /components/switch.edimax/ +[switch.mqtt docs]: /components/switch.mqtt/ +[switch.vesync docs]: /components/switch.vesync/ +[switch.xiaomi_miio docs]: /components/switch.xiaomi_miio/ +[switch.zha docs]: /components/switch.zha/ +[telegram_bot docs]: /components/telegram_bot/ +[upcloud docs]: /components/upcloud/ +[vacuum.xiaomi_miio docs]: /components/vacuum.xiaomi_miio/ +[weather.darksky docs]: /components/weather.darksky/ +[websocket_api docs]: /components/websocket_api/ +[zeroconf docs]: /components/zeroconf/ +[zha docs]: /components/zha/ +[zwave docs]: /components/zwave/ +[#13574]: https://github.com/home-assistant/home-assistant/pull/13574 +[#13587]: https://github.com/home-assistant/home-assistant/pull/13587 +[#13617]: https://github.com/home-assistant/home-assistant/pull/13617 +[@MartinHjelmare]: https://github.com/MartinHjelmare +[@armills]: https://github.com/armills +[@cdce8p]: https://github.com/cdce8p +[homekit docs]: /components/homekit/ +[light.mqtt_json docs]: /components/light.mqtt_json/ +[sensor.mysensors docs]: /components/sensor.mysensors/ diff --git a/source/_posts/2018-04-12-ubiquiti-and-home-assistant.markdown b/source/_posts/2018-04-12-ubiquiti-and-home-assistant.markdown new file mode 100644 index 0000000000..045f30c196 --- /dev/null +++ b/source/_posts/2018-04-12-ubiquiti-and-home-assistant.markdown @@ -0,0 +1,37 @@ +--- +layout: post +title: "Home Assistant 🤝 Ubiquiti Networks" +description: "Ubiquiti Networks has hired Paulus Schoutsen, the founder of Home Assistant, to support Home Assistant’s goals of making Home Assistant easier to configure for users, improving the integration with device makers and making it easier to create, maintain and evolve integrations." +date: 2018-04-12 00:01:00 +date_formatted: "April 12, 2018" +author: Paulus Schoutsen +author_twitter: balloob +comments: true +categories: Announcements +og_image: /images/blog/2018-04-ubiquiti-and-home-assistant/paulus.jpg +--- + +TL;DR: Ubiquiti Networks has hired Paulus Schoutsen, the founder of Home Assistant, to support Home Assistant’s goals of making Home Assistant easier to configure for users, improving the integration with device makers and making it easier to create, maintain and evolve integrations. + +Home Assistant is an open source project that thus far has been run by people in their spare time. In the last four and a half years it has grown from just me building a tiny framework with a handful of integrations to having our own operating system, over a 1000 integrations, superb performance, contributions by over 900 people, and our main Docker image has been pulled over 10 million times! + +Observing this growth and passionate community, Ubiquiti Networks approached us. + +Ubiquiti Networks currently focuses on 3 main technologies: high-capacity distributed Internet access, unified information technology, and next-gen consumer electronics for home and personal use. Their enterprise quality combined with their affordability has made them very popular among our users. They also share another passion of ours: trying to avoid clouds. Take for example their [UniFi Video] IP surveillance solution: it is a completely local hosted solution. + +They recognize great potential in Home Assistant becoming the defacto platform for the home: fast, open source and local. They also want to deepen the integration of Ubiquiti Networks products in Home Assistant and may even support hosting Home Assistant instances on their hardware. + +And so we have agreed that I (Paulus, founder Home Assistant) will join Ubiquiti Networks as a full time employee to focus on growing Home Assistant. I’ll now be able to devote my full energy to making Home Assistant easier to configure for users, improving the integration with device makers and making it easier to create, maintain and evolve integrations. + +Ubiquiti Networks will not acquire any ownership of Home Assistant. We will remain an independent and open source project, just improving faster than ever with the support of Ubiquiti Networks. + +I’m very excited about this opportunity and 2018 will be a really really great year for Home Assistant! + +

    + Photo of Paulus, the founder of Home Assistant, standing in front of a Ubiquiti Networks logo wearing a Home Assistant t-shirt. + Paulus Schoutsen, founder of Home Assistant, at the NYC Ubiquiti office. +

    + +[UniFi Video]: https://www.ubnt.com/unifi-video/unifi-video-camera-g3/#unifi-video-camera-hybrid-technology diff --git a/source/_posts/2018-04-14-release-67.markdown b/source/_posts/2018-04-14-release-67.markdown new file mode 100644 index 0000000000..843cce88e6 --- /dev/null +++ b/source/_posts/2018-04-14-release-67.markdown @@ -0,0 +1,446 @@ +--- +layout: post +title: "0.67: Mastodon, Tahoma switches, Nanoleaf Aurora Light Panels" +description: "Security fixes and performance improvements 😅" +date: 2018-04-13 00:01:00 +date_formatted: "April 13, 2018" +author: Paulus Schoutsen +author_twitter: balloob +comments: true +categories: Release-Notes +og_image: /images/blog/2018-04-0.67/components.png +--- + + + +Release 0.67 is here! In case you missed [the announcement from yesterday][ann-ubiquiti], Ubiquiti is paying me to write these release notes. Ooooooh yeah. With more time on my hands I'm going to be focusing on major improvements that we have been postponing for a while, first up will be a user system. + +This release includes a security fix. The error log was accessible via the API without requiring authentication in previous releases. Although not a leak on it's own, combined with a faulty component that would log sensitive information to the error log could lead to that being exposed (we don't know of any component that does this). Thanks to [Matt Hamilton](https://github.com/Eriner) for disclosing this issue to us. + +## {% linkable_title New Platforms %} + +- Adds folder_watcher component ([@robmarkcole] - [#12918]) ([folder_watcher docs]) (new-platform) +- Add FreeDNS component ([@bdurrer] - [#13526]) ([freedns docs]) (new-platform) +- Google Maps location sharing device tracker ([@michaelarnauts] - [#12301]) ([device_tracker.google_maps docs]) (new-platform) +- Added Waze travel time sensor ([@Myrddyn1] - [#12387]) ([sensor.waze_travel_time docs]) (new-platform) +- Added switch component to Amcrest IP Camera. ([@adpriebe] - [#12992]) ([amcrest docs]) ([switch.amcrest docs]) (new-platform) +- Add mastodon ([@fabaff] - [#13441]) ([notify docs]) (new-platform) +- Tahoma switches ([@ikucuze] - [#13636]) ([tahoma docs]) ([switch.tahoma docs]) (new-platform) +- Add support for Nanoleaf Aurora Light Panels ([@Oro] - [#13456]) ([light.nanoleaf_aurora docs]) (new-platform) + +## {% linkable_title Release 0.67.1 - April 17 %} + +- Fix Gogogate2 'available' attribute ([@dlbroadfoot] - [#13728]) +- Fix so it is possible to ignore discovered config entry handlers ([@Kane610] - [#13741]) +- Prevent vesync doing I/O in event loop ([@balloob] - [#13862]) ([switch.vesync docs]) +- Fix #13846 Double underscore in bluetooth address ([@aav7fl] - [#13884]) ([device_tracker docs]) +- Fix race condition for component loaded before listening ([@balloob] - [#13887]) ([config docs]) +- Missing property decorator added ([@syssi] - [#13889]) ([fan.xiaomi_miio docs]) +- Fix call to parent broadlink switch ([@Danielhiversen] - [#13906]) ([switch.broadlink docs]) +- Import operation modes from air humidifier ([@syssi] - [#13908]) ([fan.xiaomi_miio docs]) +- Upgrade pyqwikswitch to 0.71 ([@kellerza] - [#13920]) ([qwikswitch docs]) +- Upgrade somecomfort to 0.5.2 ([@balloob] - [#13940]) ([climate.honeywell docs]) +- Update pyhydroquebec to 2.2.2 ([@titilambert] - [#13946]) ([sensor.hydroquebec docs]) +- Update pyfido to 2.1.1 ([@titilambert] - [#13947]) ([sensor.fido docs]) +- Bumped pypollencom to 1.1.2 ([@bachya] - [#13959]) ([sensor.pollen docs]) +- Revert "Upgrade pyqwikswitch to 0.71 ([@balloob] - [#13920]) ([qwikswitch docs]) + +## {% linkable_title If you need help... %} + +...don't hesitate to use our very active [forums](https://community.home-assistant.io/) or join us for a little [chat](https://discord.gg/c5DvZ4e). The release notes have comments enabled but it's preferred if you use the former communication channels. Thanks. + +## {% linkable_title Reporting Issues %} + +Experiencing issues introduced by this release? Please report them in our [issue tracker](https://github.com/home-assistant/home-assistant/issues). Make sure to fill in all fields of the issue template. + + +## {% linkable_title Breaking Changes %} + +- Updates default Pilight port number ([@frenck] - [#13419]) ([pilight docs]) (breaking change) +- Update to new "b2vapi" of BMW ConnectedDrive ([@ChristianKuehnel] - [#13305]) ([bmw_connected_drive docs]) ([binary_sensor.bmw_connected_drive docs]) ([lock.bmw_connected_drive docs]) ([sensor.bmw_connected_drive docs]) (breaking change) +- Remove MercedesME component ([@ReneNulschDE] - [#13538]) ([device_tracker docs]) ([mercedesme docs]) ([binary_sensor.mercedesme docs]) ([sensor.mercedesme docs]) (breaking change) +- Channel up and down for webostv ([@stephanerosi] - [#13624]) ([media_player.webostv docs]) (breaking change) +- Add media type separation for video/movie ([@tadly] - [#13612]) (breaking change) +- Added ENTITY_ID_FORMAT import and set entity_id in __init__ ([@timmo001] - [#13642]) ([switch.broadlink docs]) (breaking change) + +## {% linkable_title All changes %} + +- Updates default Pilight port number ([@frenck] - [#13419]) ([pilight docs]) (breaking change) +- Upgrade mypy to 0.580 ([@fabaff] - [#13420]) +- Update to new "b2vapi" of BMW ConnectedDrive ([@ChristianKuehnel] - [#13305]) ([bmw_connected_drive docs]) ([binary_sensor.bmw_connected_drive docs]) ([lock.bmw_connected_drive docs]) ([sensor.bmw_connected_drive docs]) (breaking change) +- Add code owner for Manual Alarm with MQTT Control ([@colinodell] - [#13438]) +- QNAP updates ([@colinodell] - [#13435]) ([sensor.qnap docs]) +- Xiaomi MiIO Fan: Xiaomi Air Humidifier integration ([@syssi] - [#12627]) ([fan.xiaomi_miio docs]) +- Bump songpal version, fixes lots of issues mentioned in #13022 ([@rytilahti] - [#13440]) ([media_player.songpal docs]) +- Removed the google home warning from emulated_hue ([@mf-social] - [#13436]) +- Fixing odometer to display km ([@alandtse] - [#13427]) ([sensor.tesla docs]) +- Upgrade keyring to 12.0.0 and keyrings.alt to 3.0 ([@fabaff] - [#13452]) +- Upgrade aiohttp to 3.1.0 ([@fabaff] - [#13451]) +- Qwikswitch async & updates ([@kellerza] - [#12641]) ([qwikswitch docs]) ([light.qwikswitch docs]) ([switch.qwikswitch docs]) +- Make Telnet Switch value template optional ([@DanNixon] - [#13433]) ([switch.telnet docs]) +- Update yeelightsunflower to 0.0.10 ([@lindsaymarkward] - [#13448]) +- Add more info to issue template ([@c727] - [#12955]) +- [RFC] Update issue template ([@amelchio] - [#12989]) +- Update total_connect_client to 0.17 for Honeywell L5100-WiFi Support ([@phileaton] - [#13473]) ([alarm_control_panel.totalconnect docs]) +- Upgrade python-mystrom to 0.4.2 ([@fabaff] - [#13485]) ([light.mystrom docs]) ([switch.mystrom docs]) +- New service added to control the power mode of the yeelight ([@syssi] - [#13267]) ([light.yeelight docs]) +- Upgrade slacker to 0.9.65 ([@fabaff] - [#13496]) ([notify docs]) +- Adds template function state_attr to get attribute from a state ([@Nossnevs] - [#13378]) +- Upgrade aiohttp to 3.1.1 ([@fabaff] - [#13510]) +- Update tradfri v5 ([@lwis] - [#11187]) ([tradfri docs]) ([light.tradfri docs]) ([sensor.tradfri docs]) +- Fix typos and update link (fixes #13520) ([@fabaff] - [#13529]) +- Tradfri - unique_id's and color_temp support for rgb-bulbs ([@NovapaX] - [#13531]) ([light.tradfri docs]) +- Qwikswitch async refactor & sensor ([@kellerza] - [#13509]) ([qwikswitch docs]) ([light.qwikswitch docs]) ([sensor.qwikswitch docs]) ([switch.qwikswitch docs]) (new-platform) +- Adds folder_watcher component ([@robmarkcole] - [#12918]) ([folder_watcher docs]) (new-platform) +- Update rflink to 0.0.37 ([@olskar] - [#12603]) ([rflink docs]) +- Added file path validity checks to file sensor ([@FrederikBolding] - [#12505]) ([sensor.file docs]) +- Allow for overriding the DoorBird push notification URL in configuration ([@Klikini] - [#13268]) ([doorbird docs]) +- Convert Hue to always use config entries ([@balloob] - [#13034]) ([hue docs]) +- Implement thermostat support for Alexa ([@trisk] - [#13340]) ([alexa docs]) +- deCONZ config entry ([@Kane610] - [#13402]) ([deconz docs]) +- Remove andrey-git from requirements monitoring ([@andrey-git] - [#13547]) +- Fix BMW device tracker toggling state if vehicle tracking is disabled ([@ChristianKuehnel] - [#12999]) ([device_tracker.bmw_connected_drive docs]) +- Xiaomi MiIO Switch: Support for the Xiaomi Chuangmi Plug V3 ([@syssi] - [#13271]) ([switch.xiaomi_miio docs]) +- Add FreeDNS component ([@bdurrer] - [#13526]) ([freedns docs]) (new-platform) +- Update pylint to 1.8.3 ([@scop] - [#13544]) +- Google Maps location sharing device tracker ([@michaelarnauts] - [#12301]) ([device_tracker.google_maps docs]) (new-platform) +- Check_config: Handle numbers correctly when printing config ([@hAmpzter] - [#13377]) +- Add support for Canary Flex ([@snjoetw] - [#13280]) ([canary docs]) ([sensor.canary docs]) +- Fixes #12758. Try other cameras even if one fails to initialize ([@PhracturedBlue] - [#13276]) ([amcrest docs]) +- Added HassOpenCover and HassCloseCover intents ([@tschmidty69] - [#13372]) ([conversation docs]) ([cover docs]) +- rfxtrx lib 0.22.0 ([@Danielhiversen] - [#13576]) ([rfxtrx docs]) +- xiaomi lib upgrade ([@Danielhiversen] - [#13577]) ([xiaomi_aqara docs]) +- Remove MercedesME component ([@ReneNulschDE] - [#13538]) ([device_tracker docs]) ([mercedesme docs]) ([binary_sensor.mercedesme docs]) ([sensor.mercedesme docs]) (breaking change) +- Added Waze travel time sensor ([@Myrddyn1] - [#12387]) ([sensor.waze_travel_time docs]) (new-platform) +- Added switch component to Amcrest IP Camera. ([@adpriebe] - [#12992]) ([amcrest docs]) ([switch.amcrest docs]) (new-platform) +- Upgrade pyhydroquebec 2.2.1 ([@titilambert] - [#13586]) ([sensor.hydroquebec docs]) +- Add mastodon ([@fabaff] - [#13441]) ([notify docs]) (new-platform) +- Added support for requesting RSSI values from Bluetooth devices ([@FrederikBolding] - [#12458]) ([device_tracker.bluetooth_tracker docs]) +- Fix mysensors update callback ([@MartinHjelmare] - [#13602]) ([mysensors docs]) +- Broadlink ([@Danielhiversen] - [#13585]) ([sensor.broadlink docs]) ([switch.broadlink docs]) +- Fix IMAP email message_data ([@zhaokoh] - [#13606]) ([sensor.imap_email_content docs]) +- Re-add group polling as a fallback for observation ([@lwis] - [#13613]) ([light.tradfri docs]) +- Unflake folder watcher test ([@balloob] - [#13569]) +- Make mysensors updates and platform setup async ([@MartinHjelmare] - [#13603]) +- Use 0/1 for raspberry pi cover GPIO writes rather than true/false ([@fezfox] - [#13610]) ([cover.rpi_gpio docs]) +- Fix Hue error logging ([@balloob] - [#13616]) ([hue docs]) +- Bugfix for tradfri to correctly execute Command. ([@lwis] - [#13618]) ([light.tradfri docs]) +- Hue mireds value is actually 153 not 154 ([@Skaronator] - [#13601]) ([light docs]) +- changed PyTado version ([@wmalgadey] - [#13626]) ([tado docs]) +- Upgrade py-cpuinfo to 4.0.0 ([@fabaff] - [#13629]) ([sensor.cpuspeed docs]) +- Add Switzerland ([@fabaff] - [#13630]) ([binary_sensor.workday docs]) +- Xiaomi Mi WiFi Repeater 2 integration as device tracker ([@syssi] - [#13521]) +- Upgrade youtube_dl to 2018.04.03 ([@fabaff] - [#13647]) ([media_extractor docs]) +- Update plex.py ([@chronm] - [#13659]) ([sensor.plex docs]) +- Always enable config entries & remove config_entry_example ([@balloob] - [#13663]) ([config docs]) +- Add missing service docs for hs_color ([@armills] - [#13667]) +- Add regex functions as templating helpers ([@mountainsandcode] - [#13631]) +- Channel up and down for webostv ([@stephanerosi] - [#13624]) ([media_player.webostv docs]) (breaking change) +- Added headers configuration variable to notify.rest component ([@5LICK] - [#13674]) ([notify docs]) +- Spelling fixes ([@scop] - [#13681]) ([device_tracker docs]) ([smappee docs]) ([alarm_control_panel.ifttt docs]) ([climate.nest docs]) ([remote.xiaomi_miio docs]) +- Xiaomi MiIO Light: White Philips Candle Light support ([@syssi] - [#13682]) ([light.xiaomi_miio docs]) +- Bugfixes HomeKit covers, lights ([@cdce8p] - [#13689]) ([homekit docs]) +- Minor style changes, cleanup ([@cdce8p] - [#13654]) ([homekit docs]) +- Bugfix: Zwave Print_node to logfile instead of console ([@turbokongen] - [#13302]) ([zwave docs]) +- Update HAP-python to 1.1.8 ([@cdce8p] - [#13563]) ([homekit docs]) +- Update ha-philips_js to 0.0.3 ([@danielperna84] - [#13702]) ([media_player.philips_js docs]) +- Coverage & Codeowners ([@kellerza] - [#13700]) +- Bump insteonplm to 0.8.6 to fix sensor message handling ([@teharris1] - [#13691]) ([insteon_plm docs]) +- Fix asuswrt ap mode failure ([@shuaiger] - [#13693]) ([device_tracker docs]) +- Support color temperature in Homekit ([@morberg] - [#13658]) ([homekit docs]) +- Remove unused CONF_WATCHERS ([@robmarkcole] - [#13678]) ([folder_watcher docs]) +- Add media type separation for video/movie ([@tadly] - [#13612]) (breaking change) +- Adding configration to disable ip address as a requirement Fixes: #13399 ([@PlanetJ] - [#13692]) ([device_tracker docs]) +- Tahoma switches ([@ikucuze] - [#13636]) ([tahoma docs]) ([switch.tahoma docs]) (new-platform) +- Send XY color for non-osram hue bulbs ([@armills] - [#13665]) ([light.hue docs]) +- Update AbodePy version to 0.12.3 ([@MisterWil] - [#13709]) ([abode docs]) +- Enable autodiscovery for mqtt cameras ([@jmtatsch] - [#13697]) ([mqtt docs]) ([camera.mqtt docs]) +- Added ENTITY_ID_FORMAT import and set entity_id in __init__ ([@timmo001] - [#13642]) ([switch.broadlink docs]) (breaking change) +- Fix #10175 ([@pschmitt] - [#13713]) ([media_player.liveboxplaytv docs]) +- Add support for Nanoleaf Aurora Light Panels ([@Oro] - [#13456]) ([light.nanoleaf_aurora docs]) (new-platform) +- Added gogogate2 cover ([@dlbroadfoot] - [#13467]) +- Remove vendor lookup for mac addresses ([@balloob] - [#13788]) ([device_tracker docs]) +- iglo hs color fix ([@armills] - [#13808]) ([light.iglo docs]) +- Fix too green color conversion ([@amelchio] - [#13828]) +- Rename from aurora light to nanoleaf_aurora ([@Oro] - [#13831]) ([light.nanoleaf_aurora docs]) +- Channel up/down for LiveTV and next/previous for other apps ([@stephanerosi] - [#13829]) ([media_player.webostv docs]) +- Add authentication to error log endpoint ([@balloob] - [#13836]) ([api docs]) + +[#11187]: https://github.com/home-assistant/home-assistant/pull/11187 +[#12301]: https://github.com/home-assistant/home-assistant/pull/12301 +[#12387]: https://github.com/home-assistant/home-assistant/pull/12387 +[#12458]: https://github.com/home-assistant/home-assistant/pull/12458 +[#12505]: https://github.com/home-assistant/home-assistant/pull/12505 +[#12603]: https://github.com/home-assistant/home-assistant/pull/12603 +[#12627]: https://github.com/home-assistant/home-assistant/pull/12627 +[#12641]: https://github.com/home-assistant/home-assistant/pull/12641 +[#12918]: https://github.com/home-assistant/home-assistant/pull/12918 +[#12955]: https://github.com/home-assistant/home-assistant/pull/12955 +[#12989]: https://github.com/home-assistant/home-assistant/pull/12989 +[#12992]: https://github.com/home-assistant/home-assistant/pull/12992 +[#12999]: https://github.com/home-assistant/home-assistant/pull/12999 +[#13034]: https://github.com/home-assistant/home-assistant/pull/13034 +[#13267]: https://github.com/home-assistant/home-assistant/pull/13267 +[#13268]: https://github.com/home-assistant/home-assistant/pull/13268 +[#13271]: https://github.com/home-assistant/home-assistant/pull/13271 +[#13276]: https://github.com/home-assistant/home-assistant/pull/13276 +[#13280]: https://github.com/home-assistant/home-assistant/pull/13280 +[#13302]: https://github.com/home-assistant/home-assistant/pull/13302 +[#13305]: https://github.com/home-assistant/home-assistant/pull/13305 +[#13340]: https://github.com/home-assistant/home-assistant/pull/13340 +[#13372]: https://github.com/home-assistant/home-assistant/pull/13372 +[#13377]: https://github.com/home-assistant/home-assistant/pull/13377 +[#13378]: https://github.com/home-assistant/home-assistant/pull/13378 +[#13402]: https://github.com/home-assistant/home-assistant/pull/13402 +[#13419]: https://github.com/home-assistant/home-assistant/pull/13419 +[#13420]: https://github.com/home-assistant/home-assistant/pull/13420 +[#13427]: https://github.com/home-assistant/home-assistant/pull/13427 +[#13433]: https://github.com/home-assistant/home-assistant/pull/13433 +[#13435]: https://github.com/home-assistant/home-assistant/pull/13435 +[#13436]: https://github.com/home-assistant/home-assistant/pull/13436 +[#13438]: https://github.com/home-assistant/home-assistant/pull/13438 +[#13440]: https://github.com/home-assistant/home-assistant/pull/13440 +[#13441]: https://github.com/home-assistant/home-assistant/pull/13441 +[#13448]: https://github.com/home-assistant/home-assistant/pull/13448 +[#13451]: https://github.com/home-assistant/home-assistant/pull/13451 +[#13452]: https://github.com/home-assistant/home-assistant/pull/13452 +[#13456]: https://github.com/home-assistant/home-assistant/pull/13456 +[#13467]: https://github.com/home-assistant/home-assistant/pull/13467 +[#13473]: https://github.com/home-assistant/home-assistant/pull/13473 +[#13485]: https://github.com/home-assistant/home-assistant/pull/13485 +[#13496]: https://github.com/home-assistant/home-assistant/pull/13496 +[#13509]: https://github.com/home-assistant/home-assistant/pull/13509 +[#13510]: https://github.com/home-assistant/home-assistant/pull/13510 +[#13521]: https://github.com/home-assistant/home-assistant/pull/13521 +[#13526]: https://github.com/home-assistant/home-assistant/pull/13526 +[#13529]: https://github.com/home-assistant/home-assistant/pull/13529 +[#13531]: https://github.com/home-assistant/home-assistant/pull/13531 +[#13538]: https://github.com/home-assistant/home-assistant/pull/13538 +[#13544]: https://github.com/home-assistant/home-assistant/pull/13544 +[#13547]: https://github.com/home-assistant/home-assistant/pull/13547 +[#13563]: https://github.com/home-assistant/home-assistant/pull/13563 +[#13569]: https://github.com/home-assistant/home-assistant/pull/13569 +[#13576]: https://github.com/home-assistant/home-assistant/pull/13576 +[#13577]: https://github.com/home-assistant/home-assistant/pull/13577 +[#13585]: https://github.com/home-assistant/home-assistant/pull/13585 +[#13586]: https://github.com/home-assistant/home-assistant/pull/13586 +[#13601]: https://github.com/home-assistant/home-assistant/pull/13601 +[#13602]: https://github.com/home-assistant/home-assistant/pull/13602 +[#13603]: https://github.com/home-assistant/home-assistant/pull/13603 +[#13606]: https://github.com/home-assistant/home-assistant/pull/13606 +[#13610]: https://github.com/home-assistant/home-assistant/pull/13610 +[#13612]: https://github.com/home-assistant/home-assistant/pull/13612 +[#13613]: https://github.com/home-assistant/home-assistant/pull/13613 +[#13616]: https://github.com/home-assistant/home-assistant/pull/13616 +[#13618]: https://github.com/home-assistant/home-assistant/pull/13618 +[#13624]: https://github.com/home-assistant/home-assistant/pull/13624 +[#13626]: https://github.com/home-assistant/home-assistant/pull/13626 +[#13629]: https://github.com/home-assistant/home-assistant/pull/13629 +[#13630]: https://github.com/home-assistant/home-assistant/pull/13630 +[#13631]: https://github.com/home-assistant/home-assistant/pull/13631 +[#13636]: https://github.com/home-assistant/home-assistant/pull/13636 +[#13642]: https://github.com/home-assistant/home-assistant/pull/13642 +[#13647]: https://github.com/home-assistant/home-assistant/pull/13647 +[#13654]: https://github.com/home-assistant/home-assistant/pull/13654 +[#13658]: https://github.com/home-assistant/home-assistant/pull/13658 +[#13659]: https://github.com/home-assistant/home-assistant/pull/13659 +[#13663]: https://github.com/home-assistant/home-assistant/pull/13663 +[#13665]: https://github.com/home-assistant/home-assistant/pull/13665 +[#13667]: https://github.com/home-assistant/home-assistant/pull/13667 +[#13674]: https://github.com/home-assistant/home-assistant/pull/13674 +[#13678]: https://github.com/home-assistant/home-assistant/pull/13678 +[#13681]: https://github.com/home-assistant/home-assistant/pull/13681 +[#13682]: https://github.com/home-assistant/home-assistant/pull/13682 +[#13689]: https://github.com/home-assistant/home-assistant/pull/13689 +[#13691]: https://github.com/home-assistant/home-assistant/pull/13691 +[#13692]: https://github.com/home-assistant/home-assistant/pull/13692 +[#13693]: https://github.com/home-assistant/home-assistant/pull/13693 +[#13697]: https://github.com/home-assistant/home-assistant/pull/13697 +[#13700]: https://github.com/home-assistant/home-assistant/pull/13700 +[#13702]: https://github.com/home-assistant/home-assistant/pull/13702 +[#13709]: https://github.com/home-assistant/home-assistant/pull/13709 +[#13713]: https://github.com/home-assistant/home-assistant/pull/13713 +[#13788]: https://github.com/home-assistant/home-assistant/pull/13788 +[#13808]: https://github.com/home-assistant/home-assistant/pull/13808 +[#13828]: https://github.com/home-assistant/home-assistant/pull/13828 +[#13829]: https://github.com/home-assistant/home-assistant/pull/13829 +[#13831]: https://github.com/home-assistant/home-assistant/pull/13831 +[#13836]: https://github.com/home-assistant/home-assistant/pull/13836 +[@5LICK]: https://github.com/5LICK +[@ChristianKuehnel]: https://github.com/ChristianKuehnel +[@DanNixon]: https://github.com/DanNixon +[@Danielhiversen]: https://github.com/Danielhiversen +[@FrederikBolding]: https://github.com/FrederikBolding +[@Kane610]: https://github.com/Kane610 +[@Klikini]: https://github.com/Klikini +[@MartinHjelmare]: https://github.com/MartinHjelmare +[@MisterWil]: https://github.com/MisterWil +[@Myrddyn1]: https://github.com/Myrddyn1 +[@Nossnevs]: https://github.com/Nossnevs +[@NovapaX]: https://github.com/NovapaX +[@Oro]: https://github.com/Oro +[@PhracturedBlue]: https://github.com/PhracturedBlue +[@PlanetJ]: https://github.com/PlanetJ +[@ReneNulschDE]: https://github.com/ReneNulschDE +[@Skaronator]: https://github.com/Skaronator +[@adpriebe]: https://github.com/adpriebe +[@alandtse]: https://github.com/alandtse +[@amelchio]: https://github.com/amelchio +[@andrey-git]: https://github.com/andrey-git +[@armills]: https://github.com/armills +[@balloob]: https://github.com/balloob +[@bdurrer]: https://github.com/bdurrer +[@c727]: https://github.com/c727 +[@cdce8p]: https://github.com/cdce8p +[@chronm]: https://github.com/chronm +[@colinodell]: https://github.com/colinodell +[@danielperna84]: https://github.com/danielperna84 +[@dlbroadfoot]: https://github.com/dlbroadfoot +[@fabaff]: https://github.com/fabaff +[@fezfox]: https://github.com/fezfox +[@frenck]: https://github.com/frenck +[@hAmpzter]: https://github.com/hAmpzter +[@ikucuze]: https://github.com/ikucuze +[@jmtatsch]: https://github.com/jmtatsch +[@kellerza]: https://github.com/kellerza +[@lindsaymarkward]: https://github.com/lindsaymarkward +[@lwis]: https://github.com/lwis +[@mf-social]: https://github.com/mf-social +[@michaelarnauts]: https://github.com/michaelarnauts +[@morberg]: https://github.com/morberg +[@mountainsandcode]: https://github.com/mountainsandcode +[@olskar]: https://github.com/olskar +[@phileaton]: https://github.com/phileaton +[@pschmitt]: https://github.com/pschmitt +[@robmarkcole]: https://github.com/robmarkcole +[@rytilahti]: https://github.com/rytilahti +[@scop]: https://github.com/scop +[@shuaiger]: https://github.com/shuaiger +[@snjoetw]: https://github.com/snjoetw +[@stephanerosi]: https://github.com/stephanerosi +[@syssi]: https://github.com/syssi +[@tadly]: https://github.com/tadly +[@teharris1]: https://github.com/teharris1 +[@timmo001]: https://github.com/timmo001 +[@titilambert]: https://github.com/titilambert +[@trisk]: https://github.com/trisk +[@tschmidty69]: https://github.com/tschmidty69 +[@turbokongen]: https://github.com/turbokongen +[@wmalgadey]: https://github.com/wmalgadey +[@zhaokoh]: https://github.com/zhaokoh +[abode docs]: /components/abode/ +[alarm_control_panel.ifttt docs]: /components/alarm_control_panel.ifttt/ +[alarm_control_panel.totalconnect docs]: /components/alarm_control_panel.totalconnect/ +[alexa docs]: /components/alexa/ +[amcrest docs]: /components/amcrest/ +[api docs]: /components/api/ +[binary_sensor.bmw_connected_drive docs]: /components/binary_sensor.bmw_connected_drive/ +[binary_sensor.mercedesme docs]: /components/binary_sensor.mercedesme/ +[binary_sensor.workday docs]: /components/binary_sensor.workday/ +[bmw_connected_drive docs]: /components/bmw_connected_drive/ +[camera.mqtt docs]: /components/camera.mqtt/ +[canary docs]: /components/canary/ +[climate.nest docs]: /components/climate.nest/ +[config docs]: /components/config/ +[config_entry_example docs]: /components/config_entry_example/ +[conversation docs]: /components/conversation/ +[cover docs]: /components/cover/ +[cover.rpi_gpio docs]: /components/cover.rpi_gpio/ +[deconz docs]: /components/deconz/ +[device_tracker docs]: /components/device_tracker/ +[device_tracker.bluetooth_tracker docs]: /components/device_tracker.bluetooth_tracker/ +[device_tracker.bmw_connected_drive docs]: /components/device_tracker.bmw_connected_drive/ +[device_tracker.google_maps docs]: /components/device_tracker.google_maps/ +[doorbird docs]: /components/doorbird/ +[fan.xiaomi_miio docs]: /components/fan.xiaomi_miio/ +[folder_watcher docs]: /components/folder_watcher/ +[freedns docs]: /components/freedns/ +[homekit docs]: /components/homekit/ +[hue docs]: /components/hue/ +[insteon_plm docs]: /components/insteon_plm/ +[light docs]: /components/light/ +[light.nanoleaf_aurora docs]: /components/light.nanoleaf_aurora/ +[light.hue docs]: /components/light.hue/ +[light.iglo docs]: /components/light.iglo/ +[light.mystrom docs]: /components/light.mystrom/ +[light.nanoleaf_aurora docs]: /components/light.nanoleaf_aurora/ +[light.qwikswitch docs]: /components/light.qwikswitch/ +[light.tradfri docs]: /components/light.tradfri/ +[light.xiaomi_miio docs]: /components/light.xiaomi_miio/ +[light.yeelight docs]: /components/light.yeelight/ +[lock.bmw_connected_drive docs]: /components/lock.bmw_connected_drive/ +[media_extractor docs]: /components/media_extractor/ +[media_player.liveboxplaytv docs]: /components/media_player.liveboxplaytv/ +[media_player.philips_js docs]: /components/media_player.philips_js/ +[media_player.songpal docs]: /components/media_player.songpal/ +[media_player.webostv docs]: /components/media_player.webostv/ +[mercedesme docs]: /components/mercedesme/ +[mqtt docs]: /components/mqtt/ +[mysensors docs]: /components/mysensors/ +[notify docs]: /components/notify/ +[pilight docs]: /components/pilight/ +[qwikswitch docs]: /components/qwikswitch/ +[remote.xiaomi_miio docs]: /components/remote.xiaomi_miio/ +[rflink docs]: /components/rflink/ +[rfxtrx docs]: /components/rfxtrx/ +[sensor.bmw_connected_drive docs]: /components/sensor.bmw_connected_drive/ +[sensor.broadlink docs]: /components/sensor.broadlink/ +[sensor.canary docs]: /components/sensor.canary/ +[sensor.cpuspeed docs]: /components/sensor.cpuspeed/ +[sensor.file docs]: /components/sensor.file/ +[sensor.hydroquebec docs]: /components/sensor.hydroquebec/ +[sensor.imap_email_content docs]: /components/sensor.imap_email_content/ +[sensor.mercedesme docs]: /components/sensor.mercedesme/ +[sensor.plex docs]: /components/sensor.plex/ +[sensor.qnap docs]: /components/sensor.qnap/ +[sensor.qwikswitch docs]: /components/sensor.qwikswitch/ +[sensor.tesla docs]: /components/sensor.tesla/ +[sensor.tradfri docs]: /components/sensor.tradfri/ +[sensor.waze_travel_time docs]: /components/sensor.waze_travel_time/ +[smappee docs]: /components/smappee/ +[switch.amcrest docs]: /components/switch.amcrest/ +[switch.broadlink docs]: /components/switch.broadlink/ +[switch.mystrom docs]: /components/switch.mystrom/ +[switch.qwikswitch docs]: /components/switch.qwikswitch/ +[switch.tahoma docs]: /components/switch.tahoma/ +[switch.telnet docs]: /components/switch.telnet/ +[switch.xiaomi_miio docs]: /components/switch.xiaomi_miio/ +[tado docs]: /components/tado/ +[tahoma docs]: /components/tahoma/ +[tradfri docs]: /components/tradfri/ +[folder_watcher docs]: /components/folder_watcher/ +[xiaomi_aqara docs]: /components/xiaomi_aqara/ +[zwave docs]: /components/zwave/ +[ann-ubiquiti]: /blog/2018/04/12/ubiquiti-and-home-assistant/ +[#13728]: https://github.com/home-assistant/home-assistant/pull/13728 +[#13741]: https://github.com/home-assistant/home-assistant/pull/13741 +[#13862]: https://github.com/home-assistant/home-assistant/pull/13862 +[#13884]: https://github.com/home-assistant/home-assistant/pull/13884 +[#13887]: https://github.com/home-assistant/home-assistant/pull/13887 +[#13889]: https://github.com/home-assistant/home-assistant/pull/13889 +[#13906]: https://github.com/home-assistant/home-assistant/pull/13906 +[#13908]: https://github.com/home-assistant/home-assistant/pull/13908 +[#13920]: https://github.com/home-assistant/home-assistant/pull/13920 +[#13940]: https://github.com/home-assistant/home-assistant/pull/13940 +[#13946]: https://github.com/home-assistant/home-assistant/pull/13946 +[#13947]: https://github.com/home-assistant/home-assistant/pull/13947 +[#13959]: https://github.com/home-assistant/home-assistant/pull/13959 +[@Danielhiversen]: https://github.com/Danielhiversen +[@Kane610]: https://github.com/Kane610 +[@aav7fl]: https://github.com/aav7fl +[@bachya]: https://github.com/bachya +[@balloob]: https://github.com/balloob +[@dlbroadfoot]: https://github.com/dlbroadfoot +[@kellerza]: https://github.com/kellerza +[@syssi]: https://github.com/syssi +[@titilambert]: https://github.com/titilambert +[climate.honeywell docs]: /components/climate.honeywell/ +[config docs]: /components/config/ +[device_tracker docs]: /components/device_tracker/ +[fan.xiaomi_miio docs]: /components/fan.xiaomi_miio/ +[qwikswitch docs]: /components/qwikswitch/ +[sensor.fido docs]: /components/sensor.fido/ +[sensor.hydroquebec docs]: /components/sensor.hydroquebec/ +[sensor.pollen docs]: /components/sensor.pollen/ +[switch.broadlink docs]: /components/switch.broadlink/ +[switch.vesync docs]: /components/switch.vesync/ diff --git a/source/_posts/2018-04-22-hassio-2018.markdown b/source/_posts/2018-04-22-hassio-2018.markdown new file mode 100644 index 0000000000..9050605355 --- /dev/null +++ b/source/_posts/2018-04-22-hassio-2018.markdown @@ -0,0 +1,64 @@ +--- +layout: post +title: "Hass.io 2018" +description: "We want to clarify how Hass.io relates to Home Assistant and talk about the roadmap for Hass.io in 2018." +date: 2018-04-22 00:00:00 +date_formatted: "April 22, 2018" +author: Pascal Vizeli +author_twitter: pvizeli +comments: true +categories: Announcements +og_image: /images/blog/2018-04-hassio-2018/blogpost.png +--- + +We noticed that there is some confusion in the community about how Hass.io relates to Home Assistant and what impact the upcoming Hass.io changes will have. We will try to clarify it all in this blog post. + +## {% linkable_title What is Hass.io %} +Hass.io is a complete solution to run Home Assistant, by the authors of Home Assistant. The goal of Hass.io is to provide an easy to use and secure system, entirely managed from within the Home Assistant user interface. + +Hass.io is a complete solution, which means that it comes with its own highly secure and optimized operating system, a supervisor application to maintain and configure that system, and of course Home Assistant itself. + +When using Hass.io, you'll see a new Hass.io panel inside the Home Assistant UI. From here users can configure the system and install Home Assistant updates with a simple click of a button. Users are also able to make snapshots of their system, making it easy to migrate all their configuration to a new system or restore their system to a previous state. + +We wanted to be able to provide the convenience of seamless updates and configuration via the UI to other applications too, and so we introduced Hass.io add-ons. Any application can be packaged up as a Hass.io add-on, allowing any user to install and manage it easily. Since the introduction, we’ve seen an amazing growth in users sharing their add-ons with the community. It’s now possible to install an adblocker for your network, an MQTT broker or Tor with a single click. + +## {% linkable_title Upcoming changes to Hass.io %} +We’ve introduced Hass.io [last July]. Since then, we’ve noticed some room for improvements in making Hass.io easier to use, lighter to maintain and easier to integrate with other host systems. + +Note that the descriptions of upcoming improvements can get quite technical. Feel free to jump to [the conclusion]. + +### {% linkable_title Automatic add-on configuration %} +Home Assistant has recently introduced configuration entries. We’re going to hook into this new functionality and allow add-ons to configure their related integration in Home Assistant automatically. For example, if a user installs the MQTT broker add-on, we will automatically set up Home Assistant to connect to it. + +### {% linkable_title Host management %} +To control the host system, we currently use a custom service called HostControl. This allows the user to manage here host and restart/shutdown the computer from within Home Assistant. Instead of relying on our own system, we’re going to change to use D-Bus. D-Bus is a standardized mechanism for services and applications to communicate. Using a defined standard means that all parts of the host can now be remotely configured: sound, network, etc, etc. We will be extending the Hass.io panel in Home Assistant with controls to configure various parts of the host. + +### {% linkable_title Hass.io OS %} +Hass.io is currently using a forked version of ResinOS as our operating system. ResinOS has been designed to run a minimal environment for Docker, simple over the air updates and connect to the ResinIO cloud. Our fork removed the ResinIO logic. Over time, ResinOS has been evolving but not in a direction that is aligned with our goals, resulting in the maintenance of our fork to take up a lot of time. + +The ResinOS build system is based on the Yocto Project. This is a very powerful system, but also requires specific support for each hardware platform need to be specifically added and maintained (like each version of Raspberry Pi), which caused long build and development times for Hass.io. + +All these factors made us decide to build our own, custom, operating system. We’re obviously not starting from scratch, but instead, are basing it off [Buildroot] as the foundation and use [RAUC] for over the air updates. + +Some things that the new operating system will be able to do: +- Easier to add support for new hardware. +- Updating will be atomic and has a Fail-safe. If a system fails to boot after an OS upgrade, it will fallback, by booting the previous working version. +- Updates are required to be securely signed by the Home Assistant team, adding a whole new level of security. +- Compressing the root file system, making it faster on SD cards and slow IO-Interfaces. +- Compressing parts of the memory so that we can store more information. + +## {% linkable_title What Hass.io users should do to prepare for these updates %} +At this moment: Nothing. + +The new Hass.io supervisor still supports the old ResinOS builds (our official downloads for Raspberry Pi and Intel NUC) and generic Linux installations. If you’re using a generic Linux installation on SUSE Linux or Ubuntu, you have to update your local AppArmor profile if you want to use the new functionality (instructions will be provided upon release). + +Once our new installation images with HassioOS are released, you have to reflash your device once. You can do this without losing any configuration by using our Snapshot feature: +- Create a snapshot of your current installation and download it to your PC. +- Flash the SD card with the new Hass.io OS image. +- Restore your snapshot. +- Enjoy a new and improved Hass.io + +[last July]: https://www.home-assistant.io/blog/2017/07/25/introducing-hassio/ +[the conclusion]: #what-hassio-users-should-do-to-prepare-for-these-updates +[Buildroot]: https://buildroot.org/ +[RAUC]: https://www.rauc.io/ diff --git a/source/_posts/2018-04-24-launch-google-assistant-support.markdown b/source/_posts/2018-04-24-launch-google-assistant-support.markdown new file mode 100644 index 0000000000..7a263f9682 --- /dev/null +++ b/source/_posts/2018-04-24-launch-google-assistant-support.markdown @@ -0,0 +1,44 @@ +--- +layout: post +title: "Our Google Assistant skill is live!" +description: "The Google Assistant integration for Home Assistant Cloud is now available to all." +date: 2018-04-24 00:01:00 +date_formatted: "April 24, 2018" +author: Paulus Schoutsen +author_twitter: balloob +comments: true +categories: Announcement +og_image: /images/blog/2018-04-google-assistant/google-assistant-home-assistant.png +--- + +

    + Home Assistant logo and the Works with the Google Assistant badge +

    + +Guess what? Yep, our Google Assistant Smart Home skill is live! It's a mouthful but it means that you can now control your Home Assistant devices via any Google Assistant enabled device by simply saying things like "Ok Google, turn on the lights". + +To get started: + + - [Enable Home Assistant Cloud](/cloud/#enabling-the-cloud) + - Install our skill for Google Assistant. As of this writing, the link is not live yet: you can find it by opening the Google Home app -> Home Control, tap on the blue + at the bottom right and find Hass.io in the list. + - Optional: [Tweak the devices](/cloud/google_assistant/) that are getting exposed to Google Assistant. + +Things to note: + + - The skill is called Hass.io, but will work with normal Home Assistant too. The name was necessary to avoid confusion between Home Assistant, Google Assistant and Google Home. + - Works with Home Assistant 0.65.6 or later. + - All message handling is done local and is [open source](https://github.com/home-assistant/home-assistant/blob/dev/homeassistant/components/google_assistant/trait.py). + - If you have an Android device with Google Assistant, you can control your devices too. + - Home Assistant 0.68 will introduce a button to the Cloud config panel to trigger a sync of available devices. + +Home Assistant Cloud is still in open beta and free to use. Open beta period has been extended to June 1. Many thanks to [Quadflight] for providing the Raspberry Pis that Google used for physical testing and thanks to [Arsaboo] for helping with testing. + +
    + +
    + +[Quadflight]: https://github.com/quadflight +[Arsaboo]: https://github.com/arsaboo diff --git a/source/_posts/2018-04-26-developer-site.markdown b/source/_posts/2018-04-26-developer-site.markdown new file mode 100644 index 0000000000..2895a83338 --- /dev/null +++ b/source/_posts/2018-04-26-developer-site.markdown @@ -0,0 +1,20 @@ +--- +layout: post +title: "New developer website" +description: "We have extracted the developer section of our website into its own website." +date: 2018-04-26 00:01:00 +date_formatted: "April 26, 2018" +author: Paulus Schoutsen +author_twitter: balloob +comments: true +categories: Announcement +og_image: /images/blog/2018-04-developer-website/screenshot.png +--- + +When we launched the website in December 2014, we've only had a handful of components and usage instructions. Since then the website has grown to over a 1000 pages touching a wide range of topics. The growth, while great, also has put a lot of strain on how the docs are organised. One of the places that was especially suffering under the growth was the developer section. It was living under a single top menu item and had to contain everything in a single sidebar. + +To fix this, we're releasing a new website: [developers.home-assistant.io](https://developers.home-assistant.io). The website is aimed at people that are developing Home Assistant. It will contain resources how to setup your development environment, how to fix bugs, help with translations or improve the frontend. The main website will now solely be focused on Home Assistant users. + +Go check it out and let us know what you think: [developers.home-assistant.io](https://developers.home-assistant.io). + +Screenshot of the developer website diff --git a/source/_posts/2018-04-27-release-68.markdown b/source/_posts/2018-04-27-release-68.markdown new file mode 100644 index 0000000000..924546f866 --- /dev/null +++ b/source/_posts/2018-04-27-release-68.markdown @@ -0,0 +1,533 @@ +--- +layout: post +title: "0.68: HomeKit control, Eufy, FritzBox, SigFox sensors" +description: "Enjoy your weekend with this brand new release of Home Assistant." +date: 2018-04-27 00:01:00 +date_formatted: "April 27, 2018" +author: Paulus Schoutsen +author_twitter: balloob +comments: true +categories: Release-Notes +og_image: /images/blog/2018-04-0.68/components.png +--- + + + +Weekend is around the corner and that means that it's time for the next release of Home Assistant. 0.68 brings a ton of great goodies and bug fixes. + +One of the coolest features this release is by [@mjg59]: you are now able to **control** HomeKit devices. Previously, it was possible to control Home Assistant from iOS devices using the HomeKit protocol. With this release, Home Assistant is able to become the controller and use HomeKit to control lights and switches directly. Since HomeKit is vendor agnostic, it means that any HomeKit light or switch will now be compatible with Home Assistant. Very cool. + +Another cool new platform, also by [@mjg59], is support for Eufy devices. Eufy is the Home Automation brand of Anker and they have been producing reasonably priced devices which can now be controlled by Home Assistant too. Thanks for all your contributions [@mjg59] ❤️. + +## {% linkable_title New Platforms %} + +- Add support for Eufy bulbs and switches ([@mjg59] - [#13773]) ([eufy docs]) ([light.eufy docs]) ([switch.eufy docs]) (new-platform) +- Add support for controlling homekit lights and switches ([@mjg59] - [#13346]) ([homekit_controller docs]) ([light.homekit_controller docs]) (new-platform) +- Adding USCIS component ([@meauxt] - [#13764]) ([sensor.uscis docs]) (new-platform) +- Add support for new platform: climate.modbus ([@Kirchoff] - [#12224]) ([climate.modbus docs]) (new-platform) +- Add AVM fritzbox smarthome component ([@hthiery] - [#10688]) ([fritzbox docs]) ([climate.fritzbox docs]) ([switch.fritzbox docs]) (new-platform) +- Adds SigFox sensor ([@robmarkcole] - [#13731]) ([sensor.sigfox docs]) (new-platform) +- Add blackbird media player component ([@koolsb] - [#13549]) ([media_player.blackbird docs]) (new-platform) +- Add support for Sensirion SHT31 temperature/humidity sensor ([@viorels] - [#12952]) ([sensor.sht31 docs]) (new-platform) +- Qwikswitch binary sensors ([@kellerza] - [#14008]) ([qwikswitch docs]) ([binary_sensor.qwikswitch docs]) ([sensor.qwikswitch docs]) (beta fix) (new-platform) + +## {% linkable_title New Features %} + +- Support binary_sensor and device_tracker in HomeKit ([@Yonsm] - [#13735]) ([homekit docs]) (new-feature) +- Add Homekit locks support ([@philk] - [#13625]) ([homekit docs]) (new-feature) +- Support CO2/PM2.5/Light sensors in HomeKit ([@Yonsm] - [#13804]) ([homekit docs]) (new-feature) +- Support Garage Doors in HomeKit ([@marthoc] - [#13796]) ([homekit docs]) (new-feature) +- Support basic covers with open/close/stop services HomeKit ([@nickw444] - [#13819]) ([homekit docs]) (new-feature) + +## {% linkable_title Release 0.68.1 - April 30 %} + +- Fix color setting of tplink lights ([@amelchio] - [#14108]) ([light.tplink docs]) +- Improve precision of Hue color state ([@amelchio] - [#14113]) ([light.hue docs]) +- Revert Hue color state to be xy-based ([@amelchio] - [#14154]) +- Fix Python 3.6 compatibility for HomeKit controller ([@mjg59] - [#14160]) ([homekit_controller docs]) +- Added CONF_IP_ADDRESS to HomeKit ([@cdce8p] - [#14163]) ([homekit docs]) +- Do not sync entities with an empty name ([@balloob] - [#14181]) ([google_assistant docs]) +- Improve chromecast disconnection logic ([@OttoWinter] - [#14190]) ([media_player.cast docs]) +- Fix poorly formatted automations ([@balloob] - [#14196]) +- Disable eliqonline requirement ([@balloob] - [#14156]) + +## {% linkable_title If you need help... %} + +...don't hesitate to use our very active [forums](https://community.home-assistant.io/) or join us for a little [chat](https://discord.gg/c5DvZ4e). The release notes have comments enabled but it's preferred if you use the former communication channels. Thanks. + +## {% linkable_title Reporting Issues %} + +Experiencing issues introduced by this release? Please report them in our [issue tracker](https://github.com/home-assistant/home-assistant/issues). Make sure to fill in all fields of the issue template. + + +## {% linkable_title Breaking Changes %} + +- Icons! Material Design Icons has implemented some naming guidelines and this caused 9 icons to change names, 3 of which are home automation icons: `roomba` -> `robot-vacuum`, `nest-protect` -> `smoke-detector`, `nest-thermostat` -> `thermostat` ([see all changes](http://templarian.com/2018/04/18/material-design-icons-v2-3-54/)). +- Support for multiple MAX!Cube LAN gateways caused a slight change to the configuration schema. Make sure to check the docs for the new one. ([@syssi] - [#13517]) ([maxcube docs]) ([binary_sensor.maxcube docs]) ([climate.maxcube docs]) (breaking change) +- Ebox sensor platform has been disabled because the dependency was not compatible with pip 10. ([@balloob] - [#14003]) ([sensor.ebox docs]) (breaking change) + +## {% linkable_title Beta Fixes %} + +- Qwikswitch binary sensors ([@kellerza] - [#14008]) ([qwikswitch docs]) ([binary_sensor.qwikswitch docs]) ([sensor.qwikswitch docs]) (beta fix) (new-platform) +- Order the output of the automation editor ([@balloob] - [#14019]) ([config docs]) (beta fix) +- HomeKit Alarm Control Panel Code Exception Fix ([@schmittx] - [#14025]) ([homekit docs]) (beta fix) +- Revert cast platform polling mode ([@OttoWinter] - [#14027]) ([media_player.cast docs]) (beta fix) +- Handle HomeKit configuration failure more cleanly ([@mjg59] - [#14041]) ([homekit_controller docs]) (beta fix) +- Update device classes for contact sensor HomeKit ([@marthoc] - [#14051]) ([homekit docs]) (beta fix) +- Upgrade broadlink lib ([@Danielhiversen] - [#14074]) ([sensor.broadlink docs]) ([switch.broadlink docs]) (beta fix) +- Fix timezone issue when calculating min/max values in tibber #14009 ([@Danielhiversen] - [#14080]) ([sensor.tibber docs]) (beta fix) +- Updated list of AWS regions for Amazon Polly ([@GotoCode] - [#14097]) ([tts docs]) (beta fix) +- Change Eufy brightness handling ([@mjg59] - [#14111]) (beta fix) + +## {% linkable_title All changes %} + +- Update Homekit to 1.1.9 ([@cdce8p] - [#13716]) ([homekit docs]) +- Update docstrings ([@fabaff] - [#13720]) ([ihc docs]) ([cover.opengarage docs]) ([cover.tahoma docs]) ([sensor.trafikverket_weatherstation docs]) +- Add option to ignore availability in google calendar events ([@cgtobi] - [#13714]) ([calendar.google docs]) +- Allow use of date_string in service call ([@Juggels] - [#13256]) ([calendar.todoist docs]) +- Add timeout / debounce (for brightness and others) ([@cdce8p] - [#13534]) ([homekit docs]) +- added support for smappee water sensors ([@hmn] - [#12831]) ([smappee docs]) ([sensor.smappee docs]) +- Initialise filter_sensor with historical values ([@dgomes] - [#13075]) ([sensor.filter docs]) +- Fix Gogogate2 'available' attribute ([@dlbroadfoot] - [#13728]) (beta fix) +- Bluesound bugfix status 595 and await ([@thrawnarn] - [#13727]) ([media_player.bluesound docs]) +- Upgrade aiohttp to 3.1.2 ([@fabaff] - [#13732]) +- Upgrade sqlalchemy to 1.2.6 ([@fabaff] - [#13733]) ([sensor.sql docs]) +- Brightness conversion for Abode dimmers ([@shred86] - [#13711]) ([light.abode docs]) +- Update CODEOWNERS (sensor.filter, sensor.upnp) ([@dgomes] - [#13736]) +- Reset permission ([@fabaff] - [#13743]) ([light.abode docs]) +- Throw an error when invalid device_mode is given ([@dangyuluo] - [#13739]) +- Fix so it is possible to ignore discovered config entry handlers ([@Kane610] - [#13741]) (beta fix) +- Upgrade netdisco to 1.3.1 ([@fabaff] - [#13744]) +- Add MQTT Sensor unique_id ([@OttoWinter] - [#13318]) ([sensor.mqtt docs]) +- Prepare entity component for config entries ([@balloob] - [#13730]) +- Check valid file on get_size ([@robmarkcole] - [#13756]) ([sensor.folder docs]) +- Qwikswitch sensors ([@kellerza] - [#13622]) ([sensor.qwikswitch docs]) +- Device type mapping introduced to avoid breaking change ([@syssi] - [#13765]) ([light.yeelight docs]) +- Only flag media position as updated when it really has ([@molobrakos] - [#13737]) ([media_player.squeezebox docs]) +- Support binary_sensor and device_tracker in HomeKit ([@Yonsm] - [#13735]) ([homekit docs]) (new-feature) +- Use config entry to setup platforms ([@balloob] - [#13752]) ([hue docs]) ([light docs]) ([light.hue docs]) +- Add Homekit locks support ([@philk] - [#13625]) ([homekit docs]) (new-feature) +- Snips sounds ([@tschmidty69] - [#13746]) ([snips docs]) +- Add missing DISCHRG state ([@swilson] - [#13787]) ([sensor.nut docs]) +- Improved upgradeability HomeKit security_systems ([@cdce8p] - [#13783]) ([homekit docs]) +- Qwikswitch Entity Register ([@kellerza] - [#13791]) ([qwikswitch docs]) ([sensor.qwikswitch docs]) +- Updated beacontools to 1.2.3 ([@citruz] - [#13792]) ([sensor.eddystone_temperature docs]) +- script/lazytox: Ensure Flake8 passes for tests/ ([@kellerza] - [#13794]) +- Fix bad metrics format for short metrics. ([@michaelkuty] - [#13778]) ([prometheus docs]) +- Update bellows to 0.5.2 ([@rcloran] - [#13800]) ([zha docs]) +- device_tracker.ubus: Handle devices not running DHCP ([@tobygray] - [#13579]) ([device_tracker docs]) +- Update yweather.py ([@wiuwiu] - [#13802]) ([weather.yweather docs]) +- Tibber lib update ([@Danielhiversen] - [#13811]) ([sensor.tibber docs]) +- Update pyhomematic to 0.1.41 ([@danielperna84] - [#13814]) ([homematic docs]) +- Add support for Eufy bulbs and switches ([@mjg59] - [#13773]) ([eufy docs]) ([light.eufy docs]) ([switch.eufy docs]) (new-platform) +- Homekit refactor ([@cdce8p] - [#13707]) ([homekit docs]) +- HomeKit type_cover fix ([@cdce8p] - [#13832]) ([homekit docs]) +- Allow platform unloading ([@balloob] - [#13784]) ([hue docs]) ([light docs]) +- Support CO2/PM2.5/Light sensors in HomeKit ([@Yonsm] - [#13804]) ([homekit docs]) (new-feature) +- Clicksend: Added support for multiple recipients ([@xTCx] - [#13812]) ([notify docs]) +- Support Garage Doors in HomeKit ([@marthoc] - [#13796]) ([homekit docs]) (new-feature) +- Abode better events ([@MisterWil] - [#13809]) ([abode docs]) +- UPnP async ([@dgomes] - [#13666]) ([upnp docs]) ([sensor.upnp docs]) +- Update example (fixes #13834) ([@fabaff] - [#13839]) +- Add support for deCONZ daylight sensor ([@marthoc] - [#13479]) ([deconz docs]) ([sensor.deconz docs]) +- initialize queue before filtering ([@dgomes] - [#13842]) ([sensor.filter docs]) +- Extract config flow to own module ([@balloob] - [#13840]) ([config docs]) ([deconz docs]) ([hue docs]) +- Add support for controlling homekit lights and switches ([@mjg59] - [#13346]) ([homekit_controller docs]) ([light.homekit_controller docs]) (new-platform) +- bump python-ecobee-api version to 0.0.18 ([@geekofweek] - [#13854]) ([ecobee docs]) +- Adding USCIS component ([@meauxt] - [#13764]) ([sensor.uscis docs]) (new-platform) +- Avoid unnecessary cast state updates ([@dersger] - [#13770]) ([media_player.cast docs]) +- Prevent vesync doing I/O in event loop ([@balloob] - [#13862]) ([switch.vesync docs]) (beta fix) +- Update yweather.py ([@TheCellMC] - [#13851]) ([weather.yweather docs]) +- add support for Kodi discovery ([@escoand] - [#13790]) ([media_player.kodi docs]) +- Further untangle data entry flow ([@balloob] - [#13855]) +- Missing property decorator added ([@syssi] - [#13889]) ([fan.xiaomi_miio docs]) (beta fix) +- Fix race condition for component loaded before listening ([@balloob] - [#13887]) ([config docs]) (beta fix) +- Added snips service descriptions ([@tschmidty69] - [#13883]) +- Add unique_id for BMW ConnectedDrive ([@gerard33] - [#13888]) ([binary_sensor.bmw_connected_drive docs]) ([lock.bmw_connected_drive docs]) ([sensor.bmw_connected_drive docs]) +- Revert "Update yweather.py" ([@pvizeli] - [#13900]) ([weather.yweather docs]) +- Eufy colour bulb updates ([@mjg59] - [#13895]) ([eufy docs]) ([light.eufy docs]) +- Fix #13846 Double underscore in bluetooth address ([@aav7fl] - [#13884]) ([device_tracker docs]) (beta fix) +- Import operation modes from air humidifier ([@syssi] - [#13908]) ([fan.xiaomi_miio docs]) (beta fix) +- Fritzbox netmonitor name ([@escoand] - [#13903]) ([sensor.fritzbox_netmonitor docs]) +- Restore typeerror check for units sans energy tracking ([@andersonshatch] - [#13824]) ([switch.edimax docs]) +- Add more math functions to templates ([@Shou] - [#13915]) +- Upgrade pyqwikswitch to 0.71 ([@kellerza] - [#13920]) ([qwikswitch docs]) +- Add extra attributes for device scanner, Nmap and Unifi (IP, SSID, etc.) ([@stephanerosi] - [#13673]) ([device_tracker docs]) +- Fixed Capsman data not being used ([@Marco98] - [#13917]) ([device_tracker docs]) +- Broadlink Sensor - switch to connection-less mode ([@Paxy] - [#13761]) ([sensor.broadlink docs]) +- Add support for new platform: climate.modbus ([@Kirchoff] - [#12224]) ([climate.modbus docs]) (new-platform) +- Hive R3 update ([@KJonline] - [#13357]) ([hive docs]) ([binary_sensor.hive docs]) ([climate.hive docs]) ([light.hive docs]) ([sensor.hive docs]) ([switch.hive docs]) +- Updated foobot_async package version ([@reefab] - [#13942]) ([sensor.foobot docs]) +- Update pyhydroquebec to 2.2.2 ([@titilambert] - [#13946]) ([sensor.hydroquebec docs]) (beta fix) +- Upgrade alpha_vantage to 2.0.0 ([@fabaff] - [#13943]) ([sensor.alpha_vantage docs]) +- Cleanup on exit ([@dgomes] - [#13918]) ([media_player.mediaroom docs]) +- Upgrade somecomfort to 0.5.2 ([@balloob] - [#13940]) ([climate.honeywell docs]) (beta fix) +- Add data entry flow helper ([@balloob] - [#13935]) ([config docs]) +- Xiaomi MiIO Device Tracker: Unused variable removed ([@syssi] - [#13948]) ([device_tracker docs]) +- Implement play media to set a channel based on (by priority): ([@stephanerosi] - [#13934]) ([media_player.webostv docs]) +- Update of python-mpd2 ([@karlkar] - [#13921]) ([media_player.mpd docs]) +- Add AVM fritzbox smarthome component ([@hthiery] - [#10688]) ([fritzbox docs]) ([climate.fritzbox docs]) ([switch.fritzbox docs]) (new-platform) +- Adds SigFox sensor ([@robmarkcole] - [#13731]) ([sensor.sigfox docs]) (new-platform) +- Upgrade aiohttp to 3.1.3 ([@fabaff] - [#13938]) +- Upgrade youtube_dl to 2018.04.16 ([@fabaff] - [#13937]) ([media_extractor docs]) +- Added FB messenger broadcast api to notify.facebook component ([@B1tMaster] - [#12459]) ([notify.facebook docs]) +- Added web view for TTS to get url ([@tschmidty69] - [#13882]) ([tts docs]) +- Add services for bmw_connected_drive ([@ChristianKuehnel] - [#13497]) ([bmw_connected_drive docs]) ([device_tracker docs]) +- Fix call to parent broadlink switch ([@Danielhiversen] - [#13906]) ([switch.broadlink docs]) (beta fix) +- Bump deCONZ requirement to v36 ([@Kane610] - [#13960]) ([deconz docs]) +- Fix Gogogate2 'available' attribute ([@dlbroadfoot] - [#13728]) (beta fix) +- Fix so it is possible to ignore discovered config entry handlers ([@Kane610] - [#13741]) (beta fix) +- Prevent vesync doing I/O in event loop ([@balloob] - [#13862]) ([switch.vesync docs]) (beta fix) +- Fix #13846 Double underscore in bluetooth address ([@aav7fl] - [#13884]) ([device_tracker docs]) (beta fix) +- Fix race condition for component loaded before listening ([@balloob] - [#13887]) ([config docs]) (beta fix) +- Missing property decorator added ([@syssi] - [#13889]) ([fan.xiaomi_miio docs]) (beta fix) +- Fix call to parent broadlink switch ([@Danielhiversen] - [#13906]) ([switch.broadlink docs]) (beta fix) +- Import operation modes from air humidifier ([@syssi] - [#13908]) ([fan.xiaomi_miio docs]) (beta fix) +- Upgrade pyqwikswitch to 0.71 ([@kellerza] - [#13920]) ([qwikswitch docs]) +- Upgrade somecomfort to 0.5.2 ([@balloob] - [#13940]) ([climate.honeywell docs]) (beta fix) +- Update pyhydroquebec to 2.2.2 ([@titilambert] - [#13946]) ([sensor.hydroquebec docs]) (beta fix) +- Revert "Upgrade pyqwikswitch to 0.71 ([@balloob] - [#13920]) ([qwikswitch docs]) +- Bump skybellpy version to 0.1.2 ([@MisterWil] - [#13974]) ([skybell docs]) +- Fix typo an coding style ([@stephanerosi] - [#13970]) ([device_tracker docs]) +- Params of the send command can be a list now ([@syssi] - [#13905]) ([vacuum docs]) +- Support basic covers with open/close/stop services HomeKit ([@nickw444] - [#13819]) ([homekit docs]) (new-feature) +- Colorlog windows fix ([@veleek] - [#13929]) ([notify docs]) +- deCONZ migrate setup fully to config entry ([@Kane610] - [#13679]) ([deconz docs]) +- Alexa thermostat fails to properly parse 'value' field for climate ([@no2chem] - [#13958]) ([alexa docs]) +- renaming icons ([@NovapaX] - [#13982]) ([hdmi_cec docs]) ([vacuum docs]) ([vacuum.dyson docs]) ([vacuum.neato docs]) ([vacuum.roomba docs]) ([vacuum.xiaomi_miio docs]) +- Fix for Lokalise backend misinterpretation of keys ([@armills] - [#13986]) +- Bump locationsharinglib to 1.2.1 ([@thelittlefireman] - [#13980]) ([device_tracker docs]) +- Support for multiple MAX!Cube LAN gateways added ([@syssi] - [#13517]) ([maxcube docs]) ([binary_sensor.maxcube docs]) ([climate.maxcube docs]) (breaking change) +- Add additional receiver for Onkyo zone 2 ([@koolsb] - [#13551]) ([media_player.onkyo docs]) +- Add blackbird media player component ([@koolsb] - [#13549]) ([media_player.blackbird docs]) (new-platform) +- Add support for Sensirion SHT31 temperature/humidity sensor ([@viorels] - [#12952]) ([sensor.sht31 docs]) (new-platform) +- Useless code removed ([@syssi] - [#13996]) ([maxcube docs]) +- Add Homematic HmIP-SWO-PR weather sensor support ([@pascalhahn] - [#13904]) ([homematic docs]) +- Disable ebox requirement ([@balloob] - [#14003]) ([sensor.ebox docs]) (breaking change) +- Upgraded miflora library to version 0.4.0 ([@ChristianKuehnel] - [#14005]) ([sensor.miflora docs]) +- Log an error instead of raising an exception ([@syssi] - [#14006]) ([sensor.sht31 docs]) +- Tibber available ([@Danielhiversen] - [#13865]) ([sensor.tibber docs]) +- Upgrade pylutron-caseta to 0.5.0 to reestablish connections ([@rohankapoorcom] - [#14013]) ([lutron_caseta docs]) +- Add sensor device classes ([@balloob] - [#14010]) ([sensor docs]) ([sensor.ecobee docs]) ([sensor.linux_battery docs]) ([sensor.nest docs]) +- Qwikswitch binary sensors ([@kellerza] - [#14008]) ([qwikswitch docs]) ([binary_sensor.qwikswitch docs]) ([sensor.qwikswitch docs]) (beta fix) (new-platform) +- Order the output of the automation editor ([@balloob] - [#14019]) ([config docs]) (beta fix) +- HomeKit Alarm Control Panel Code Exception Fix ([@schmittx] - [#14025]) ([homekit docs]) (beta fix) +- Revert cast platform polling mode ([@OttoWinter] - [#14027]) ([media_player.cast docs]) (beta fix) +- Handle HomeKit configuration failure more cleanly ([@mjg59] - [#14041]) ([homekit_controller docs]) (beta fix) +- Update device classes for contact sensor HomeKit ([@marthoc] - [#14051]) ([homekit docs]) (beta fix) +- Upgrade broadlink lib ([@Danielhiversen] - [#14074]) ([sensor.broadlink docs]) ([switch.broadlink docs]) (beta fix) +- Fix timezone issue when calculating min/max values in tibber #14009 ([@Danielhiversen] - [#14080]) ([sensor.tibber docs]) (beta fix) +- Updated list of AWS regions for Amazon Polly ([@GotoCode] - [#14097]) ([tts docs]) (beta fix) + +[#10688]: https://github.com/home-assistant/home-assistant/pull/10688 +[#12224]: https://github.com/home-assistant/home-assistant/pull/12224 +[#12459]: https://github.com/home-assistant/home-assistant/pull/12459 +[#12831]: https://github.com/home-assistant/home-assistant/pull/12831 +[#12952]: https://github.com/home-assistant/home-assistant/pull/12952 +[#13075]: https://github.com/home-assistant/home-assistant/pull/13075 +[#13256]: https://github.com/home-assistant/home-assistant/pull/13256 +[#13318]: https://github.com/home-assistant/home-assistant/pull/13318 +[#13346]: https://github.com/home-assistant/home-assistant/pull/13346 +[#13357]: https://github.com/home-assistant/home-assistant/pull/13357 +[#13479]: https://github.com/home-assistant/home-assistant/pull/13479 +[#13497]: https://github.com/home-assistant/home-assistant/pull/13497 +[#13517]: https://github.com/home-assistant/home-assistant/pull/13517 +[#13534]: https://github.com/home-assistant/home-assistant/pull/13534 +[#13549]: https://github.com/home-assistant/home-assistant/pull/13549 +[#13551]: https://github.com/home-assistant/home-assistant/pull/13551 +[#13579]: https://github.com/home-assistant/home-assistant/pull/13579 +[#13622]: https://github.com/home-assistant/home-assistant/pull/13622 +[#13625]: https://github.com/home-assistant/home-assistant/pull/13625 +[#13666]: https://github.com/home-assistant/home-assistant/pull/13666 +[#13673]: https://github.com/home-assistant/home-assistant/pull/13673 +[#13679]: https://github.com/home-assistant/home-assistant/pull/13679 +[#13707]: https://github.com/home-assistant/home-assistant/pull/13707 +[#13711]: https://github.com/home-assistant/home-assistant/pull/13711 +[#13714]: https://github.com/home-assistant/home-assistant/pull/13714 +[#13716]: https://github.com/home-assistant/home-assistant/pull/13716 +[#13720]: https://github.com/home-assistant/home-assistant/pull/13720 +[#13727]: https://github.com/home-assistant/home-assistant/pull/13727 +[#13728]: https://github.com/home-assistant/home-assistant/pull/13728 +[#13730]: https://github.com/home-assistant/home-assistant/pull/13730 +[#13731]: https://github.com/home-assistant/home-assistant/pull/13731 +[#13732]: https://github.com/home-assistant/home-assistant/pull/13732 +[#13733]: https://github.com/home-assistant/home-assistant/pull/13733 +[#13735]: https://github.com/home-assistant/home-assistant/pull/13735 +[#13736]: https://github.com/home-assistant/home-assistant/pull/13736 +[#13737]: https://github.com/home-assistant/home-assistant/pull/13737 +[#13739]: https://github.com/home-assistant/home-assistant/pull/13739 +[#13741]: https://github.com/home-assistant/home-assistant/pull/13741 +[#13743]: https://github.com/home-assistant/home-assistant/pull/13743 +[#13744]: https://github.com/home-assistant/home-assistant/pull/13744 +[#13746]: https://github.com/home-assistant/home-assistant/pull/13746 +[#13752]: https://github.com/home-assistant/home-assistant/pull/13752 +[#13756]: https://github.com/home-assistant/home-assistant/pull/13756 +[#13761]: https://github.com/home-assistant/home-assistant/pull/13761 +[#13764]: https://github.com/home-assistant/home-assistant/pull/13764 +[#13765]: https://github.com/home-assistant/home-assistant/pull/13765 +[#13770]: https://github.com/home-assistant/home-assistant/pull/13770 +[#13773]: https://github.com/home-assistant/home-assistant/pull/13773 +[#13778]: https://github.com/home-assistant/home-assistant/pull/13778 +[#13783]: https://github.com/home-assistant/home-assistant/pull/13783 +[#13784]: https://github.com/home-assistant/home-assistant/pull/13784 +[#13787]: https://github.com/home-assistant/home-assistant/pull/13787 +[#13790]: https://github.com/home-assistant/home-assistant/pull/13790 +[#13791]: https://github.com/home-assistant/home-assistant/pull/13791 +[#13792]: https://github.com/home-assistant/home-assistant/pull/13792 +[#13794]: https://github.com/home-assistant/home-assistant/pull/13794 +[#13796]: https://github.com/home-assistant/home-assistant/pull/13796 +[#13800]: https://github.com/home-assistant/home-assistant/pull/13800 +[#13802]: https://github.com/home-assistant/home-assistant/pull/13802 +[#13804]: https://github.com/home-assistant/home-assistant/pull/13804 +[#13809]: https://github.com/home-assistant/home-assistant/pull/13809 +[#13811]: https://github.com/home-assistant/home-assistant/pull/13811 +[#13812]: https://github.com/home-assistant/home-assistant/pull/13812 +[#13814]: https://github.com/home-assistant/home-assistant/pull/13814 +[#13819]: https://github.com/home-assistant/home-assistant/pull/13819 +[#13824]: https://github.com/home-assistant/home-assistant/pull/13824 +[#13832]: https://github.com/home-assistant/home-assistant/pull/13832 +[#13839]: https://github.com/home-assistant/home-assistant/pull/13839 +[#13840]: https://github.com/home-assistant/home-assistant/pull/13840 +[#13842]: https://github.com/home-assistant/home-assistant/pull/13842 +[#13851]: https://github.com/home-assistant/home-assistant/pull/13851 +[#13854]: https://github.com/home-assistant/home-assistant/pull/13854 +[#13855]: https://github.com/home-assistant/home-assistant/pull/13855 +[#13862]: https://github.com/home-assistant/home-assistant/pull/13862 +[#13865]: https://github.com/home-assistant/home-assistant/pull/13865 +[#13882]: https://github.com/home-assistant/home-assistant/pull/13882 +[#13883]: https://github.com/home-assistant/home-assistant/pull/13883 +[#13884]: https://github.com/home-assistant/home-assistant/pull/13884 +[#13887]: https://github.com/home-assistant/home-assistant/pull/13887 +[#13888]: https://github.com/home-assistant/home-assistant/pull/13888 +[#13889]: https://github.com/home-assistant/home-assistant/pull/13889 +[#13895]: https://github.com/home-assistant/home-assistant/pull/13895 +[#13900]: https://github.com/home-assistant/home-assistant/pull/13900 +[#13903]: https://github.com/home-assistant/home-assistant/pull/13903 +[#13904]: https://github.com/home-assistant/home-assistant/pull/13904 +[#13905]: https://github.com/home-assistant/home-assistant/pull/13905 +[#13906]: https://github.com/home-assistant/home-assistant/pull/13906 +[#13908]: https://github.com/home-assistant/home-assistant/pull/13908 +[#13915]: https://github.com/home-assistant/home-assistant/pull/13915 +[#13917]: https://github.com/home-assistant/home-assistant/pull/13917 +[#13918]: https://github.com/home-assistant/home-assistant/pull/13918 +[#13920]: https://github.com/home-assistant/home-assistant/pull/13920 +[#13921]: https://github.com/home-assistant/home-assistant/pull/13921 +[#13929]: https://github.com/home-assistant/home-assistant/pull/13929 +[#13934]: https://github.com/home-assistant/home-assistant/pull/13934 +[#13935]: https://github.com/home-assistant/home-assistant/pull/13935 +[#13937]: https://github.com/home-assistant/home-assistant/pull/13937 +[#13938]: https://github.com/home-assistant/home-assistant/pull/13938 +[#13940]: https://github.com/home-assistant/home-assistant/pull/13940 +[#13942]: https://github.com/home-assistant/home-assistant/pull/13942 +[#13943]: https://github.com/home-assistant/home-assistant/pull/13943 +[#13946]: https://github.com/home-assistant/home-assistant/pull/13946 +[#13948]: https://github.com/home-assistant/home-assistant/pull/13948 +[#13958]: https://github.com/home-assistant/home-assistant/pull/13958 +[#13960]: https://github.com/home-assistant/home-assistant/pull/13960 +[#13970]: https://github.com/home-assistant/home-assistant/pull/13970 +[#13974]: https://github.com/home-assistant/home-assistant/pull/13974 +[#13980]: https://github.com/home-assistant/home-assistant/pull/13980 +[#13982]: https://github.com/home-assistant/home-assistant/pull/13982 +[#13986]: https://github.com/home-assistant/home-assistant/pull/13986 +[#13996]: https://github.com/home-assistant/home-assistant/pull/13996 +[#14003]: https://github.com/home-assistant/home-assistant/pull/14003 +[#14005]: https://github.com/home-assistant/home-assistant/pull/14005 +[#14006]: https://github.com/home-assistant/home-assistant/pull/14006 +[#14008]: https://github.com/home-assistant/home-assistant/pull/14008 +[#14010]: https://github.com/home-assistant/home-assistant/pull/14010 +[#14013]: https://github.com/home-assistant/home-assistant/pull/14013 +[#14019]: https://github.com/home-assistant/home-assistant/pull/14019 +[#14025]: https://github.com/home-assistant/home-assistant/pull/14025 +[#14027]: https://github.com/home-assistant/home-assistant/pull/14027 +[#14041]: https://github.com/home-assistant/home-assistant/pull/14041 +[#14051]: https://github.com/home-assistant/home-assistant/pull/14051 +[#14074]: https://github.com/home-assistant/home-assistant/pull/14074 +[#14080]: https://github.com/home-assistant/home-assistant/pull/14080 +[#14097]: https://github.com/home-assistant/home-assistant/pull/14097 +[@B1tMaster]: https://github.com/B1tMaster +[@ChristianKuehnel]: https://github.com/ChristianKuehnel +[@Danielhiversen]: https://github.com/Danielhiversen +[@GotoCode]: https://github.com/GotoCode +[@Juggels]: https://github.com/Juggels +[@KJonline]: https://github.com/KJonline +[@Kane610]: https://github.com/Kane610 +[@Kirchoff]: https://github.com/Kirchoff +[@Marco98]: https://github.com/Marco98 +[@MisterWil]: https://github.com/MisterWil +[@NovapaX]: https://github.com/NovapaX +[@OttoWinter]: https://github.com/OttoWinter +[@Paxy]: https://github.com/Paxy +[@Shou]: https://github.com/Shou +[@TheCellMC]: https://github.com/TheCellMC +[@Yonsm]: https://github.com/Yonsm +[@aav7fl]: https://github.com/aav7fl +[@andersonshatch]: https://github.com/andersonshatch +[@armills]: https://github.com/armills +[@balloob]: https://github.com/balloob +[@cdce8p]: https://github.com/cdce8p +[@cgtobi]: https://github.com/cgtobi +[@citruz]: https://github.com/citruz +[@dangyuluo]: https://github.com/dangyuluo +[@danielperna84]: https://github.com/danielperna84 +[@dersger]: https://github.com/dersger +[@dgomes]: https://github.com/dgomes +[@dlbroadfoot]: https://github.com/dlbroadfoot +[@escoand]: https://github.com/escoand +[@fabaff]: https://github.com/fabaff +[@geekofweek]: https://github.com/geekofweek +[@gerard33]: https://github.com/gerard33 +[@hmn]: https://github.com/hmn +[@hthiery]: https://github.com/hthiery +[@karlkar]: https://github.com/karlkar +[@kellerza]: https://github.com/kellerza +[@koolsb]: https://github.com/koolsb +[@marthoc]: https://github.com/marthoc +[@meauxt]: https://github.com/meauxt +[@michaelkuty]: https://github.com/michaelkuty +[@mjg59]: https://github.com/mjg59 +[@molobrakos]: https://github.com/molobrakos +[@nickw444]: https://github.com/nickw444 +[@no2chem]: https://github.com/no2chem +[@pascalhahn]: https://github.com/pascalhahn +[@philk]: https://github.com/philk +[@pvizeli]: https://github.com/pvizeli +[@rcloran]: https://github.com/rcloran +[@reefab]: https://github.com/reefab +[@robmarkcole]: https://github.com/robmarkcole +[@rohankapoorcom]: https://github.com/rohankapoorcom +[@schmittx]: https://github.com/schmittx +[@shred86]: https://github.com/shred86 +[@stephanerosi]: https://github.com/stephanerosi +[@swilson]: https://github.com/swilson +[@syssi]: https://github.com/syssi +[@thelittlefireman]: https://github.com/thelittlefireman +[@thrawnarn]: https://github.com/thrawnarn +[@titilambert]: https://github.com/titilambert +[@tobygray]: https://github.com/tobygray +[@tschmidty69]: https://github.com/tschmidty69 +[@veleek]: https://github.com/veleek +[@viorels]: https://github.com/viorels +[@wiuwiu]: https://github.com/wiuwiu +[@xTCx]: https://github.com/xTCx +[abode docs]: /components/abode/ +[alexa docs]: /components/alexa/ +[binary_sensor.bmw_connected_drive docs]: /components/binary_sensor.bmw_connected_drive/ +[binary_sensor.hive docs]: /components/binary_sensor.hive/ +[binary_sensor.maxcube docs]: /components/binary_sensor.maxcube/ +[binary_sensor.qwikswitch docs]: /components/binary_sensor.qwikswitch/ +[bmw_connected_drive docs]: /components/bmw_connected_drive/ +[calendar.google docs]: /components/calendar.google/ +[calendar.todoist docs]: /components/calendar.todoist/ +[climate.fritzbox docs]: /components/climate.fritzbox/ +[climate.hive docs]: /components/climate.hive/ +[climate.honeywell docs]: /components/climate.honeywell/ +[climate.maxcube docs]: /components/climate.maxcube/ +[climate.modbus docs]: /components/climate.modbus/ +[config docs]: /components/config/ +[cover.opengarage docs]: /components/cover.opengarage/ +[cover.tahoma docs]: /components/cover.tahoma/ +[deconz docs]: /components/deconz/ +[device_tracker docs]: /components/device_tracker/ +[ecobee docs]: /components/ecobee/ +[eufy docs]: /components/eufy/ +[fan.xiaomi_miio docs]: /components/fan.xiaomi_miio/ +[fritzbox docs]: /components/fritzbox/ +[google docs]: /components/google/ +[hdmi_cec docs]: /components/hdmi_cec/ +[hive docs]: /components/hive/ +[homekit docs]: /components/homekit/ +[homekit_controller docs]: /components/homekit_controller/ +[homematic docs]: /components/homematic/ +[hue docs]: /components/hue/ +[ihc docs]: /components/ihc/ +[light docs]: /components/light/ +[light.abode docs]: /components/light.abode/ +[light.aurora docs]: /components/light.aurora/ +[light.eufy docs]: /components/light.eufy/ +[light.hive docs]: /components/light.hive/ +[light.homekit_controller docs]: /components/light.homekit_controller/ +[light.hue docs]: /components/light.hue/ +[light.yeelight docs]: /components/light.yeelight/ +[lock.bmw_connected_drive docs]: /components/lock.bmw_connected_drive/ +[lutron_caseta docs]: /components/lutron_caseta/ +[maxcube docs]: /components/maxcube/ +[media_extractor docs]: /components/media_extractor/ +[media_player.blackbird docs]: /components/media_player.blackbird/ +[media_player.bluesound docs]: /components/media_player.bluesound/ +[media_player.cast docs]: /components/media_player.cast/ +[media_player.kodi docs]: /components/media_player.kodi/ +[media_player.mediaroom docs]: /components/media_player.mediaroom/ +[media_player.mpd docs]: /components/media_player.mpd/ +[media_player.onkyo docs]: /components/media_player.onkyo/ +[media_player.squeezebox docs]: /components/media_player.squeezebox/ +[media_player.webostv docs]: /components/media_player.webostv/ +[notify docs]: /components/notify/ +[notify.facebook docs]: /components/notify.facebook/ +[prometheus docs]: /components/prometheus/ +[qwikswitch docs]: /components/qwikswitch/ +[sensor docs]: /components/sensor/ +[sensor.alpha_vantage docs]: /components/sensor.alpha_vantage/ +[sensor.bmw_connected_drive docs]: /components/sensor.bmw_connected_drive/ +[sensor.broadlink docs]: /components/sensor.broadlink/ +[sensor.deconz docs]: /components/sensor.deconz/ +[sensor.ebox docs]: /components/sensor.ebox/ +[sensor.ecobee docs]: /components/sensor.ecobee/ +[sensor.eddystone_temperature docs]: /components/sensor.eddystone_temperature/ +[sensor.filter docs]: /components/sensor.filter/ +[sensor.folder docs]: /components/sensor.folder/ +[sensor.foobot docs]: /components/sensor.foobot/ +[sensor.fritzbox_netmonitor docs]: /components/sensor.fritzbox_netmonitor/ +[sensor.hive docs]: /components/sensor.hive/ +[sensor.hydroquebec docs]: /components/sensor.hydroquebec/ +[sensor.linux_battery docs]: /components/sensor.linux_battery/ +[sensor.miflora docs]: /components/sensor.miflora/ +[sensor.mqtt docs]: /components/sensor.mqtt/ +[sensor.nest docs]: /components/sensor.nest/ +[sensor.nut docs]: /components/sensor.nut/ +[sensor.qwikswitch docs]: /components/sensor.qwikswitch/ +[sensor.sht31 docs]: /components/sensor.sht31/ +[sensor.sigfox docs]: /components/sensor.sigfox/ +[sensor.smappee docs]: /components/sensor.smappee/ +[sensor.sql docs]: /components/sensor.sql/ +[sensor.tibber docs]: /components/sensor.tibber/ +[sensor.trafikverket_weatherstation docs]: /components/sensor.trafikverket_weatherstation/ +[sensor.upnp docs]: /components/sensor.upnp/ +[sensor.uscis docs]: /components/sensor.uscis/ +[skybell docs]: /components/skybell/ +[smappee docs]: /components/smappee/ +[snips docs]: /components/snips/ +[switch.broadlink docs]: /components/switch.broadlink/ +[switch.edimax docs]: /components/switch.edimax/ +[switch.eufy docs]: /components/switch.eufy/ +[switch.fritzbox docs]: /components/switch.fritzbox/ +[switch.hive docs]: /components/switch.hive/ +[switch.vesync docs]: /components/switch.vesync/ +[tts docs]: /components/tts/ +[upnp docs]: /components/upnp/ +[vacuum docs]: /components/vacuum/ +[vacuum.dyson docs]: /components/vacuum.dyson/ +[vacuum.neato docs]: /components/vacuum.neato/ +[vacuum.roomba docs]: /components/vacuum.roomba/ +[vacuum.xiaomi_miio docs]: /components/vacuum.xiaomi_miio/ +[weather.yweather docs]: /components/weather.yweather/ +[zha docs]: /components/zha/ +[#14108]: https://github.com/home-assistant/home-assistant/pull/14108 +[#14113]: https://github.com/home-assistant/home-assistant/pull/14113 +[#14154]: https://github.com/home-assistant/home-assistant/pull/14154 +[#14160]: https://github.com/home-assistant/home-assistant/pull/14160 +[#14163]: https://github.com/home-assistant/home-assistant/pull/14163 +[#14181]: https://github.com/home-assistant/home-assistant/pull/14181 +[#14190]: https://github.com/home-assistant/home-assistant/pull/14190 +[#14196]: https://github.com/home-assistant/home-assistant/pull/14196 +[#14156]: https://github.com/home-assistant/home-assistant/pull/14156 +[@OttoWinter]: https://github.com/OttoWinter +[@amelchio]: https://github.com/amelchio +[@balloob]: https://github.com/balloob +[@cdce8p]: https://github.com/cdce8p +[@mjg59]: https://github.com/mjg59 +[google_assistant docs]: /components/google_assistant/ +[homekit docs]: /components/homekit/ +[homekit_controller docs]: /components/homekit_controller/ +[light.hue docs]: /components/light.hue/ +[light.tplink docs]: /components/light.tplink/ +[media_player.cast docs]: /components/media_player.cast/ \ No newline at end of file diff --git a/source/_posts/2018-05-11-release-69.markdown b/source/_posts/2018-05-11-release-69.markdown new file mode 100644 index 0000000000..4063660e8c --- /dev/null +++ b/source/_posts/2018-05-11-release-69.markdown @@ -0,0 +1,459 @@ +--- +layout: post +title: "0.69: TBD - Update date" +description: "TBD." +date: 2018-05-05 00:01:00 +date_formatted: "May 11, 2018" +author: Paulus Schoutsen +author_twitter: balloob +comments: true +categories: Release-Notes +og_image: /images/blog/2018-05-0.69/components.png +--- + + + +## {% linkable_title New Platforms %} + +- New sensor domain expiry ([@masarliev] - [#14067]) ([sensor.domain_expiry docs]) (new-platform) +- Support Xiaomi Mijia Bluetooth Wireless Temperature and Humidity Sensor ([@ratcashdev] - [#13955]) ([sensor.mitemp_bt docs]) (new-platform) +- Move RainMachine to component/hub model ([@bachya] - [#14085]) ([rainmachine docs]) ([switch.rainmachine docs]) (breaking change) (new-platform) +- Foundation for users ([@balloob] - [#13968]) ([auth docs]) ([http docs]) (new-platform) +- Add Social Blade Sensor ([@meauxt] - [#14060]) ([sensor.socialblade docs]) ([sensor.uscis docs]) (new-platform) +- Add PostNL sensor (Dutch Postal Services) ([@iMicknl] - [#12366]) ([sensor.postnl docs]) (new-platform) +- Issue/add template fans ([@giangvo] - [#12027]) ([fan.template docs]) (new-platform) +- Matrix Chatbot ([@tinloaf] - [#13355]) ([matrix docs]) ([notify docs]) (breaking change) (new-platform) + +## {% linkable_title If you need help... %} + +...don't hesitate to use our very active [forums](https://community.home-assistant.io/) or join us for a little [chat](https://discord.gg/c5DvZ4e). The release notes have comments enabled but it's preferred if you use the former communication channels. Thanks. + +## {% linkable_title Reporting Issues %} + +Experiencing issues introduced by this release? Please report them in our [issue tracker](https://github.com/home-assistant/home-assistant/issues). Make sure to fill in all fields of the issue template. + + +## {% linkable_title Breaking Changes %} + +- Pollen.com: Added attributes on top 3 allergens ([@bachya] - [#14018]) ([sensor.pollen docs]) (breaking change) +- Add Sonos device attribute with grouping information ([@amelchio] - [#13553]) ([media_player.sonos docs]) (breaking change) +- Re-implement HomematicIP cloud to async ([@mxworm] - [#13468]) ([homematicip_cloud docs]) ([sensor.homematicip_cloud docs]) (breaking change) +- Move RainMachine to component/hub model ([@bachya] - [#14085]) ([rainmachine docs]) ([switch.rainmachine docs]) (breaking change) (new-platform) +- System log: make firing event optional ([@balloob] - [#14102]) ([system_log docs]) (breaking change) +- Disable eliqonline requirement ([@balloob] - [#14156]) ([sensor.eliqonline docs]) (breaking change) +- Custom component loading cleanup ([@balloob] - [#14211]) (breaking change) +- Converts RainMachine to hub model (part 2) ([@bachya] - [#14225]) ([rainmachine docs]) ([switch.rainmachine docs]) (breaking change) +- Homekit: Changed device_class requirement Humidity Sensor ([@cdce8p] - [#14277]) ([homekit docs]) (breaking change) +- Sensor device classes ([@cdce8p] - [#14282]) ([sensor docs]) (breaking change) +- Matrix Chatbot ([@tinloaf] - [#13355]) ([matrix docs]) ([notify docs]) (breaking change) (new-platform) + +## {% linkable_title Beta Fixes %} + +- Add missing 'sensor' to ABODE_PLATFORMS ([@jloutsenhizer] - [#14313]) ([abode docs]) (beta fix) +- Add debounce to move_cover ([@cdce8p] - [#14314]) ([homekit docs]) (beta fix) +- Fix module names for custom components ([@balloob] - [#14317]) (beta fix) +- Revert custom component loading logic ([@balloob] - [#14327]) (beta fix) +- fix(hbmqtt): partial packets breaking hbmqtt ([@graffic] - [#14329]) ([mqtt docs]) (beta fix) +- Fix Yeelight naming ([@syssi]) + +## {% linkable_title All changes %} + +- Pollen.com: Added attributes on top 3 allergens ([@bachya] - [#14018]) ([sensor.pollen docs]) (breaking change) +- Expose the condition code on condition sensors ([@maddox] - [#14011]) ([sensor.yweather docs]) +- upgrade rfxtrx lib, dimming support for Lighting3 ([@Danielhiversen] - [#14026]) ([rfxtrx docs]) +- Add Accuracy to Google Location Sharing ([@rdbahm] - [#14039]) ([device_tracker docs]) +- bump gogogate2 version ([@dlbroadfoot] - [#14044]) ([cover.gogogate2 docs]) +- device_tracker.ubus: catch ConnectionError ([@stintel] - [#14045]) ([device_tracker docs]) +- Show a notification when a config entry is discovered ([@balloob] - [#14022]) +- deCONZ use forward entry setup ([@Kane610] - [#13990]) ([binary_sensor docs]) ([deconz docs]) ([scene docs]) ([sensor docs]) ([binary_sensor.deconz docs]) ([light.deconz docs]) ([scene.deconz docs]) ([sensor.deconz docs]) +- Bump pyEight version to update API & reduce connection issues ([@mezz64] - [#14058]) ([eight_sleep docs]) +- Bump locationsharinglib to 1.2.2 ([@thelittlefireman] - [#14070]) ([device_tracker docs]) +- Remove excessive debugging in webostv module ([@stephanerosi] - [#14056]) ([media_player.webostv docs]) +- Support new Xiaomi Aqara device model names and LAN protocol 2.0 ([@ileler] - [#13540]) ([xiaomi_aqara docs]) ([binary_sensor.xiaomi_aqara docs]) ([light.xiaomi_aqara docs]) ([sensor.xiaomi_aqara docs]) ([switch.xiaomi_aqara docs]) +- Add devices to Tahoma ([@bakedraccoon] - [#14075]) ([tahoma docs]) ([cover.tahoma docs]) ([sensor.tahoma docs]) +- New sensor domain expiry ([@masarliev] - [#14067]) ([sensor.domain_expiry docs]) (new-platform) +- Modify weather components for "new" frontend card ([@c727] - [#14076]) ([weather.buienradar docs]) ([weather.darksky docs]) ([weather.openweathermap docs]) +- Add Sonos device attribute with grouping information ([@amelchio] - [#13553]) ([media_player.sonos docs]) (breaking change) +- Re-implement HomematicIP cloud to async ([@mxworm] - [#13468]) ([homematicip_cloud docs]) ([sensor.homematicip_cloud docs]) (breaking change) +- Update pyhomematic to 0.1.42 ([@danielperna84] - [#14095]) ([homematic docs]) +- Adds update file_path service to local_file camera ([@robmarkcole] - [#13976]) ([camera.local_file docs]) +- Zone component config entry support ([@Kane610] - [#14059]) ([zone docs]) +- Improve MQTT topic validation ([@OttoWinter] - [#14099]) ([mqtt docs]) +- Fix the optional friendly name of the Yeelight (Closes: #14088) ([@syssi] - [#14110]) ([light.yeelight docs]) +- Update QNAP lib to 0.2.6; handle null temps gracefully ([@colinodell] - [#14117]) ([sensor.qnap docs]) +- Support Xiaomi Mijia Bluetooth Wireless Temperature and Humidity Sensor ([@ratcashdev] - [#13955]) ([sensor.mitemp_bt docs]) (new-platform) +- Upgrade colorlog to 3.1.4 ([@fabaff] - [#14132]) +- Move RainMachine to component/hub model ([@bachya] - [#14085]) ([rainmachine docs]) ([switch.rainmachine docs]) (breaking change) (new-platform) +- Add support for light sensors with 'lx' unit to HomeKit ([@bieniu] - [#14131]) ([homekit docs]) +- Upgrade restrictedpython to 4.0b3 ([@fabaff] - [#14140]) ([python_script docs]) +- Logitech Pop support for emulated_hue component ([@dgraye] - [#12833]) ([emulated_hue docs]) +- Bump pyvizio to 0.0.3 ([@cgarwood] - [#14147]) ([media_player.vizio docs]) +- System log: make firing event optional ([@balloob] - [#14102]) ([system_log docs]) (breaking change) +- Upgrade pylast to 2.2.0 ([@fabaff] - [#14139]) ([sensor.lastfm docs]) +- Upgrade sqlalchemy to 1.2.7 ([@fabaff] - [#14138]) +- Upgrade tapsaff to 0.2.0 ([@fabaff] - [#14137]) ([binary_sensor.tapsaff docs]) +- Upgrade python-telegram-bot to 10.0.2 ([@fabaff] - [#14144]) +- Upgrade youtube_dl to 2018.04.25 ([@fabaff] - [#14136]) ([media_extractor docs]) +- Clean up HomeKit accessory information characteristics ([@schmittx] - [#14114]) ([homekit docs]) +- Upgrade psutil to 5.4.5 ([@fabaff] - [#14135]) +- Fixed datetime values ([@gives1976] - [#14153]) ([sensor.sql docs]) +- deluge-components-update ([@engrbm87] - [#14016]) ([sensor.deluge docs]) ([switch.deluge docs]) +- Light mqtt_json: Add HS color support ([@OttoWinter] - [#14029]) ([light.mqtt_json docs]) +- Convert more files to async/await syntax ([@OttoWinter] - [#14142]) +- Disable eliqonline requirement ([@balloob] - [#14156]) ([sensor.eliqonline docs]) (breaking change) +- deCONZ allow unloading of config entry ([@Kane610] - [#14115]) ([binary_sensor docs]) ([deconz docs]) ([scene docs]) ([sensor docs]) +- Upgrade netdisco to 1.4.0 ([@fabaff] - [#14152]) +- Add precipitation to OpenWeatherMap forecast ([@escoand] - [#13971]) ([weather.openweathermap docs]) +- Allow transitioning to colour temp for tradfri ([@Hate-Usernames] - [#14157]) +- Added update_interval to maxcube ([@dingusdk] - [#14143]) ([maxcube docs]) +- zha: Support remotes/buttons ([@rcloran] - [#12528]) ([zha docs]) ([binary_sensor.zha docs]) +- Upgrade numpy to 1.14.3 ([@fabaff] - [#14187]) ([binary_sensor.trend docs]) ([image_processing.opencv docs]) +- Updating darksky default update interval to 5 mins ([@msubra] - [#14195]) ([sensor.darksky docs]) +- Fix TypeError on round(self.humidity) (fixes #13116) ([@mvn23] - [#14174]) ([weather docs]) +- Add room hint support to Google Assistant cloud ([@balloob] - [#14180]) +- Update CODEOWNERS ([@pschmitt] - [#14214]) +- Fixes #14169 (Upgrade pyupnp-async to 0.1.0.2) ([@dgomes] - [#14210]) ([upnp docs]) +- zha: Clean up binary_sensor listener registration/state updates ([@rcloran] - [#14197]) +- HomematicIP cloud: Add logic to check accesspoint connection state ([@sander76] - [#14203]) ([homematicip_cloud docs]) +- Foundation for users ([@balloob] - [#13968]) ([auth docs]) ([http docs]) (new-platform) +- Allow easy extension of websocket API ([@balloob] - [#14186]) ([frontend docs]) ([websocket_api docs]) +- Change the divisor for total consumption output ([@CM000n] - [#14215]) ([switch.fritzbox docs]) +- Upgrade mypy to 0.590 ([@fabaff] - [#14207]) +- Template Sensor add device_class support ([@OttoWinter] - [#14034]) ([sensor.template docs]) +- Add more parameters for DSMR sensor ([@rubenvandeven] - [#13967]) ([sensor.dsmr docs]) +- Support setting explicit mute value for Panasonic Viera TV ([@blackwind] - [#13954]) ([media_player.panasonic_viera docs]) +- Allow to set a desired update interval for camera_proxy_stream view ([@NovapaX] - [#13350]) ([camera docs]) +- panasonic_viera: Provide unique_id from SSDP UDN, if available ([@scop] - [#13541]) ([media_player.panasonic_viera docs]) +- Custom component loading cleanup ([@balloob] - [#14211]) (breaking change) +- Buienradar improvements: continuous sensors and unique ID's ([@corneyl] - [#13249]) ([sensor.buienradar docs]) +- add volumio discovery ([@escoand] - [#14220]) ([media_player.volumio docs]) +- Converts RainMachine to hub model (part 2) ([@bachya] - [#14225]) ([rainmachine docs]) ([switch.rainmachine docs]) (breaking change) +- Add MQTT Sensor device_class ([@OttoWinter] - [#14033]) ([sensor.mqtt docs]) +- Allow independent control of white level on flux_led component ([@oblogic7] - [#13985]) ([light.flux_led docs]) +- Add Social Blade Sensor ([@meauxt] - [#14060]) ([sensor.socialblade docs]) ([sensor.uscis docs]) (new-platform) +- UPnP code cleanup ([@dgomes] - [#14235]) ([upnp docs]) ([sensor.upnp docs]) +- Improve config schema of the blackbird component ([@syssi] - [#14007]) ([media_player.blackbird docs]) +- Add support for tracking devices on Netgear access points ([@MatMaul] - [#13331]) ([device_tracker docs]) +- WUnderground unique ids ([@OttoWinter] - [#13311]) ([sensor.wunderground docs]) +- Add PostNL sensor (Dutch Postal Services) ([@iMicknl] - [#12366]) ([sensor.postnl docs]) (new-platform) +- python_openzwave update config service ([@perosb] - [#12060]) ([zwave docs]) +- Add unique_id to zwave node entity ([@andrey-git] - [#14201]) ([zwave docs]) +- Add prereqs for HomeKit Controller ([@marthoc] - [#14172]) +- Restores switch state, case the switch is optimistic ([@dgomes] - [#14151]) ([switch.mqtt docs]) +- Issue/add template fans ([@giangvo] - [#12027]) ([fan.template docs]) (new-platform) +- HomeKit - Climate: power state on/off support ([@roiff] - [#14082]) ([homekit docs]) +- Demo Sensor - Added device_class support ([@cdce8p] - [#14269]) ([sensor.demo docs]) +- Re-enable eliqonline requirement ([@molobrakos] - [#14265]) ([sensor.eliqonline docs]) +- Add fetching camera thumbnails over websocket ([@balloob] - [#14231]) ([camera docs]) ([frontend docs]) ([image_processing docs]) ([microsoft_face docs]) ([websocket_api docs]) +- Allow fetching media player covers via websocket connection ([@balloob] - [#14233]) ([media_player docs]) +- Fix ZWave light brightness ([@cdce8p] - [#14261]) ([light.zwave docs]) +- fix check config not working after #14211 ([@fanthos] - [#14259]) +- Issue Template Fix CRLF ([@OttoWinter] - [#14283]) +- Upgrade attrs to 18.1.0 ([@fabaff] - [#14281]) +- Update HAP-python to 2.0.0 ([@cdce8p] - [#14278]) ([homekit docs]) +- Upgrade holidays to 0.9.5 ([@fabaff] - [#14274]) ([binary_sensor.workday docs]) +- Homekit: Changed device_class requirement Humidity Sensor ([@cdce8p] - [#14277]) ([homekit docs]) (breaking change) +- HomeKit: Support triggered state for alarm_control_panel ([@schmittx] - [#14285]) ([homekit docs]) +- Upgrade astral to 1.6.1 ([@fabaff] - [#14297]) +- BOM Weather throttle fix ([@nickw444] - [#14234]) ([sensor.bom docs]) +- Publish attributes unconditionally ([@blackwind] - [#14179]) ([mqtt_statestream docs]) +- Sensor device classes ([@cdce8p] - [#14282]) ([sensor docs]) (breaking change) +- Matrix Chatbot ([@tinloaf] - [#13355]) ([matrix docs]) ([notify docs]) (breaking change) (new-platform) +- deCONZ add new device without restart ([@Kane610] - [#14221]) ([deconz docs]) ([binary_sensor.deconz docs]) ([light.deconz docs]) ([sensor.deconz docs]) +- Add alarmdotcom sensor status ([@jnewland] - [#14254]) ([alarm_control_panel.alarmdotcom docs]) +- Add domain to labels and count state changes to Prometheus ([@jnewland] - [#14253]) ([prometheus docs]) +- Add support for max_volume ([@relvacode] - [#13822]) ([media_player.onkyo docs]) +- Refactor ImageProcessingFaceEntity ([@robmarkcole] - [#14296]) ([image_processing docs]) ([image_processing.demo docs]) ([image_processing.dlib_face_detect docs]) ([image_processing.dlib_face_identify docs]) ([image_processing.microsoft_face_detect docs]) ([image_processing.microsoft_face_identify docs]) +- Onkyo: SUPPORT_VOLUME_STEP ([@rsmeral] - [#14299]) ([media_player.onkyo docs]) +- Add All-Linking capabilities ([@teharris1] - [#14065]) ([insteon_plm docs]) ([binary_sensor.insteon_plm docs]) ([fan.insteon_plm docs]) ([light.insteon_plm docs]) ([sensor.insteon_plm docs]) ([switch.insteon_plm docs]) +- Add missing 'sensor' to ABODE_PLATFORMS ([@jloutsenhizer] - [#14313]) ([abode docs]) (beta fix) +- Add debounce to move_cover ([@cdce8p] - [#14314]) ([homekit docs]) (beta fix) +- Fix module names for custom components ([@balloob] - [#14317]) (beta fix) +- Revert custom component loading logic ([@balloob] - [#14327]) (beta fix) +- fix(hbmqtt): partial packets breaking hbmqtt ([@graffic] - [#14329]) ([mqtt docs]) (beta fix) + +[#12027]: https://github.com/home-assistant/home-assistant/pull/12027 +[#12060]: https://github.com/home-assistant/home-assistant/pull/12060 +[#12366]: https://github.com/home-assistant/home-assistant/pull/12366 +[#12528]: https://github.com/home-assistant/home-assistant/pull/12528 +[#12833]: https://github.com/home-assistant/home-assistant/pull/12833 +[#13249]: https://github.com/home-assistant/home-assistant/pull/13249 +[#13311]: https://github.com/home-assistant/home-assistant/pull/13311 +[#13331]: https://github.com/home-assistant/home-assistant/pull/13331 +[#13350]: https://github.com/home-assistant/home-assistant/pull/13350 +[#13355]: https://github.com/home-assistant/home-assistant/pull/13355 +[#13468]: https://github.com/home-assistant/home-assistant/pull/13468 +[#13540]: https://github.com/home-assistant/home-assistant/pull/13540 +[#13541]: https://github.com/home-assistant/home-assistant/pull/13541 +[#13553]: https://github.com/home-assistant/home-assistant/pull/13553 +[#13822]: https://github.com/home-assistant/home-assistant/pull/13822 +[#13954]: https://github.com/home-assistant/home-assistant/pull/13954 +[#13955]: https://github.com/home-assistant/home-assistant/pull/13955 +[#13967]: https://github.com/home-assistant/home-assistant/pull/13967 +[#13968]: https://github.com/home-assistant/home-assistant/pull/13968 +[#13971]: https://github.com/home-assistant/home-assistant/pull/13971 +[#13976]: https://github.com/home-assistant/home-assistant/pull/13976 +[#13985]: https://github.com/home-assistant/home-assistant/pull/13985 +[#13990]: https://github.com/home-assistant/home-assistant/pull/13990 +[#14007]: https://github.com/home-assistant/home-assistant/pull/14007 +[#14011]: https://github.com/home-assistant/home-assistant/pull/14011 +[#14016]: https://github.com/home-assistant/home-assistant/pull/14016 +[#14018]: https://github.com/home-assistant/home-assistant/pull/14018 +[#14022]: https://github.com/home-assistant/home-assistant/pull/14022 +[#14026]: https://github.com/home-assistant/home-assistant/pull/14026 +[#14029]: https://github.com/home-assistant/home-assistant/pull/14029 +[#14033]: https://github.com/home-assistant/home-assistant/pull/14033 +[#14034]: https://github.com/home-assistant/home-assistant/pull/14034 +[#14039]: https://github.com/home-assistant/home-assistant/pull/14039 +[#14044]: https://github.com/home-assistant/home-assistant/pull/14044 +[#14045]: https://github.com/home-assistant/home-assistant/pull/14045 +[#14056]: https://github.com/home-assistant/home-assistant/pull/14056 +[#14058]: https://github.com/home-assistant/home-assistant/pull/14058 +[#14059]: https://github.com/home-assistant/home-assistant/pull/14059 +[#14060]: https://github.com/home-assistant/home-assistant/pull/14060 +[#14065]: https://github.com/home-assistant/home-assistant/pull/14065 +[#14067]: https://github.com/home-assistant/home-assistant/pull/14067 +[#14070]: https://github.com/home-assistant/home-assistant/pull/14070 +[#14075]: https://github.com/home-assistant/home-assistant/pull/14075 +[#14076]: https://github.com/home-assistant/home-assistant/pull/14076 +[#14082]: https://github.com/home-assistant/home-assistant/pull/14082 +[#14085]: https://github.com/home-assistant/home-assistant/pull/14085 +[#14095]: https://github.com/home-assistant/home-assistant/pull/14095 +[#14099]: https://github.com/home-assistant/home-assistant/pull/14099 +[#14102]: https://github.com/home-assistant/home-assistant/pull/14102 +[#14110]: https://github.com/home-assistant/home-assistant/pull/14110 +[#14114]: https://github.com/home-assistant/home-assistant/pull/14114 +[#14115]: https://github.com/home-assistant/home-assistant/pull/14115 +[#14117]: https://github.com/home-assistant/home-assistant/pull/14117 +[#14131]: https://github.com/home-assistant/home-assistant/pull/14131 +[#14132]: https://github.com/home-assistant/home-assistant/pull/14132 +[#14135]: https://github.com/home-assistant/home-assistant/pull/14135 +[#14136]: https://github.com/home-assistant/home-assistant/pull/14136 +[#14137]: https://github.com/home-assistant/home-assistant/pull/14137 +[#14138]: https://github.com/home-assistant/home-assistant/pull/14138 +[#14139]: https://github.com/home-assistant/home-assistant/pull/14139 +[#14140]: https://github.com/home-assistant/home-assistant/pull/14140 +[#14142]: https://github.com/home-assistant/home-assistant/pull/14142 +[#14143]: https://github.com/home-assistant/home-assistant/pull/14143 +[#14144]: https://github.com/home-assistant/home-assistant/pull/14144 +[#14147]: https://github.com/home-assistant/home-assistant/pull/14147 +[#14151]: https://github.com/home-assistant/home-assistant/pull/14151 +[#14152]: https://github.com/home-assistant/home-assistant/pull/14152 +[#14153]: https://github.com/home-assistant/home-assistant/pull/14153 +[#14156]: https://github.com/home-assistant/home-assistant/pull/14156 +[#14157]: https://github.com/home-assistant/home-assistant/pull/14157 +[#14172]: https://github.com/home-assistant/home-assistant/pull/14172 +[#14174]: https://github.com/home-assistant/home-assistant/pull/14174 +[#14179]: https://github.com/home-assistant/home-assistant/pull/14179 +[#14180]: https://github.com/home-assistant/home-assistant/pull/14180 +[#14186]: https://github.com/home-assistant/home-assistant/pull/14186 +[#14187]: https://github.com/home-assistant/home-assistant/pull/14187 +[#14195]: https://github.com/home-assistant/home-assistant/pull/14195 +[#14197]: https://github.com/home-assistant/home-assistant/pull/14197 +[#14201]: https://github.com/home-assistant/home-assistant/pull/14201 +[#14203]: https://github.com/home-assistant/home-assistant/pull/14203 +[#14207]: https://github.com/home-assistant/home-assistant/pull/14207 +[#14210]: https://github.com/home-assistant/home-assistant/pull/14210 +[#14211]: https://github.com/home-assistant/home-assistant/pull/14211 +[#14214]: https://github.com/home-assistant/home-assistant/pull/14214 +[#14215]: https://github.com/home-assistant/home-assistant/pull/14215 +[#14220]: https://github.com/home-assistant/home-assistant/pull/14220 +[#14221]: https://github.com/home-assistant/home-assistant/pull/14221 +[#14225]: https://github.com/home-assistant/home-assistant/pull/14225 +[#14231]: https://github.com/home-assistant/home-assistant/pull/14231 +[#14233]: https://github.com/home-assistant/home-assistant/pull/14233 +[#14234]: https://github.com/home-assistant/home-assistant/pull/14234 +[#14235]: https://github.com/home-assistant/home-assistant/pull/14235 +[#14253]: https://github.com/home-assistant/home-assistant/pull/14253 +[#14254]: https://github.com/home-assistant/home-assistant/pull/14254 +[#14259]: https://github.com/home-assistant/home-assistant/pull/14259 +[#14261]: https://github.com/home-assistant/home-assistant/pull/14261 +[#14265]: https://github.com/home-assistant/home-assistant/pull/14265 +[#14269]: https://github.com/home-assistant/home-assistant/pull/14269 +[#14274]: https://github.com/home-assistant/home-assistant/pull/14274 +[#14277]: https://github.com/home-assistant/home-assistant/pull/14277 +[#14278]: https://github.com/home-assistant/home-assistant/pull/14278 +[#14281]: https://github.com/home-assistant/home-assistant/pull/14281 +[#14282]: https://github.com/home-assistant/home-assistant/pull/14282 +[#14283]: https://github.com/home-assistant/home-assistant/pull/14283 +[#14285]: https://github.com/home-assistant/home-assistant/pull/14285 +[#14296]: https://github.com/home-assistant/home-assistant/pull/14296 +[#14297]: https://github.com/home-assistant/home-assistant/pull/14297 +[#14299]: https://github.com/home-assistant/home-assistant/pull/14299 +[#14313]: https://github.com/home-assistant/home-assistant/pull/14313 +[#14314]: https://github.com/home-assistant/home-assistant/pull/14314 +[#14317]: https://github.com/home-assistant/home-assistant/pull/14317 +[#14327]: https://github.com/home-assistant/home-assistant/pull/14327 +[#14329]: https://github.com/home-assistant/home-assistant/pull/14329 +[@CM000n]: https://github.com/CM000n +[@Danielhiversen]: https://github.com/Danielhiversen +[@Hate-Usernames]: https://github.com/Hate-Usernames +[@Kane610]: https://github.com/Kane610 +[@MatMaul]: https://github.com/MatMaul +[@NovapaX]: https://github.com/NovapaX +[@OttoWinter]: https://github.com/OttoWinter +[@amelchio]: https://github.com/amelchio +[@andrey-git]: https://github.com/andrey-git +[@bachya]: https://github.com/bachya +[@bakedraccoon]: https://github.com/bakedraccoon +[@balloob]: https://github.com/balloob +[@bieniu]: https://github.com/bieniu +[@blackwind]: https://github.com/blackwind +[@c727]: https://github.com/c727 +[@cdce8p]: https://github.com/cdce8p +[@cgarwood]: https://github.com/cgarwood +[@colinodell]: https://github.com/colinodell +[@corneyl]: https://github.com/corneyl +[@danielperna84]: https://github.com/danielperna84 +[@dgomes]: https://github.com/dgomes +[@dgraye]: https://github.com/dgraye +[@dingusdk]: https://github.com/dingusdk +[@dlbroadfoot]: https://github.com/dlbroadfoot +[@engrbm87]: https://github.com/engrbm87 +[@escoand]: https://github.com/escoand +[@fabaff]: https://github.com/fabaff +[@fanthos]: https://github.com/fanthos +[@giangvo]: https://github.com/giangvo +[@gives1976]: https://github.com/gives1976 +[@graffic]: https://github.com/graffic +[@iMicknl]: https://github.com/iMicknl +[@ileler]: https://github.com/ileler +[@jloutsenhizer]: https://github.com/jloutsenhizer +[@jnewland]: https://github.com/jnewland +[@maddox]: https://github.com/maddox +[@marthoc]: https://github.com/marthoc +[@masarliev]: https://github.com/masarliev +[@meauxt]: https://github.com/meauxt +[@mezz64]: https://github.com/mezz64 +[@molobrakos]: https://github.com/molobrakos +[@msubra]: https://github.com/msubra +[@mvn23]: https://github.com/mvn23 +[@mxworm]: https://github.com/mxworm +[@nickw444]: https://github.com/nickw444 +[@oblogic7]: https://github.com/oblogic7 +[@perosb]: https://github.com/perosb +[@pschmitt]: https://github.com/pschmitt +[@ratcashdev]: https://github.com/ratcashdev +[@rcloran]: https://github.com/rcloran +[@rdbahm]: https://github.com/rdbahm +[@relvacode]: https://github.com/relvacode +[@robmarkcole]: https://github.com/robmarkcole +[@roiff]: https://github.com/roiff +[@rsmeral]: https://github.com/rsmeral +[@rubenvandeven]: https://github.com/rubenvandeven +[@sander76]: https://github.com/sander76 +[@schmittx]: https://github.com/schmittx +[@scop]: https://github.com/scop +[@stephanerosi]: https://github.com/stephanerosi +[@stintel]: https://github.com/stintel +[@syssi]: https://github.com/syssi +[@teharris1]: https://github.com/teharris1 +[@thelittlefireman]: https://github.com/thelittlefireman +[@tinloaf]: https://github.com/tinloaf +[abode docs]: /components/abode/ +[alarm_control_panel.alarmdotcom docs]: /components/alarm_control_panel.alarmdotcom/ +[auth docs]: /components/auth/ +[binary_sensor docs]: /components/binary_sensor/ +[binary_sensor.deconz docs]: /components/binary_sensor.deconz/ +[binary_sensor.insteon_plm docs]: /components/binary_sensor.insteon_plm/ +[binary_sensor.tapsaff docs]: /components/binary_sensor.tapsaff/ +[binary_sensor.trend docs]: /components/binary_sensor.trend/ +[binary_sensor.workday docs]: /components/binary_sensor.workday/ +[binary_sensor.xiaomi_aqara docs]: /components/binary_sensor.xiaomi_aqara/ +[binary_sensor.zha docs]: /components/binary_sensor.zha/ +[camera docs]: /components/camera/ +[camera.local_file docs]: /components/camera.local_file/ +[cover.gogogate2 docs]: /components/cover.gogogate2/ +[cover.tahoma docs]: /components/cover.tahoma/ +[deconz docs]: /components/deconz/ +[device_tracker docs]: /components/device_tracker/ +[eight_sleep docs]: /components/eight_sleep/ +[emulated_hue docs]: /components/emulated_hue/ +[fan.insteon_plm docs]: /components/fan.insteon_plm/ +[fan.template docs]: /components/fan.template/ +[frontend docs]: /components/frontend/ +[homekit docs]: /components/homekit/ +[homematic docs]: /components/homematic/ +[homematicip_cloud docs]: /components/homematicip_cloud/ +[http docs]: /components/http/ +[image_processing docs]: /components/image_processing/ +[image_processing.demo docs]: /components/image_processing.demo/ +[image_processing.dlib_face_detect docs]: /components/image_processing.dlib_face_detect/ +[image_processing.dlib_face_identify docs]: /components/image_processing.dlib_face_identify/ +[image_processing.microsoft_face_detect docs]: /components/image_processing.microsoft_face_detect/ +[image_processing.microsoft_face_identify docs]: /components/image_processing.microsoft_face_identify/ +[image_processing.opencv docs]: /components/image_processing.opencv/ +[insteon_plm docs]: /components/insteon_plm/ +[light.deconz docs]: /components/light.deconz/ +[light.flux_led docs]: /components/light.flux_led/ +[light.insteon_plm docs]: /components/light.insteon_plm/ +[light.mqtt_json docs]: /components/light.mqtt_json/ +[light.xiaomi_aqara docs]: /components/light.xiaomi_aqara/ +[light.yeelight docs]: /components/light.yeelight/ +[light.zwave docs]: /components/light.zwave/ +[matrix docs]: /components/matrix/ +[maxcube docs]: /components/maxcube/ +[media_extractor docs]: /components/media_extractor/ +[media_player docs]: /components/media_player/ +[media_player.blackbird docs]: /components/media_player.blackbird/ +[media_player.onkyo docs]: /components/media_player.onkyo/ +[media_player.panasonic_viera docs]: /components/media_player.panasonic_viera/ +[media_player.sonos docs]: /components/media_player.sonos/ +[media_player.vizio docs]: /components/media_player.vizio/ +[media_player.volumio docs]: /components/media_player.volumio/ +[media_player.webostv docs]: /components/media_player.webostv/ +[microsoft_face docs]: /components/microsoft_face/ +[mqtt docs]: /components/mqtt/ +[mqtt_statestream docs]: /components/mqtt_statestream/ +[notify docs]: /components/notify/ +[prometheus docs]: /components/prometheus/ +[python_script docs]: /components/python_script/ +[rainmachine docs]: /components/rainmachine/ +[rfxtrx docs]: /components/rfxtrx/ +[scene docs]: /components/scene/ +[scene.deconz docs]: /components/scene.deconz/ +[sensor docs]: /components/sensor/ +[sensor.bom docs]: /components/sensor.bom/ +[sensor.buienradar docs]: /components/sensor.buienradar/ +[sensor.darksky docs]: /components/sensor.darksky/ +[sensor.deconz docs]: /components/sensor.deconz/ +[sensor.deluge docs]: /components/sensor.deluge/ +[sensor.demo docs]: /components/sensor.demo/ +[sensor.domain_expiry docs]: /components/sensor.domain_expiry/ +[sensor.dsmr docs]: /components/sensor.dsmr/ +[sensor.eliqonline docs]: /components/sensor.eliqonline/ +[sensor.homematicip_cloud docs]: /components/sensor.homematicip_cloud/ +[sensor.insteon_plm docs]: /components/sensor.insteon_plm/ +[sensor.lastfm docs]: /components/sensor.lastfm/ +[sensor.mitemp_bt docs]: /components/sensor.mitemp_bt/ +[sensor.mqtt docs]: /components/sensor.mqtt/ +[sensor.pollen docs]: /components/sensor.pollen/ +[sensor.postnl docs]: /components/sensor.postnl/ +[sensor.qnap docs]: /components/sensor.qnap/ +[sensor.socialblade docs]: /components/sensor.socialblade/ +[sensor.sql docs]: /components/sensor.sql/ +[sensor.tahoma docs]: /components/sensor.tahoma/ +[sensor.template docs]: /components/sensor.template/ +[sensor.upnp docs]: /components/sensor.upnp/ +[sensor.uscis docs]: /components/sensor.uscis/ +[sensor.wunderground docs]: /components/sensor.wunderground/ +[sensor.xiaomi_aqara docs]: /components/sensor.xiaomi_aqara/ +[sensor.yweather docs]: /components/sensor.yweather/ +[switch.deluge docs]: /components/switch.deluge/ +[switch.fritzbox docs]: /components/switch.fritzbox/ +[switch.insteon_plm docs]: /components/switch.insteon_plm/ +[switch.mqtt docs]: /components/switch.mqtt/ +[switch.rainmachine docs]: /components/switch.rainmachine/ +[switch.xiaomi_aqara docs]: /components/switch.xiaomi_aqara/ +[system_log docs]: /components/system_log/ +[tahoma docs]: /components/tahoma/ +[upnp docs]: /components/upnp/ +[weather docs]: /components/weather/ +[weather.buienradar docs]: /components/weather.buienradar/ +[weather.darksky docs]: /components/weather.darksky/ +[weather.openweathermap docs]: /components/weather.openweathermap/ +[websocket_api docs]: /components/websocket_api/ +[xiaomi_aqara docs]: /components/xiaomi_aqara/ +[zha docs]: /components/zha/ +[zone docs]: /components/zone/ +[zwave docs]: /components/zwave/ diff --git a/source/cloud/google_assistant.markdown b/source/cloud/google_assistant.markdown index 155b2356a7..070f03040b 100644 --- a/source/cloud/google_assistant.markdown +++ b/source/cloud/google_assistant.markdown @@ -7,9 +7,13 @@ sidebar: true comments: false sharing: true footer: true -published: false --- + +

    +The minimum supported version of Home Assistant is 0.65.6. +

    + The Google Assistant integration allows users to control the entities via the Home Assistant Smart Home skill for Google Assistant. This means that you can say things like "Ok Google, turn on the kitchen light" to control your local Home Assistant. To use this integration, you need to have: @@ -38,7 +42,7 @@ cloud: aliases: - bright lights - entry lights - type: 'action.devices.types.LIGHT' + room: living room ``` {% configuration cloud %} @@ -86,9 +90,8 @@ google_actions: description: Aliases that can also be used to refer to this entity required: false type: list - type: - description: Override the type of the entity in Google Assistant. [List of available types](https://developers.google.com/actions/smarthome/guides/) + room: + description: Hint for Google Assistant in which room this entity is. required: false type: string {% endconfiguration %} - diff --git a/source/cloud/index.markdown b/source/cloud/index.markdown index 449294d890..24f5cf76aa 100644 --- a/source/cloud/index.markdown +++ b/source/cloud/index.markdown @@ -15,19 +15,16 @@ ha_iot_class: "Cloud Push"

    The Home Assistant Cloud is currently free and will become part of the upcoming Community Support Package. [Learn more](/blog/2017/12/17/introducing-home-assistant-cloud/)

    -The Home Assistant Cloud allows you to quickly integrate your local Home Assistant with various cloud services like Amazon Alexa. - -The following integrations are currently available: +The Home Assistant Cloud allows you to quickly integrate your local Home Assistant with various cloud services. The following integrations are currently available: - [Amazon Alexa (Amazon Echo)](/cloud/alexa/) - - + - [Google Assistant (Google Home)](/cloud/google_assistant/) ### {% linkable_title How does it work? %} The Home Assistant Cloud has been designed with security in mind. When you activate the Cloud component, your instance will create a secure connection to the Home Assistant Cloud. There is no need for any further configuration or to expose your instance to the internet. -Integrations like Alexa will deliver messages to our cloud which we will forward to your local instance for processing. We just forward the response back to Alexa. This means that we do not have to store the state of your house in our cloud, we’re just the messenger! +Integrations like Alexa or Google will deliver messages to our cloud which we will forward to your local instance for processing. We just forward the response back. This means that we do not have to store the state of your house in our cloud, we’re just the messenger! You can find a list of frequently asked questions (and their answers) in [this blog post](/blog/2017/12/17/introducing-home-assistant-cloud/#faq). diff --git a/source/code_of_conduct/index.markdown b/source/code_of_conduct/index.markdown index f67555210b..57de40dede 100644 --- a/source/code_of_conduct/index.markdown +++ b/source/code_of_conduct/index.markdown @@ -87,4 +87,4 @@ This Code of Conduct was first adopted January 21st, 2017 and announced in [this [homepage]: http://contributor-covenant.org [version]: http://contributor-covenant.org/version/1/4/ [email]: mailto:safety@home-assistant.io -[coc-blog]: https://home-assistant.io/blog/2017/01/21/home-assistant-governance/ +[coc-blog]: /blog/2017/01/21/home-assistant-governance/ diff --git a/source/demo/frontend.html b/source/demo/frontend.html index 6cf41b7575..e96a4c7a38 100644 --- a/source/demo/frontend.html +++ b/source/demo/frontend.html @@ -2,4 +2,4 @@ },_distributeDirtyRoots:function(){for(var e,t=this.shadyRoot._dirtyRoots,o=0,i=t.length;o0?~setTimeout(e,t):(this._twiddle.textContent=this._twiddleContent++,this._callbacks.push(e),this._currVal++)},cancel:function(e){if(e<0)clearTimeout(~e);else{var t=e-this._lastVal;if(t>=0){if(!this._callbacks[t])throw"invalid async handle: "+e;this._callbacks[t]=null}}},_atEndOfMicrotask:function(){for(var e=this._callbacks.length,t=0;t
    +}var r=window.requestAnimationFrame;window.requestAnimationFrame=function(t){return r(function(e){window.document.timeline._updateAnimationsPromises(),t(e),window.document.timeline._updateAnimationsPromises()})},e.AnimationTimeline=function(){this._animations=[],this.currentTime=void 0},e.AnimationTimeline.prototype={getAnimations:function(){return this._discardAnimations(),this._animations.slice()},_updateAnimationsPromises:function(){e.animationsWithPromises=e.animationsWithPromises.filter(function(t){return t._updatePromises()})},_discardAnimations:function(){this._updateAnimationsPromises(),this._animations=this._animations.filter(function(t){return"finished"!=t.playState&&"idle"!=t.playState})},_play:function(t){var i=new e.Animation(t,this);return this._animations.push(i),e.restartWebAnimationsNextTick(),i._updatePromises(),i._animation.play(),i._updatePromises(),i},play:function(t){return t&&t.remove(),this._play(t)}};var o=!1;e.restartWebAnimationsNextTick=function(){o||(o=!0,requestAnimationFrame(n))};var a=new e.AnimationTimeline;e.timeline=a;try{Object.defineProperty(window.document,"timeline",{configurable:!0,get:function(){return a}})}catch(t){}try{window.document.timeline=a}catch(t){}}(c,e,f),function(t,e,i){e.animationsWithPromises=[],e.Animation=function(e,i){if(this.id="",e&&e._id&&(this.id=e._id),this.effect=e,e&&(e._animation=this),!i)throw new Error("Animation with null timeline is not supported");this._timeline=i,this._sequenceNumber=t.sequenceNumber++,this._holdTime=0,this._paused=!1,this._isGroup=!1,this._animation=null,this._childAnimations=[],this._callback=null,this._oldPlayState="idle",this._rebuildUnderlyingAnimation(),this._animation.cancel(),this._updatePromises()},e.Animation.prototype={_updatePromises:function(){var t=this._oldPlayState,e=this.playState;return this._readyPromise&&e!==t&&("idle"==e?(this._rejectReadyPromise(),this._readyPromise=void 0):"pending"==t?this._resolveReadyPromise():"pending"==e&&(this._readyPromise=void 0)),this._finishedPromise&&e!==t&&("idle"==e?(this._rejectFinishedPromise(),this._finishedPromise=void 0):"finished"==e?this._resolveFinishedPromise():"finished"==t&&(this._finishedPromise=void 0)),this._oldPlayState=this.playState,this._readyPromise||this._finishedPromise},_rebuildUnderlyingAnimation:function(){this._updatePromises();var t,i,n,r,o=!!this._animation;o&&(t=this.playbackRate,i=this._paused,n=this.startTime,r=this.currentTime,this._animation.cancel(),this._animation._wrapper=null,this._animation=null),(!this.effect||this.effect instanceof window.KeyframeEffect)&&(this._animation=e.newUnderlyingAnimationForKeyframeEffect(this.effect),e.bindAnimationForKeyframeEffect(this)),(this.effect instanceof window.SequenceEffect||this.effect instanceof window.GroupEffect)&&(this._animation=e.newUnderlyingAnimationForGroup(this.effect),e.bindAnimationForGroup(this)),this.effect&&this.effect._onsample&&e.bindAnimationForCustomEffect(this),o&&(1!=t&&(this.playbackRate=t),null!==n?this.startTime=n:null!==r?this.currentTime=r:null!==this._holdTime&&(this.currentTime=this._holdTime),i&&this.pause()),this._updatePromises()},_updateChildren:function(){if(this.effect&&"idle"!=this.playState){var t=this.effect._timing.delay;this._childAnimations.forEach(function(i){this._arrangeChildren(i,t),this.effect instanceof window.SequenceEffect&&(t+=e.groupChildDuration(i.effect))}.bind(this))}},_setExternalAnimation:function(t){if(this.effect&&this._isGroup)for(var e=0;e
    diff --git a/source/demo/panels/ha-panel-dev-info.html b/source/demo/panels/ha-panel-dev-info.html index e255ca2f83..516c2e88c5 100644 --- a/source/demo/panels/ha-panel-dev-info.html +++ b/source/demo/panels/ha-panel-dev-info.html @@ -1,2 +1,2 @@ \ No newline at end of file + clear: both;white-space:pre-wrap}
    About


    Home Assistant
    [[hassVersion]]

    Developed by a bunch of awesome people.

    Published under the MIT license
    Source: server — frontend-ui — frontend-core

    Built using Python 3, Polymer [[polymerVersion]], NuclearJS [[nuclearVersion]]
    Icons by Google and MaterialDesignIcons.com.

    The following errors have been logged this session:

    [[errorLog]]
     \ No newline at end of file diff --git a/source/demo/panels/ha-panel-dev-template.html b/source/demo/panels/ha-panel-dev-template.html index 22e214a759..5c7678632c 100644 --- a/source/demo/panels/ha-panel-dev-template.html +++ b/source/demo/panels/ha-panel-dev-template.html @@ -1,2 +1,2 @@ \ No newline at end of file + clear: both;white-space:pre-wrap}.rendered.error{color:red}
    Templates

    Templates are rendered using the Jinja2 template engine with some Home Assistant specific extensions.

    [[processed]]
     \ No newline at end of file diff --git a/source/developers/add_new_platform.markdown b/source/developers/add_new_platform.markdown index e0882296bf..3f4505c577 100644 --- a/source/developers/add_new_platform.markdown +++ b/source/developers/add_new_platform.markdown @@ -9,27 +9,6 @@ sharing: true footer: true --- -Components that interact with devices are called "[Entity Components](https://github.com/home-assistant/home-assistant/blob/dev/homeassistant/helpers/entity_component.py)." They are structured in core and platform logic, which means different brands can use the same logic to handle a light. - -For example, the built-in `switch` component consists of various platforms in [`homeassistant/components/switch/`](https://github.com/home-assistant/home-assistant/tree/master/homeassistant/components/switch). The file `__init__.py` contains the core logic of all platforms and the `vendor_name.py` files contain only the relevant platform code. - -If you're planning to add support for a new type of device to an existing component, you can get away with only writing platform logic. Have a look at how the component works with other platforms and create a similar file for the platform that you want to add: - - - [Example sensor platform](/developers/platform_example_sensor): hello world of platforms. - - [Example light platform](/developers/platform_example_light): showing best practices. - -### {% linkable_title Interfacing with devices %} - -One Home Assistant rule is that platform logic should never interface directly with devices. Instead, use a third-party Python 3 library. This way, Home Assistant can share code with the Python community and keep the project maintainable. - -To integrate the third-party library, create an [Entity class](https://github.com/home-assistant/home-assistant/blob/dev/homeassistant/helpers/entity.py) for your device. Entities are Home Assistant's representations of lights, switches, sensors, etc. and are derived from the [Entity Abstract Class](https://github.com/home-assistant/home-assistant/blob/master/homeassistant/helpers/entity.py). This abstract class contains logic for integrating most standard features into your entities, such as visibility, entity IDs, updates, and much more. - -### {% linkable_title Requirements and dependencies %} - -Platforms can specify dependencies and requirements [the same way as components](/developers/component_deps_and_reqs): - -```python -REQUIREMENTS = ['some-package==2.0.0', 'some-other-package==2.5.0'] -DEPENDENCIES = ['mqtt'] -``` - + \ No newline at end of file diff --git a/source/developers/api.markdown b/source/developers/api.markdown index 999647d038..4e226c4af9 100644 --- a/source/developers/api.markdown +++ b/source/developers/api.markdown @@ -9,13 +9,6 @@ sharing: true footer: true --- -Home Assistant provides various APIs. For detail please refer to [Home Assistant API](https://dev-docs.home-assistant.io/en/dev/) documentation. - - * [Python API](https://dev-docs.home-assistant.io/) - * [WebSocket API](/developers/websocket_api/) - * [REST API](/developers/rest_api/) - * [Python REST API](/developers/python_api/) - * [Server-sent events](/developers/server_sent_events/) - -If you are not using the [`frontend`](/components/frontend/) in your setup then you need to enable the components by adding them to your `configuration.yaml` file. E.g., [`websocket_api:`](/components/websocket_api/) for the WebSocket API or [`api:`](/components/api/) for the [REST API](/developers/rest_api/) and the [Python REST API](/developers/python_api/). - + \ No newline at end of file diff --git a/source/developers/architecture.markdown b/source/developers/architecture.markdown index 191ed65f7b..67aab81c30 100644 --- a/source/developers/architecture.markdown +++ b/source/developers/architecture.markdown @@ -10,32 +10,6 @@ footer: true og_image: /images/architecture/ha_architecture.svg --- -Before we dive into the Home Assistant architecture, let's get a clear overview of the home automation landscape as a whole. This way, we can show how the different parts of Home Assistant fit into the picture. - -For more information about each part in this overview, check out our blog. Here's the tl;dr version of the blog: - - * Home Control is responsible for collecting information and controlling devices. - * Home Automation triggers commands based on user configurations. - * Smart Home triggers commands based on previous behavior. - -

    - - Home Automation landscape - - Overview of the home automation landscape -

    - -The Home Assistant core is responsible for Home Control. Home Assistant contains four parts which make this possible: - - * **Event Bus**: facilitates the firing and listening of events -- the beating heart of Home Assistant. - * **State Machine**: keeps track of the states of things and fires a `state_changed` event when a state has been changed. - * **Service Registry**: listens on the event bus for `call_service` events and allows other code to register services. - * **Timer**: sends a `time_changed` event every 1 second on the event bus. - -

    - - - - Overview of the Home Assistant core architecture -

    + \ No newline at end of file diff --git a/source/developers/architecture_components.markdown b/source/developers/architecture_components.markdown index ac05c93ba0..fcd66a99ec 100644 --- a/source/developers/architecture_components.markdown +++ b/source/developers/architecture_components.markdown @@ -10,58 +10,6 @@ footer: true og_image: /images/architecture/component_interaction.png --- -Home Assistant can be extended with **components**. Each component is responsible for a specific domain within Home Assistant. Components can listen for or trigger events, offer services, and maintain states. Components are written in Python and can do all the goodness that Python has to offer. Out of the box, Home Assistant offers a bunch of [built-in components]({{site_root}}/components/). - -

    -Diagram showing interaction between components and the Home Assistant core. -Diagram showing interaction between components and the Home Assistant core -

    - -There are two types of components within Home Assistant: components that interact with an Internet of Things domain, and components that respond to events that happen within Home Assistant. Read on to learn about each type! - -#### {% linkable_title Components that interact with an Internet-of-Things domain %} - -These components track devices within a specific domain and consist of a core part and platform-specific logic. These components make their information available via the State Machine and the Event Bus. The components also register services in the Service Registry to expose control of the devices. - -For example, the built-in [`switch` component](/components/switch/) is responsible for interaction with different types of switches. A platform provides support for a particular kind or brand of device. For example, a switch could use a WeMo or Orvibo platform and a light component might interact with the Hue or LIFX platform. - -If you want to add support for a new platform, check out the [add new platform section](/developers/add_new_platform/). - -#### {% linkable_title Components that respond to events that happen within Home Assistant %} - -These components provide small pieces of home automation logic or involve services that do common tasks within your house. - -For example, the [`device_sun_light_trigger` component](/components/device_sun_light_trigger/) tracks the state of devices and the sun to make sure that the lights are turned on when it gets dark and people are home. The component uses logic like this: - -```text -In the event that device 'Paulus Nexus 5' changes to the 'Home' state: - If the sun has set and the lights are not on: - Turn on the lights -``` - -```text -In the event that the combined state of all tracked devices changes to 'Not Home': - If the lights are on: - Turn off the lights -``` - -```text -In the event of the sun setting: - If the lights are off and the combined state of all tracked device equals 'Home': - Turn on the lights -``` - -Look [here](/python_component_automation/) for a comprehensive example of a home automation component. - -### {% linkable_title The full picture %} - -When we put all the different pieces of Home Assistant together, it's a close match for the initial home automation overview sketch. The smart home AI has not been implemented yet, so it's not included in this picture. - -

    - - - - Overview of the full Home Assistant architecture with a couple of loaded components and platforms -

    - -The platform logic for components uses third-party Python libraries to communicate with the devices. Through this, we can leverage some of the best libraries in the Python community. + \ No newline at end of file diff --git a/source/developers/asyncio.markdown b/source/developers/asyncio.markdown index 3cbee37c1b..2cbf497eb6 100644 --- a/source/developers/asyncio.markdown +++ b/source/developers/asyncio.markdown @@ -9,19 +9,6 @@ sharing: true footer: true --- -On September 29, 2016 we released [Home Assistant 0.29][0.29] as part of our bi-weekly release schedule. This release introduced a complete overhaul of the core spearheaded by [Ben Bangert][ben]. - -The old core was set up like a “traditional” threaded application. Each resource that was not thread safe (ie. the state of entities) would be protected by a lock. This caused a lot of waiting and potential inconsistency because a task could now end up waiting halfway through its job until some resource got freed. - -Our new core is based on an Python’s built-in asyncio module. Instead of having all threads have access to the core API objects, access is now limited to a special thread called the event loop. All components will now schedule themselves as a task to be executed by the event loop. This gives us the guarantee that only one task is executed at once, meaning we no longer need any locks. - -The only problem with running everything inside the event loop is when a task is doing blocking I/O, what most third-party Python libraries are doing. For example while requesting new information from a device, the core will stop running until we get a response from the device. To handle this, a task is able to suspend itself until the response is available after which it will be enqueued for the event loop to process the result. - -For a task to be able to suspend itself, all code that it calls has to have this capability added. This means in practice that each device integration will need a full rewrite of the library that offers the integration! As this is not something that can be achieved, ever, a 100% backwards compatible API has been added so that no platform will require updating. - -The backwards compatible API works by scheduling a task from a different thread and blocking that thread until the task has been processed by the event loop. - -### [Next step: asyncio 101 »](/developers/asyncio_101/) - -[0.29]: https://home-assistant.io/blog/2016/09/29/async-sleepiq-emoncms-stocks/ -[ben]: https://github.com/bbangert/ + \ No newline at end of file diff --git a/source/developers/asyncio_101.markdown b/source/developers/asyncio_101.markdown index c88265119f..a43c09893f 100644 --- a/source/developers/asyncio_101.markdown +++ b/source/developers/asyncio_101.markdown @@ -9,12 +9,6 @@ sharing: true footer: true --- -If you are not familiar yet with asyncio, please watch the below video. It's a great introduction by [Robert Smallshire][rob] in how and why asyncio works the way it does. - -
    - -
    - -### [Next step: Categorizing Functions »](/developers/asyncio_categorizing_functions/) - -[rob]: https://github.com/rob-smallshire \ No newline at end of file + \ No newline at end of file diff --git a/source/developers/asyncio_categorizing_functions.markdown b/source/developers/asyncio_categorizing_functions.markdown index 6fe74ad359..8b54b2058c 100644 --- a/source/developers/asyncio_categorizing_functions.markdown +++ b/source/developers/asyncio_categorizing_functions.markdown @@ -9,71 +9,6 @@ sharing: true footer: true --- -A piece of work within Home Assistant is represented by a function that will be invoked. It will either run inside our event loop or inside our thread pool, depending on if it is async safe. - -Home Assistant uses the convention that all functions that must be run from within the event loop are prefixed with `async_`. - -## {% linkable_title The coroutine function %} - -Coroutines are special functions based on Python’s generators syntax which allows them to suspend execution while waiting on a result. - -Invoking a coroutine function will return a Generator object back, but will not actually begin execution. This object will execute the task when it is either yielded from (from within another coroutine) or it is scheduled on the event loop. - -To declare a function a coroutine, import the coroutine annotation from the asyncio package and annotate your function. - -```python -import asyncio - -@asyncio.coroutine -def async_look_my_coroutine(target): - result = yield from entity.async_turn_on() - if result: - print("hello {}".format(target)) - -hass.loop.create_task(async_look_my_coroutine("world")) -``` - -In this example, we schedule the coroutine by calling `hass.loop.create_task`. This will add the coroutine to the queue of tasks to be run. When the event loop is running `async_look_my_coroutine` it will suspend the task when `yield from entity.async_turn_on()` is called. At that point a new task will be scheduled to execute `entity.async_turn_on()`. When that job has been executed, `async_look_my_coroutine` will resume. - -## {% linkable_title The callback function %} - -This is a normal function that is considered safe to be run from within the event loop. A callback is unable to suspend itself and thus cannot do any I/O or call a coroutine. A callback is capable of scheduling a new task but it will not be able to wait for the results. - -To declare a function as a callback, import the callback annotation from the core package and annotate your function. - -A common use case for a callback in Home Assistant is as a listener for an event or a service call. It can process the incoming information and then schedule the right calls to be made. Example from the automation component. - -```python -from homeassistant.core import callback - -@callback -def async_trigger_service_handler(service_call): - """Handle automation trigger service calls.""" - vars = service_call.data.get(ATTR_VARIABLES) - for entity in component.async_extract_from_service(service_call): - hass.loop.create_task(entity.async_trigger(vars, True)) -``` - -In this example, `entity.async_trigger` is a coroutine function. Invoking the coroutine function will return a coroutine task. The passed in parameters will be used when the task gets executed. - -To execute the task we have to schedule it for execution on the event loop. This is done by calling `hass.loop.create_task`. - -### {% linkable_title Why even have callbacks? %} - -You might wonder, if a coroutine can do everything a callback can do, why even have a callback. The reason is performance and better state consistency of the core API objects. - -When coroutine A waits for coroutine B, it will suspend itself and schedule a new task to run B. This means that the event loop is now running A, B and then A again. If B is a callback, A will never have to suspend itself and thus the event loop is just running A. The consistency implication is that other events queued to run on the event loop continue to wait until callbacks complete, but will be interleaved when yielding to another coroutine. - -## {% linkable_title Event loop and thread safe %} - -These are functions that are safe to run both in a thread and inside the event loop. These functions are usually performing a computation or transform data in memory. Anything that does I/O does not fall under this category. Many standard library functions fall in this category. For example generating the sum of a set of numbers using sum or merging two dictionaries. - -There is no special annotation to mark functions as part of this category and care should be taken when using these functions from inside the event loop. When in doubt, look at their implementation. - -## {% linkable_title Other functions %} - -These are all the functions that did not fit in the previous categories. These functions are either thread-safe or not considered safe to be run within the event loop. These are functions that use sleep, or perform I/O. - -There is no special annotation necessary to be considered part of this category. - -### [Next step: Working with Async »](/developers/asyncio_working_with_async/) + \ No newline at end of file diff --git a/source/developers/asyncio_misc.markdown b/source/developers/asyncio_misc.markdown index 695b26e3e0..ee6fd3def8 100644 --- a/source/developers/asyncio_misc.markdown +++ b/source/developers/asyncio_misc.markdown @@ -9,14 +9,6 @@ sharing: true footer: true --- -## {% linkable_title What about ‘async’ and ‘await’ syntax? %} -Python 3.5 introduced new syntax to formalize the asynchronous pattern. This is however not compatible with Python 3.4. The minimum required Python version for Home Assistant is based on the Python version shipped with Debian stable, which is currently 3.4.2. - -For more information, Brett Cannon wrote [an excellent breakdown][brett] on 'async' and 'await' syntax and how asynchronous programming works. - -## {% linkable_title Acknowledgements %} - -Huge thanks to [Ben Bangert][ben] for starting the conversion of the core to async, guiding other contributors while taking their first steps with async programming and peer reviewing this documentation. - -[brett]: http://www.snarky.ca/how-the-heck-does-async-await-work-in-python-3-5 -[ben]: https://github.com/bbangert/ + \ No newline at end of file diff --git a/source/developers/asyncio_working_with_async.markdown b/source/developers/asyncio_working_with_async.markdown index 40fd82b246..5d66d66594 100644 --- a/source/developers/asyncio_working_with_async.markdown +++ b/source/developers/asyncio_working_with_async.markdown @@ -9,120 +9,6 @@ sharing: true footer: true --- -Although we have a backwards compatible API, using the async core directly will be a lot faster. Most core components have already been rewritten to leverage the async core. This includes the EntityComponent helper (foundation of light, switch, etc), scripts, groups and automation. - -## {% linkable_title Interacting with the core %} - -[All methods in the Home Assistant core][dev-docs] are implemented in two flavors: an async version and a version to be called from other threads. The versions for other are merely wrappers that call the async version in a threadsafe manner using [the available async utilities][dev-docs-async]. - -So if you are making calls to the core (the hass object) from within a callback or coroutine, use the methods that start with async_. If you need to call an async_ function that is a coroutine, your task must also be a coroutine. - -## {% linkable_title Implementing an async component %} - -To make a component async, implement an async_setup. - -```python -def setup(hass, config): - # Setup your component outside of the event loop. -``` - -Will turn into: - -```python -import asyncio - -@asyncio.coroutine -def async_setup(hass, config): - # Setup your component inside of the event loop. -``` - -## {% linkable_title Implementing an async platform %} - -For platforms we support async setup. Instead of setup_platform you need to have a coroutine async_setup_platform. - -```python -setup_platform(hass, config, add_entities, discovery_info=None): - # Setup your platform outside of the event loop. -``` - -Will turn into: - -```python -import asyncio - -@asyncio.coroutine -def async_setup_platform(hass, config, async_add_entities, - discovery_info=None): - # Setup your platform inside of the event loop -``` - -The only difference with the original parameters is that the `add_entities` function has been replaced by the async friendly callback `async_add_entities`. - -## {% linkable_title Implementing an async entity %} - -You can make your entity async friendly by converting your update method to be async. This requires the dependency of your entities to also be async friendly! - -```python -class MyEntity(Entity): - def update(self): - """Retrieve latest state.""" - self._state = fetch_state() -``` - -Will turn into: - -```python -import asyncio - -class MyEntity(Entity): - @asyncio.coroutine - def async_update(self): - """Retrieve latest state.""" - self._state = yield from async_fetch_state() -``` - -Make sure that all properties defined on your entity do not result in I/O being done. All data has to be fetched inside the update method and cached on the entity. This is because these properties are read from within the event loop and thus doing I/O will result in the core of Home Assistant waiting until your I/O is done. - -## {% linkable_title Calling async functions from threads %} - -Sometimes it will happen that you’re in a thread and you want to call a function that is only available as async. Home Assistant includes a few async helper utilities to help with this. - -In the following example, `say_hello` will schedule `async_say_hello` and block till the function has run and get the result back. - -```python -from homeassistant.util.async import run_callback_threadsafe - -def say_hello(hass, target): - return run_callback_threadsafe( - hass.loop, async_say_hello, target).result() - -def async_say_hello(hass, target): - return "Hello {}!".format(target) -``` - -## {% linkable_title Dealing with passed in functions %} - -If your code takes in functions from other code, you will not know which category the function belongs to and how they should be invoked. This usually only occurs if your code supplies an event helper like `mqtt.async_subscribe` or `track_state_change_listener`. - -To help with this, there are two helper methods on the hass object that you can call from inside the event loop: - -#### {% linkable_title hass.async_run_job %} - -Use this method if the function should be called as soon as possible. This will call callbacks immediately, schedule coroutines for execution on the event loop and schedule other functions to be run inside the thread pool. - -| Callback | Call immediately. -| Coroutine | Schedule for execution on the event loop. -| Other functions | Schedule for execution in the thread pool. - -#### {% linkable_title hass.async_add_job %} - -Use this method if the function should be called but not get priority over already scheduled calls. - -| Callback | Schedule for execution on the event loop. -| Coroutine | Schedule for execution on the event loop. -| Other functions | Schedule for execution in the thread pool. - -### [Next step: Miscellaneous »](/developers/asyncio_misc/) - -[dev-docs]: https://dev-docs.home-assistant.io/en/master/api/core.html -[dev-docs-async]: https://dev-docs.home-assistant.io/en/dev/api/util.html#module-homeassistant.util.async + \ No newline at end of file diff --git a/source/developers/cla.markdown b/source/developers/cla.markdown index f48588f5e1..731c5360d6 100644 --- a/source/developers/cla.markdown +++ b/source/developers/cla.markdown @@ -30,7 +30,7 @@ By making a contribution to this project, I certify that: (d) I understand and agree that this project and the contribution are public and that a record of the contribution (including all personal information I submit with it) is maintained indefinitely - and may be redistributed consistent with this project or the open + and may be redistributed consistent with this project or the open source license(s) involved. ``` @@ -47,4 +47,4 @@ If you have not signed the CLA and you submit a pull request to a repository und This Contributor License Agreement (CLA) was first announced on January 21st, 2017 in [this][cla-blog] blog post and adopted January 28th, 2017. -[cla-blog]: https://home-assistant.io/blog/2017/01/21/home-assistant-governance/ +[cla-blog]: /blog/2017/01/21/home-assistant-governance/ diff --git a/source/developers/code_review_component.markdown b/source/developers/code_review_component.markdown index bebe3dc784..3d2853668d 100644 --- a/source/developers/code_review_component.markdown +++ b/source/developers/code_review_component.markdown @@ -9,28 +9,6 @@ sharing: true footer: true --- -A checklist of things to do when you're adding a new component. - -

    -Not all existing platforms follow the requirements in this checklist. This cannot be used as a reason to not follow them! -

    - -### {% linkable_title 1. Requirements %} - - 1. Requirement version pinned: `REQUIREMENTS = ['phue==0.8.1']` - 2. We no longer want requirements hosted on GitHub. Please upload to PyPi. - 3. Requirements should only be imported inside functions. This is necessary because requirements are installed on the fly. - -### {% linkable_title 2. Configuration %} - - 1. Voluptuous schema present for config validation - 2. Default parameters specified in voluptuous schema, not in `setup(…)` - 3. Schema using as many generic config keys as possible from `homeassistant.const` - 4. If your component has platforms, define a `PLATFORM_SCHEMA` instead of a `CONFIG_SCHEMA`. - 5. If using a `PLATFORM_SCHEMA` to be used with `EntityComponent`, import base from `homeassistant.helpers.config_validation` - 6. Never depend on users adding things to `customize` to configure behavior inside your component. - -### {% linkable_title 3. Component/platform communication %} - - 1. If you need to share global data with platforms, use the dictionary `hass.data`. `hass.data[DATA_XY]` while `XY` is the component is preferred over `hass.data[DOMAIN]`. - 2. If the component fetches data that causes its related platform entities to update, you can notify them using the dispatcher code in `homeassistant.helpers.dispatcher`. + \ No newline at end of file diff --git a/source/developers/code_review_platform.markdown b/source/developers/code_review_platform.markdown index 96f78c60a0..0be7ec0a02 100644 --- a/source/developers/code_review_platform.markdown +++ b/source/developers/code_review_platform.markdown @@ -9,70 +9,6 @@ sharing: true footer: true --- -A checklist of things to do when you're adding a new platform. - -

    -Not all existing platforms follow the requirements in this checklist. This cannot be used as a reason to not follow them! -

    - -### {% linkable_title 1. Requirements %} - - 1. Requirement version should be pinned: `REQUIREMENTS = ['phue==0.8.1']` - 2. We no longer want requirements hosted on GitHub. Please upload to PyPi. - 3. Requirements should only be imported inside functions. This is necessary because requirements are installed on the fly. - -### {% linkable_title 2. Dependencies %} - - 1. If you depend on a component for the connection, add it to your dependencies: `DEPENDENCIES = ['nest']` - -### {% linkable_title 3. Configuration %} - - 1. Voluptuous schema present for config validation - 2. Voluptuous schema extends schema from component
    (e.g. `light.hue.PLATFORM_SCHEMA` extends `light.PLATFORM_SCHEMA`) - 3. Default parameters specified in voluptuous schema, not in `setup_platform(…)` - 4. Your `PLATFORM_SCHEMA` should use as many generic config keys as possible from `homeassistant.const` - ```python - import voluptuous as vol - - from homeassistant.const import CONF_FILENAME, CONF_HOST - from homeassistant.components.light import PLATFORM_SCHEMA - import homeassistant.helpers.config_validation as cv - - CONF_ALLOW_UNREACHABLE = 'allow_unreachable' - DEFAULT_UNREACHABLE = False - - PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend({ - vol.Required(CONF_HOST): cv.string, - vol.Optional(CONF_ALLOW_UNREACHABLE, - default=DEFAULT_UNREACHABLE): cv.boolean, - vol.Optional(CONF_FILENAME): cv.string, - }) - ``` - 5. Never depend on users adding things to `customize` to configure behavior inside your platform. - -### {% linkable_title 4. Setup Platform %} - - 1. Test if passed in info (user/pass/host etc.) works. - 2. Group your calls to `add_devices` if possible. - 3. If platform adds extra services, format should be `._`. - -### {% linkable_title 5. Entity %} - - 1. Extend entity from component, e.g. `class HueLight(Light)` - 2. Do not call `update()` in constructor, use `add_devices(devices, True)` instead. - 3. Do not do any I/O inside properties. Cache values inside `update()` instead. - 4. The state and/or attributes should not contain relative time since something happened. Instead it should store UTC timestamps. - -### {% linkable_title 6. Communication with devices/services %} - - 1. All API specific code has to be part of a third party library hosted on PyPi. Home Assistant should only interact with objects and not make direct calls to the API. - -```python -# bad -status = requests.get(url('/status')) - -# good -from phue import Bridge -bridge = Bridge(…) -status = bridge.status() -``` + \ No newline at end of file diff --git a/source/developers/component_deps_and_reqs.markdown b/source/developers/component_deps_and_reqs.markdown index 750f6b6c85..0a9b6758eb 100644 --- a/source/developers/component_deps_and_reqs.markdown +++ b/source/developers/component_deps_and_reqs.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Requirements & Dependencies" -description: "Instructions how to define requirements and dependencies." +description: "Instructions on how to define requirements and dependencies." date: 2016-04-16 13:32 sidebar: true comments: false @@ -9,35 +9,6 @@ sharing: true footer: true --- -Home Assistant allows components and platforms to specify their dependencies and requirements using the variables `DEPENDENCIES` and `REQUIREMENTS`. Both are lists that contain strings. - -## {% linkable_title Dependencies %} - -Dependencies are other Home Assistant components that should be setup before the platform is loaded. An example is the MQTT sensor component, which requires an active connection to an MQTT broker. If Home Assistant is unable to load and setup the MQTT component, it will not setup the MQTT sensor component. - -```python -DEPENDENCIES = ['mqtt'] -``` - -## {% linkable_title Requirements %} - -Requirements are Python libraries or modules that you would normally install using `pip` for your component. Home Assistant will try to install the requirements into the `deps` subdirectory of the Home Assistant [configuration directory](/docs/configuration/) if you are not using a `venv` or in something like `path/to/venv/lib/python3.6/site-packages` if you running in a virtual environment. This will make sure that all requirements are present at startup. If steps fails like missing packages for the compilation of a module or other install errors, the component will fail to load. - -Requirements is a list of strings. Each entry is a `pip` compatible string. For example, the media player Cast platform depends on the Python package PyChromecast v0.6.12: - -```python -REQUIREMENTS = ['pychromecast==0.6.12'] -``` - -During development of a component, it can be useful to test against different versions of a requirement. This can be done in two steps, using pychromecast as an example: - -* `pip install pychromecast==0.6.13 --target ~/.homeassistant/deps` -* `hass --skip-pip` - -This will use the specified version, and prevent Home Assistant from trying to override it with what is currently in `REQUIREMENTS`. - -If you need to make changes to a requirement to support your component, it's also possible to `pip install` from a checkout of the requirement. - -* `git clone https://github.com/balloob/pychromecast.git` -* `pip install ./pychromecast` -* `hass --skip-pip` + \ No newline at end of file diff --git a/source/developers/component_discovery.markdown b/source/developers/component_discovery.markdown index 2911adaa26..69fb672d5f 100644 --- a/source/developers/component_discovery.markdown +++ b/source/developers/component_discovery.markdown @@ -9,52 +9,6 @@ sharing: true footer: true --- -

    -This option is only available for built-in components. -

    - -Home Assistant has a discovery service running in the background to discover new devices. Whenever a new device is discovered, a `SERVICE_DISCOVERED` event will be fired with the found service and the information. The `discovery` component has some knowledge about which components handle which type of services and will ensure those are loaded and listening before firing the `SERVICE_DISCOVERED` event. - -### {% linkable_title Add discovery instructions %} - -Device discovery for Home Assistant has been extracted into an external library called [NetDisco](https://github.com/home-assistant/netdisco). This library is integrated using [the `discovery` component](https://github.com/home-assistant/home-assistant/blob/dev/homeassistant/components/discovery.py) and scans the network in intervals for uPnP and zeroconf/mDNS services. - -To have your device be discovered, you will have to extend the NetDisco library to be able to find your device. This is done by adding a new discoverable. [See the repository for examples of existing discoverable.](https://github.com/home-assistant/netdisco/tree/master/netdisco/discoverables) - -### {% linkable_title Listening to `SERVICE_DISCOVERED` events %} - -From your component, you will have to set up the listening for specific services. Given below is an example how one would listen for a discovered AwesomeDevice: - -```python -from homeassistant.components.discovery import SERVICE_AWESOMEDEVICE -from homeassistant.helpers import discovery - -DOMAIN = 'awesomedevice' - -DEPENDENCIES = ['http'] - -def setup(hass, config): - cfg = config.get(DOMAIN) - - def device_discovered(service, info): - """ Called when a Awesome device has been discovered. """ - print("Discovered a new Awesome device: {}".format(info)) - - discovery.listen( - hass, SERVICE_AWESOMEDEVICE, device_discovered) - - return True -``` - -### {% linkable_title Auto-loading your component upon discovery %} - -The `discovery` component is capable of setting up your components before firing the `EVENT_PLATFORM_DISCOVERED` event. To do this you will have to update the [`SERVICE_HANDLERS`](https://github.com/home-assistant/home-assistant/blob/dev/homeassistant/components/discovery.py#L40) constant in [the `discovery` component](https://github.com/home-assistant/home-assistant/blob/dev/homeassistant/components/discovery.py): - -```python -SERVICE_AWESOMEDEVICE = 'awesomedevice' - -SERVICE_HANDLERS = { - ... - SERVICE_AWESOMEDEVICE: ('awesomedevice', None), -} -``` + \ No newline at end of file diff --git a/source/developers/component_events.markdown b/source/developers/component_events.markdown index 485bc2863c..65f729e52d 100644 --- a/source/developers/component_events.markdown +++ b/source/developers/component_events.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Handling events" -description: "Instructions how to handle events with your component." +description: "Instructions on how to handle events with your component." date: 2016-04-16 13:32 sidebar: true comments: false @@ -9,4 +9,6 @@ sharing: true footer: true --- -Home Assistant has different ways of responding to events that occur in Home Assistant. These have been organized in [helper methods](https://github.com/home-assistant/home-assistant/blob/dev/homeassistant/helpers/event.py). Examples are `track_state_change`, `track_point_in_time`, `track_time_change`. + \ No newline at end of file diff --git a/source/developers/component_generic_discovery.markdown b/source/developers/component_generic_discovery.markdown index 8eacc22ff4..5fd2881601 100644 --- a/source/developers/component_generic_discovery.markdown +++ b/source/developers/component_generic_discovery.markdown @@ -9,69 +9,6 @@ sharing: true footer: true --- -New controller or hub components often need to add platforms in sub-components (i.e. Lights & Switches) without additional configuration. -This can be achieved using the `load_platform` or `async_load_platform` methods from `homeassistant.helpers.discovery`: - -```python -def load_platform(hass, component, platform, discovered=None, hass_config=None) -``` - -From more info on how this works, refer to the [load_platform](https://github.com/home-assistant/home-assistant/blob/dev/homeassistant/helpers/discovery.py#L136) method. - -### {% linkable_title Example %} - -Say you need to implement your new MyFlashyHub that controls both Switches & Lights, you can follow these steps: - -Configuration required for your new hub component: - -```yaml -myflashyhub: - example: setting -``` - -The source for your component can be located in your configuration directory for now: - -```bash -~/.homeassistant/custom_components/myflashyhub.py -~/.homeassistant/custom_components/light/myflashyhub.py -~/.homeassistant/custom_components/switch/myflashyhub.py -``` - -In the hub component `myflashyhub.py` you can call your light and switch components. To pass any non-serializable information to the platforms in the sub-component, you can use a global variable. - -```python -from homeassistant.helpers.discovery import load_platform -DOMAIN = 'myflashyhub' - -DATA_MFH = 'MFH' - -def setup(hass, config): - """Your controller/hub specific code.""" - hass.data[DATA_MFH] = SomeObjectToInitialiseGlobal() - - #--- snip --- - load_platform(hass, 'light', DOMAIN) - load_platform(hass, 'switch', DOMAIN, {'optional': 'arguments'}) -``` - -Add your custom device specific code to the `setup_platform` method in `light/myflashyhub.py` and `switch/myflashyhub`. - -```python -import custom_components.myflashyhub as myflashyhub - -# 'switch' will receive discovery_info={'optional': 'arguments'} -# as passed in above. 'light' will receive discovery_info=None -def setup_platform(hass, config, add_devices, discovery_info=None): - """Your switch/light specific code.""" - # You can now use hass.data[myflashyhub.DATA_MFH] -``` - - -The `load_platform` method allows the platforms to be loaded without the need for any additional platform entries in your `configuration.yaml` file, which normally would have been: - -```yaml -#light: -# platform: myflashyhub -#switch: -# platform: myflashyhub -``` + \ No newline at end of file diff --git a/source/developers/component_loading.markdown b/source/developers/component_loading.markdown index 342aa60b7e..f5c6e04e9f 100644 --- a/source/developers/component_loading.markdown +++ b/source/developers/component_loading.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Loading your components" -description: "Instructions how to get your component loaded by Home Assistant." +description: "Instructions on how to get your component loaded by Home Assistant." date: 2016-04-16 13:32 sidebar: true comments: false @@ -9,17 +9,6 @@ sharing: true footer: true --- -A component will be loaded on start if a section (ie. `light:`) for it exists in the config file. A component can also be loaded if another component is loaded that depends on it. When loading a component Home Assistant will check the following paths: - - * `/custom_components/` - * `homeassistant/components/` (built-in components) - -Once loaded, a component will only be setup if all dependencies can be loaded and are able to setup. Keep an eye on the logs to see if your component could be loaded and initialized. - -

    -You can override a built-in component by having a component with the same name in your config/custom_components folder. If the built-in component is inside a subfolder, take care to place your customization in a folder with the same name in config/custom_components/*folder*. Note that overriding built-in components is not recommended and will probably break things! -

    - -

    -Home Assistant will use the directory that contains your config file as the directory that holds your customizations. By default this is the config folder in your current work directory. You can use a different folder by running Home Assistant with the --config argument: python3 homeassistant --config /YOUR/CONFIG/PATH/. -

    + \ No newline at end of file diff --git a/source/developers/component_states.markdown b/source/developers/component_states.markdown index 5e3217de26..d94c5b12ba 100644 --- a/source/developers/component_states.markdown +++ b/source/developers/component_states.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Handling states" -description: "Instructions how to handle states with your component." +description: "Instructions on how to handle states with your component." date: 2016-07-01 20:00 sidebar: true comments: false @@ -9,14 +9,6 @@ sharing: true footer: true --- -It is the responsibility of the component to maintain the states of the devices in your domain. Each device should be a single state and, if possible, a group should be provided that tracks the combined state of the devices. - -A state can have several attributes that will help the frontend in displaying your state: - -- `friendly_name`: this name will be used as the name of the device -- `entity_picture`: this picture will be shown instead of the domain icon -- `unit_of_measurement`: this will be appended to the state in the interface -- `hidden`: This is a suggestion to the frontend on if the state should be hidden - -These attributes are defined in [homeassistant.helpers.entity](https://github.com/home-assistant/home-assistant/blob/master/homeassistant/helpers/entity.py#L180). - + \ No newline at end of file diff --git a/source/developers/component_visibility.markdown b/source/developers/component_visibility.markdown index 846d6b98b3..29a84a747d 100644 --- a/source/developers/component_visibility.markdown +++ b/source/developers/component_visibility.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Handling visibility" -description: "Instructions how to handle visibility with your component." +description: "Instructions on how to handle visibility with your component." date: 2016-07-01 20:00 sidebar: true comments: false @@ -9,13 +9,6 @@ sharing: true footer: true --- -Generally, when creating a new entity for Home Assistant you will want it to be a class that inherits the [homeassistant.helpers.entity.Entity](https://github.com/home-assistant/home-assistant/blob/master/homeassistant/helpers/entity.py) class. If this is done, visibility will be handled for you. -You can set a suggestion for your entity's visibility by setting the `hidden` property by doing something similar to the following. - -```python -self.hidden = True -``` - -This will SUGGEST that the active frontend hides the entity. This requires that the active frontend support hidden cards (the default frontend does) and that the value of hidden be included in your attributes dictionary (see above). The Entity abstract class will take care of this for you. - -Remember: The suggestion set by your component's code will always be overwritten by user settings in the `configuration.yaml` file. This is why you may set hidden to be `False`, but the property may remain `True` (or vice-versa). + \ No newline at end of file diff --git a/source/developers/creating_components.markdown b/source/developers/creating_components.markdown index f52629db8a..678014da4f 100644 --- a/source/developers/creating_components.markdown +++ b/source/developers/creating_components.markdown @@ -9,19 +9,6 @@ sharing: true footer: true --- -Alright, you're ready to make your first component. AWESOME. Don't worry, we've tried hard to keep it as easy as possible. - -### {% linkable_title Example component %} - -Add `hello_state:` to your `configuration.yaml` file and create a file `/custom_components/hello_state.py` with the below code to test it locally. - -```python -DOMAIN = 'hello_state' - -def setup(hass, config): - hass.states.set('hello.world', 'Paulus') - - return True -``` - -For more examples, see the [Custom Python Component Examples](/cookbook/#custom-python-component-examples) on our examples page. + \ No newline at end of file diff --git a/source/developers/credits.markdown b/source/developers/credits.markdown index d5ae4f2a12..3e44e31340 100644 --- a/source/developers/credits.markdown +++ b/source/developers/credits.markdown @@ -2,7 +2,7 @@ layout: page title: "Credits" description: "Credits for the developers who contributed to Home Assistant." -date: 2018-02-10 16:03:45 +0000 +date: 2018-04-29 16:35:15 +0000 sidebar: true comments: false sharing: true @@ -13,21 +13,22 @@ This page contains a list of people who have contributed in one way or another t ### {% linkable_title Author %} -- [Paulus Schoutsen (@balloob)](https://github.com/balloob "6191 total commits to the home-assistant organization, 3645 commits to home-assistant, 1356 commits to home-assistant.github.io, 693 commits to home-assistant-polymer, 244 commits to home-assistant-js, 119 commits to netdisco, 44 commits to home-assistant-js-websocket, 26 commits to hass-release, 15 commits to home-assistant-assets, 12 commits to LabelBot, 8 commits to example-custom-config, 7 commits to micropython-home-assistant, 5 commits to hassio, 3 commits to hassio-addons, 2 commits to lambda-home-assistant-github, 2 commits to hassio-build, 2 commits to python-hassbian, 2 commits to hassio-addons-example, 2 commits to issue-bot, 1 commit to architecture, 1 commit to home-assistant-notebooks, 1 commit to home-assistant-iOS, 1 commit to warrant") +- [Paulus Schoutsen (@balloob)](https://github.com/balloob "6642 total commits to the home-assistant organization, 3877 commits to home-assistant, 1448 commits to home-assistant.github.io, 768 commits to home-assistant-polymer, 244 commits to home-assistant-js, 123 commits to netdisco, 46 commits to home-assistant-js-websocket, 35 commits to developers.home-assistant, 33 commits to hass-release, 17 commits to LabelBot, 15 commits to home-assistant-assets, 8 commits to example-custom-config, 7 commits to micropython-home-assistant, 5 commits to hassio, 3 commits to hassio-addons, 2 commits to hassio-build, 2 commits to lambda-home-assistant-github, 2 commits to home-assistant-iOS, 2 commits to hassio-addons-example, 2 commits to issue-bot, 1 commit to architecture, 1 commit to home-assistant-notebooks, 1 commit to warrant") ### {% linkable_title Contributors %} (in alphabetical order) - [7even (@hwikene)](https://github.com/hwikene "1 total commits to the home-assistant organization, 1 commit to home-assistant-polymer") -- [Aaron Bach (@bachya)](https://github.com/bachya "40 total commits to the home-assistant organization, 24 commits to home-assistant, 16 commits to home-assistant.github.io") +- [a-andre (@a-andre)](https://github.com/a-andre "3 total commits to the home-assistant organization, 3 commits to home-assistant") +- [Aaron Bach (@bachya)](https://github.com/bachya "53 total commits to the home-assistant organization, 35 commits to home-assistant, 18 commits to home-assistant.github.io") - [Aaron Linville (@linville)](https://github.com/linville "2 total commits to the home-assistant organization, 2 commits to appdaemon") -- [Abílio Costa (@abmantis)](https://github.com/abmantis "21 total commits to the home-assistant organization, 12 commits to home-assistant, 5 commits to home-assistant.github.io, 2 commits to home-assistant-polymer, 1 commit to home-assistant-js-websocket, 1 commit to netdisco") +- [Abílio Costa (@abmantis)](https://github.com/abmantis "22 total commits to the home-assistant organization, 13 commits to home-assistant, 5 commits to home-assistant.github.io, 2 commits to home-assistant-polymer, 1 commit to home-assistant-js-websocket, 1 commit to netdisco") - [Adam (@SilvrrGIT)](https://github.com/SilvrrGIT "9 total commits to the home-assistant organization, 9 commits to home-assistant.github.io") - [Adam Baxter (@voltagex)](https://github.com/voltagex "1 total commits to the home-assistant organization, 1 commit to home-assistant-polymer") - [Adam Cooper (@GenericStudent)](https://github.com/GenericStudent "11 total commits to the home-assistant organization, 8 commits to home-assistant, 3 commits to home-assistant.github.io") - [Adam Dullage (@Dullage)](https://github.com/Dullage "3 total commits to the home-assistant organization, 3 commits to home-assistant.github.io") -- [Adam Mills (@armills)](https://github.com/armills "289 total commits to the home-assistant organization, 151 commits to home-assistant, 82 commits to home-assistant-polymer, 52 commits to home-assistant.github.io, 3 commits to home-assistant-js, 1 commit to homebridge-homeassistant") +- [Adam Mills (@armills)](https://github.com/armills "324 total commits to the home-assistant organization, 171 commits to home-assistant, 92 commits to home-assistant-polymer, 57 commits to home-assistant.github.io, 3 commits to home-assistant-js, 1 commit to homebridge-homeassistant") - [Adrian Popa (@mad-ady)](https://github.com/mad-ady "5 total commits to the home-assistant organization, 4 commits to appdaemon, 1 commit to home-assistant-polymer") - [Adrien Ball (@adrienball)](https://github.com/adrienball "2 total commits to the home-assistant organization, 2 commits to home-assistant") - [Adrien Brault (@adrienbrault)](https://github.com/adrienbrault "2 total commits to the home-assistant organization, 2 commits to home-assistant") @@ -36,49 +37,50 @@ This page contains a list of people who have contributed in one way or another t - [akloeckner (@akloeckner)](https://github.com/akloeckner "3 total commits to the home-assistant organization, 3 commits to home-assistant") - [Alan Bowman (@alanbowman)](https://github.com/alanbowman "4 total commits to the home-assistant organization, 4 commits to home-assistant") - [Alan Fischer (@alanfischer)](https://github.com/alanfischer "20 total commits to the home-assistant organization, 16 commits to home-assistant, 4 commits to home-assistant.github.io") +- [Alan Tse (@alandtse)](https://github.com/alandtse "4 total commits to the home-assistant organization, 2 commits to home-assistant, 2 commits to home-assistant.github.io") - [Alasdair Nicol (@alasdairnicol)](https://github.com/alasdairnicol "2 total commits to the home-assistant organization, 2 commits to home-assistant.github.io") - [Albatross (@DyingAlbatross)](https://github.com/DyingAlbatross "2 total commits to the home-assistant organization, 2 commits to home-assistant.github.io") -- [Albert Lee (@trisk)](https://github.com/trisk "14 total commits to the home-assistant organization, 9 commits to home-assistant, 5 commits to home-assistant.github.io") +- [Albert Lee (@trisk)](https://github.com/trisk "18 total commits to the home-assistant organization, 11 commits to home-assistant, 7 commits to home-assistant.github.io") - [Alberto Arias Maestro (@albertoarias)](https://github.com/albertoarias "2 total commits to the home-assistant organization, 2 commits to home-assistant") - [Alessandro Mogavero (@alexmogavero)](https://github.com/alexmogavero "3 total commits to the home-assistant organization, 3 commits to home-assistant") -- [Alex (@asbach)](https://github.com/asbach "2 total commits to the home-assistant organization, 2 commits to home-assistant.github.io") -- [Alex Barcelo (@alexbarcelo)](https://github.com/alexbarcelo "5 total commits to the home-assistant organization, 3 commits to hassio-addons, 2 commits to home-assistant.github.io") +- [Alex Barcelo (@alexbarcelo)](https://github.com/alexbarcelo "6 total commits to the home-assistant organization, 3 commits to hassio-addons, 3 commits to home-assistant.github.io") - [Alex Harvey (@infamy)](https://github.com/infamy "29 total commits to the home-assistant organization, 14 commits to home-assistant, 11 commits to home-assistant.github.io, 4 commits to hassio-os") - [Alex Mekkering (@AlexMekkering)](https://github.com/AlexMekkering "2 total commits to the home-assistant organization, 2 commits to home-assistant.github.io") - [Alex MF (@adsmf)](https://github.com/adsmf "1 total commits to the home-assistant organization, 1 commit to hassio-addons") - [Alex Osadchyy (@aosadchyy)](https://github.com/aosadchyy "2 total commits to the home-assistant organization, 2 commits to home-assistant") - [Alex Tzonkov (@attzonko)](https://github.com/attzonko "2 total commits to the home-assistant organization, 2 commits to home-assistant.github.io") +- [Alexander Bachmeier (@asbach)](https://github.com/asbach "2 total commits to the home-assistant organization, 2 commits to home-assistant.github.io") - [Alexander Kratzer (@hexxter)](https://github.com/hexxter "8 total commits to the home-assistant organization, 8 commits to home-assistant") - [Alexandre Perrin (@kAworu)](https://github.com/kAworu "3 total commits to the home-assistant organization, 3 commits to home-assistant.github.io") -- [Alexis Iglauer (@ax42)](https://github.com/ax42 "2 total commits to the home-assistant organization, 2 commits to home-assistant.github.io") +- [Alexis Iglauer (@ax42)](https://github.com/ax42 "3 total commits to the home-assistant organization, 3 commits to home-assistant.github.io") - [Alfie Day (@Azelphur)](https://github.com/Azelphur "12 total commits to the home-assistant organization, 12 commits to home-assistant") - [Aliaksandr (@minchik)](https://github.com/minchik "7 total commits to the home-assistant organization, 3 commits to home-assistant.github.io, 2 commits to appdaemon, 2 commits to home-assistant") -- [Alok Saboo (@arsaboo)](https://github.com/arsaboo "136 total commits to the home-assistant organization, 81 commits to home-assistant.github.io, 49 commits to home-assistant, 4 commits to home-assistant-polymer, 1 commit to pi-gen, 1 commit to hassio-addons") +- [Alok Saboo (@arsaboo)](https://github.com/arsaboo "141 total commits to the home-assistant organization, 82 commits to home-assistant.github.io, 53 commits to home-assistant, 4 commits to home-assistant-polymer, 1 commit to hassio-addons, 1 commit to pi-gen") - [amorsillo (@AndrewMorsillo)](https://github.com/AndrewMorsillo "1 total commits to the home-assistant organization, 1 commit to home-assistant-polymer") - [Anders Fogh Eriksen (@Fogh)](https://github.com/Fogh "2 total commits to the home-assistant organization, 2 commits to home-assistant.github.io") -- [Anders Melchiorsen (@amelchio)](https://github.com/amelchio "143 total commits to the home-assistant organization, 103 commits to home-assistant, 38 commits to home-assistant.github.io, 2 commits to home-assistant-polymer") +- [Anders Melchiorsen (@amelchio)](https://github.com/amelchio "213 total commits to the home-assistant organization, 170 commits to home-assistant, 41 commits to home-assistant.github.io, 2 commits to home-assistant-polymer") - [andig (@andig)](https://github.com/andig "1 total commits to the home-assistant organization, 1 commit to pi-gen") - [Andrea Campi (@andreacampi)](https://github.com/andreacampi "8 total commits to the home-assistant organization, 6 commits to home-assistant, 2 commits to home-assistant.github.io") -- [Andrea Falcone (@asfalcone)](https://github.com/asfalcone "5 total commits to the home-assistant organization, 5 commits to issue-bot") - [Andreas Björshammar (@abjorshammar)](https://github.com/abjorshammar "2 total commits to the home-assistant organization, 2 commits to home-assistant") - [Andreas Jacobsen (@andreasjacobsen93)](https://github.com/andreasjacobsen93 "8 total commits to the home-assistant organization, 6 commits to home-assistant.github.io, 2 commits to hassio-addons") - [Andreas Rammhold (@andir)](https://github.com/andir "1 total commits to the home-assistant organization, 1 commit to home-assistant-polymer") - [Andreas Renberg (@IQAndreas)](https://github.com/IQAndreas "2 total commits to the home-assistant organization, 2 commits to home-assistant.github.io") -- [Andreea-Daniela Ene (@AndreeaEne)](https://github.com/AndreeaEne "3 total commits to the home-assistant organization, 3 commits to home-assistant.github.io") +- [Andreea\-Daniela Ene (@AndreeaEne)](https://github.com/AndreeaEne "3 total commits to the home-assistant organization, 3 commits to home-assistant.github.io") +- [Andrei Pop (@andreipop2005)](https://github.com/andreipop2005 "2 total commits to the home-assistant organization, 2 commits to home-assistant") - [Andrej Friesen (@ajfriesen)](https://github.com/ajfriesen "3 total commits to the home-assistant organization, 3 commits to home-assistant.github.io") - [Andrew (@aneisch)](https://github.com/aneisch "5 total commits to the home-assistant organization, 5 commits to home-assistant.github.io") - [Andrew (@aoakeson)](https://github.com/aoakeson "2 total commits to the home-assistant organization, 2 commits to home-assistant.github.io") -- [Andrew Cockburn (@acockburn)](https://github.com/acockburn "749 total commits to the home-assistant organization, 615 commits to appdaemon, 88 commits to hadashboard, 25 commits to scenegen, 21 commits to home-assistant.github.io") +- [Andrew Cockburn (@acockburn)](https://github.com/acockburn "815 total commits to the home-assistant organization, 680 commits to appdaemon, 88 commits to hadashboard, 25 commits to scenegen, 22 commits to home-assistant.github.io") - [Andrew Smith (@andrewmichaelsmith)](https://github.com/andrewmichaelsmith "2 total commits to the home-assistant organization, 2 commits to pi-gen") - [Andrew Stock (@watchforstock)](https://github.com/watchforstock "2 total commits to the home-assistant organization, 2 commits to home-assistant") - [Andrew Thigpen (@andythigpen)](https://github.com/andythigpen "33 total commits to the home-assistant organization, 32 commits to home-assistant, 1 commit to home-assistant-js") - [Andrew Wedgbury (@sconemad)](https://github.com/sconemad "1 total commits to the home-assistant organization, 1 commit to pi-gen") - [andrew-curtis (@andrew-curtis)](https://github.com/andrew-curtis "7 total commits to the home-assistant organization, 7 commits to home-assistant.github.io") -- [Andrey (@andrey-git)](https://github.com/andrey-git "279 total commits to the home-assistant organization, 126 commits to home-assistant-polymer, 116 commits to home-assistant, 37 commits to home-assistant.github.io") +- [Andrey (@andrey-git)](https://github.com/andrey-git "295 total commits to the home-assistant organization, 135 commits to home-assistant-polymer, 122 commits to home-assistant, 37 commits to home-assistant.github.io, 1 commit to home-assistant-js-websocket") - [Andrey Kupreychik (@foxel)](https://github.com/foxel "9 total commits to the home-assistant organization, 6 commits to home-assistant, 3 commits to home-assistant.github.io") -- [Andrzej (@andriej)](https://github.com/andriej "2 total commits to the home-assistant organization, 2 commits to home-assistant.github.io") +- [Andrzej (@andriej)](https://github.com/andriej "3 total commits to the home-assistant organization, 3 commits to home-assistant.github.io") - [Andréas Lundgren (@adevade)](https://github.com/adevade "2 total commits to the home-assistant organization, 2 commits to home-assistant.github.io") -- [Andy Castille (@Klikini)](https://github.com/Klikini "12 total commits to the home-assistant organization, 8 commits to home-assistant, 4 commits to home-assistant.github.io") +- [Andy Castille (@Klikini)](https://github.com/Klikini "14 total commits to the home-assistant organization, 9 commits to home-assistant, 5 commits to home-assistant.github.io") - [anotherthomas (@anotherthomas)](https://github.com/anotherthomas "1 total commits to the home-assistant organization, 1 commit to hassio-addons") - [Anthony Arnaud (@aarnaud)](https://github.com/aarnaud "2 total commits to the home-assistant organization, 2 commits to home-assistant") - [Anthony Hughes (@tony2nite)](https://github.com/tony2nite "1 total commits to the home-assistant organization, 1 commit to netdisco") @@ -86,6 +88,7 @@ This page contains a list of people who have contributed in one way or another t - [Anton Glukhov (@toxxin)](https://github.com/toxxin "1 total commits to the home-assistant organization, 1 commit to libcoap") - [Anton Lundin (@glance-)](https://github.com/glance- "8 total commits to the home-assistant organization, 7 commits to home-assistant, 1 commit to netdisco") - [Anton Sarukhanov (@antsar)](https://github.com/antsar "6 total commits to the home-assistant organization, 3 commits to home-assistant, 2 commits to home-assistant.github.io, 1 commit to home-assistant-polymer") +- [Antoni K (@Antoni-K)](https://github.com/Antoni-K "1 total commits to the home-assistant organization, 1 commit to hassbian-scripts") - [apo-mak (@apo-mak)](https://github.com/apo-mak "1 total commits to the home-assistant organization, 1 commit to home-assistant-polymer") - [arcsur (@arcsur)](https://github.com/arcsur "3 total commits to the home-assistant organization, 3 commits to home-assistant") - [Ardetus (@Ardetus)](https://github.com/Ardetus "4 total commits to the home-assistant organization, 2 commits to home-assistant, 2 commits to home-assistant.github.io") @@ -108,33 +111,39 @@ This page contains a list of people who have contributed in one way or another t - [Baran Kaynak (@barankaynak)](https://github.com/barankaynak "1 total commits to the home-assistant organization, 1 commit to home-assistant-polymer") - [Barry Williams (@bazwilliams)](https://github.com/bazwilliams "10 total commits to the home-assistant organization, 6 commits to home-assistant, 2 commits to netdisco, 2 commits to home-assistant.github.io") - [Bart274 (@Bart274)](https://github.com/Bart274 "26 total commits to the home-assistant organization, 17 commits to home-assistant, 8 commits to home-assistant.github.io, 1 commit to home-assistant-polymer") -- [Bas Schipper (@basschipper)](https://github.com/basschipper "7 total commits to the home-assistant organization, 5 commits to home-assistant, 2 commits to home-assistant.github.io") +- [Bas Schipper (@basschipper)](https://github.com/basschipper "9 total commits to the home-assistant organization, 7 commits to home-assistant, 2 commits to home-assistant.github.io") - [bastshoes (@bastshoes)](https://github.com/bastshoes "1 total commits to the home-assistant organization, 1 commit to home-assistant-polymer") +- [battistaar (@battistaar)](https://github.com/battistaar "1 total commits to the home-assistant organization, 1 commit to homebridge-homeassistant") - [bcl1713 (@bcl1713)](https://github.com/bcl1713 "3 total commits to the home-assistant organization, 3 commits to home-assistant.github.io") -- [Beat (@bdurrer)](https://github.com/bdurrer "11 total commits to the home-assistant organization, 10 commits to home-assistant.github.io, 1 commit to home-assistant-polymer") +- [Beat (@bdurrer)](https://github.com/bdurrer "14 total commits to the home-assistant organization, 10 commits to home-assistant.github.io, 3 commits to home-assistant, 1 commit to home-assistant-polymer") - [Ben (@unixben)](https://github.com/unixben "2 total commits to the home-assistant organization, 2 commits to home-assistant.github.io") - [Ben Bangert (@bbangert)](https://github.com/bbangert "4 total commits to the home-assistant organization, 4 commits to home-assistant") - [Ben Doerr (@bendoerr)](https://github.com/bendoerr "2 total commits to the home-assistant organization, 2 commits to home-assistant.github.io") +- [Ben Lebherz (@benleb)](https://github.com/benleb "2 total commits to the home-assistant organization, 2 commits to home-assistant.github.io") - [Ben Nuttall (@bennuttall)](https://github.com/bennuttall "1 total commits to the home-assistant organization, 1 commit to pi-gen") - [Ben Origas (@borigas)](https://github.com/borigas "1 total commits to the home-assistant organization, 1 commit to home-assistant-polymer") - [Ben Pirt (@bjpirt)](https://github.com/bjpirt "2 total commits to the home-assistant organization, 2 commits to pi-gen") -- [Ben Randall (@veleek)](https://github.com/veleek "3 total commits to the home-assistant organization, 3 commits to home-assistant") +- [Ben Randall (@veleek)](https://github.com/veleek "4 total commits to the home-assistant organization, 4 commits to home-assistant") - [Ben Thomas (@wazoo)](https://github.com/wazoo "1 total commits to the home-assistant organization, 1 commit to home-assistant-polymer") +- [Benedict Aas (@Shou)](https://github.com/Shou "2 total commits to the home-assistant organization, 2 commits to home-assistant.github.io") - [Benjamin Parzella (@bparzella)](https://github.com/bparzella "1 total commits to the home-assistant organization, 1 commit to pi-gen") - [Benji (@bbbenji)](https://github.com/bbbenji "2 total commits to the home-assistant organization, 2 commits to home-assistant.github.io") -- [bestlibre (@bestlibre)](https://github.com/bestlibre "16 total commits to the home-assistant organization, 8 commits to home-assistant, 5 commits to home-assistant.github.io, 1 commit to hassio, 1 commit to hassio-build, 1 commit to home-assistant-polymer") +- [Bertbert (@bertbert72)](https://github.com/bertbert72 "2 total commits to the home-assistant organization, 2 commits to home-assistant.github.io") +- [bestlibre (@bestlibre)](https://github.com/bestlibre "16 total commits to the home-assistant organization, 8 commits to home-assistant, 5 commits to home-assistant.github.io, 1 commit to hassio-build, 1 commit to home-assistant-polymer, 1 commit to hassio") - [BigMoby (@bigmoby)](https://github.com/bigmoby "2 total commits to the home-assistant organization, 2 commits to home-assistant.github.io") -- [BioSehnsucht (@BioSehnsucht)](https://github.com/BioSehnsucht "12 total commits to the home-assistant organization, 7 commits to home-assistant.github.io, 3 commits to home-assistant, 2 commits to home-assistant-polymer") +- [BioSehnsucht (@BioSehnsucht)](https://github.com/BioSehnsucht "14 total commits to the home-assistant organization, 8 commits to home-assistant.github.io, 4 commits to home-assistant, 2 commits to home-assistant-polymer") - [Bjarni Ivarsson (@bjarniivarsson)](https://github.com/bjarniivarsson "8 total commits to the home-assistant organization, 5 commits to home-assistant, 3 commits to home-assistant-polymer") - [Björn Orri (@bjornorri)](https://github.com/bjornorri "1 total commits to the home-assistant organization, 1 commit to home-assistant-iOS") - [Björn Ramberg (@bjorne)](https://github.com/bjorne "1 total commits to the home-assistant organization, 1 commit to hassio-build") - [Blanyal D'Souza (@blanyal)](https://github.com/blanyal "2 total commits to the home-assistant organization, 2 commits to home-assistant.github.io") - [Bob Anderson (@rwa)](https://github.com/rwa "11 total commits to the home-assistant organization, 7 commits to home-assistant, 4 commits to home-assistant.github.io") -- [Bob Igo (@Human)](https://github.com/Human "2 total commits to the home-assistant organization, 2 commits to home-assistant.github.io") +- [Bob Igo (@Human)](https://github.com/Human "3 total commits to the home-assistant organization, 3 commits to home-assistant.github.io") - [Boced66 (@boced66)](https://github.com/boced66 "3 total commits to the home-assistant organization, 3 commits to home-assistant.github.io") +- [bonanitech (@bonanitech)](https://github.com/bonanitech "7 total commits to the home-assistant organization, 7 commits to home-assistant.github.io") - [boojew (@boojew)](https://github.com/boojew "7 total commits to the home-assistant organization, 7 commits to home-assistant.github.io") -- [Boris K (@bokub)](https://github.com/bokub "11 total commits to the home-assistant organization, 6 commits to home-assistant.github.io, 5 commits to home-assistant") -- [Boyi C (@fanthos)](https://github.com/fanthos "14 total commits to the home-assistant organization, 8 commits to home-assistant-polymer, 4 commits to home-assistant, 2 commits to home-assistant.github.io") +- [Boris K (@bokub)](https://github.com/bokub "12 total commits to the home-assistant organization, 6 commits to home-assistant, 6 commits to home-assistant.github.io") +- [bottomquark (@bottomquark)](https://github.com/bottomquark "3 total commits to the home-assistant organization, 3 commits to home-assistant.github.io") +- [Boyi C (@fanthos)](https://github.com/fanthos "22 total commits to the home-assistant organization, 15 commits to home-assistant-polymer, 5 commits to home-assistant, 2 commits to home-assistant.github.io") - [bpoirriez (@bpoirriez)](https://github.com/bpoirriez "2 total commits to the home-assistant organization, 2 commits to home-assistant.github.io") - [Brad Dixon (@rbdixon)](https://github.com/rbdixon "2 total commits to the home-assistant organization, 2 commits to home-assistant") - [Brad Johnson (@bradsk88)](https://github.com/bradsk88 "2 total commits to the home-assistant organization, 2 commits to home-assistant") @@ -151,35 +160,40 @@ This page contains a list of people who have contributed in one way or another t - [Brian Cribbs (@cribbstechnologies)](https://github.com/cribbstechnologies "43 total commits to the home-assistant organization, 26 commits to home-assistant, 15 commits to home-assistant.github.io, 2 commits to home-assistant-polymer") - [Brian Fitzgerald (@Brianfit)](https://github.com/Brianfit "2 total commits to the home-assistant organization, 2 commits to home-assistant.github.io") - [Brian Hopkins (@btotharye)](https://github.com/btotharye "6 total commits to the home-assistant organization, 4 commits to home-assistant.github.io, 2 commits to home-assistant") -- [Brian J King (@brianjking)](https://github.com/brianjking "9 total commits to the home-assistant organization, 9 commits to home-assistant.github.io") +- [Brian J King (@brianjking)](https://github.com/brianjking "10 total commits to the home-assistant organization, 10 commits to home-assistant.github.io") - [Brian Jinwright (@bjinwright)](https://github.com/bjinwright "159 total commits to the home-assistant organization, 159 commits to warrant") - [Britton Clapp (@britton-clapp)](https://github.com/britton-clapp "2 total commits to the home-assistant organization, 2 commits to home-assistant.github.io") - [BRUH Automation (@bruhautomation)](https://github.com/bruhautomation "3 total commits to the home-assistant organization, 3 commits to hassbian-scripts") - [Bruno Adele (@badele)](https://github.com/badele "22 total commits to the home-assistant organization, 22 commits to home-assistant") - [Bruno Binet (@bbinet)](https://github.com/bbinet "1 total commits to the home-assistant organization, 1 commit to hassio-build") - [Bryce Edwards (@hoopty)](https://github.com/hoopty "5 total commits to the home-assistant organization, 3 commits to home-assistant, 2 commits to home-assistant.github.io") -- [c727 (@c727)](https://github.com/c727 "29 total commits to the home-assistant organization, 19 commits to home-assistant-polymer, 7 commits to home-assistant.github.io, 3 commits to home-assistant") +- [bvansambeek (@bvansambeek)](https://github.com/bvansambeek "1 total commits to the home-assistant organization, 1 commit to hassio-build") +- [c727 (@c727)](https://github.com/c727 "71 total commits to the home-assistant organization, 50 commits to home-assistant-polymer, 13 commits to home-assistant.github.io, 6 commits to home-assistant, 2 commits to hassio") - [Caius Cioran (@caiuspb)](https://github.com/caiuspb "3 total commits to the home-assistant organization, 3 commits to home-assistant") - [Caleb (@finish06)](https://github.com/finish06 "7 total commits to the home-assistant organization, 7 commits to home-assistant") - [Cameron Bulock (@cbulock)](https://github.com/cbulock "5 total commits to the home-assistant organization, 2 commits to home-assistant, 2 commits to home-assistant.github.io, 1 commit to netdisco") -- [Carlo Costanzo (@CCOSTAN)](https://github.com/CCOSTAN "95 total commits to the home-assistant organization, 87 commits to home-assistant.github.io, 5 commits to home-assistant, 1 commit to fabric-home-assistant, 1 commit to hassbian-scripts, 1 commit to homebridge-homeassistant") +- [Cameron Moore (@moorereason)](https://github.com/moorereason "3 total commits to the home-assistant organization, 3 commits to hassio-cli") +- [Carlo Costanzo (@CCOSTAN)](https://github.com/CCOSTAN "98 total commits to the home-assistant organization, 90 commits to home-assistant.github.io, 5 commits to home-assistant, 1 commit to fabric-home-assistant, 1 commit to homebridge-homeassistant, 1 commit to hassbian-scripts") - [carlosmgr (@carlosmgr)](https://github.com/carlosmgr "6 total commits to the home-assistant organization, 6 commits to home-assistant") - [Carter (@BluGeni)](https://github.com/BluGeni "2 total commits to the home-assistant organization, 2 commits to home-assistant.github.io") -- [cdce8p (@cdce8p)](https://github.com/cdce8p "23 total commits to the home-assistant organization, 12 commits to home-assistant.github.io, 8 commits to home-assistant, 3 commits to home-assistant-polymer") +- [cdce8p (@cdce8p)](https://github.com/cdce8p "89 total commits to the home-assistant organization, 53 commits to home-assistant, 29 commits to home-assistant.github.io, 4 commits to home-assistant-polymer, 3 commits to hass-release") - [Cecron (@Cecron)](https://github.com/Cecron "1 total commits to the home-assistant organization, 1 commit to appdaemon") +- [Cedric Van Goethem (@Zepheus)](https://github.com/Zepheus "2 total commits to the home-assistant organization, 2 commits to home-assistant") - [Cenk Gündoğan (@cgundogan)](https://github.com/cgundogan "1 total commits to the home-assistant organization, 1 commit to libcoap") - [Cezar Sá Espinola (@cezarsa)](https://github.com/cezarsa "2 total commits to the home-assistant organization, 2 commits to home-assistant") -- [cgtobi (@cgtobi)](https://github.com/cgtobi "22 total commits to the home-assistant organization, 13 commits to home-assistant, 9 commits to home-assistant.github.io") +- [cgtobi (@cgtobi)](https://github.com/cgtobi "28 total commits to the home-assistant organization, 17 commits to home-assistant, 11 commits to home-assistant.github.io") - [chanders (@chanders)](https://github.com/chanders "2 total commits to the home-assistant organization, 2 commits to hadashboard") - [Charles Blonde (@CharlesBlonde)](https://github.com/CharlesBlonde "19 total commits to the home-assistant organization, 12 commits to home-assistant, 7 commits to home-assistant.github.io") -- [Charles Garwood (@cgarwood)](https://github.com/cgarwood "17 total commits to the home-assistant organization, 11 commits to home-assistant.github.io, 6 commits to home-assistant") +- [Charles Garwood (@cgarwood)](https://github.com/cgarwood "22 total commits to the home-assistant organization, 12 commits to home-assistant.github.io, 7 commits to home-assistant, 3 commits to home-assistant-polymer") - [Charles Spirakis (@srcLurker)](https://github.com/srcLurker "8 total commits to the home-assistant organization, 5 commits to home-assistant, 3 commits to home-assistant.github.io") - [Chayoung You (@yous)](https://github.com/yous "3 total commits to the home-assistant organization, 3 commits to home-assistant.github.io") -- [Check your git settings! (@invalid-email-address)](https://github.com/invalid-email-address "1 total commits to the home-assistant organization, 1 commit to libcoap") -- [Chia-liang Kao (@clkao)](https://github.com/clkao "2 total commits to the home-assistant organization, 2 commits to home-assistant") +- [Check your git settings\! (@invalid-email-address)](https://github.com/invalid-email-address "1 total commits to the home-assistant organization, 1 commit to libcoap") +- [Chia\-liang Kao (@clkao)](https://github.com/clkao "2 total commits to the home-assistant organization, 2 commits to home-assistant") - [Chris (@chennin)](https://github.com/chennin "15 total commits to the home-assistant organization, 11 commits to home-assistant.github.io, 4 commits to home-assistant") - [Chris Aloi (@ctaloi)](https://github.com/ctaloi "2 total commits to the home-assistant organization, 2 commits to home-assistant.github.io") +- [Chris Crowe (@chriscrowe)](https://github.com/chriscrowe "3 total commits to the home-assistant organization, 3 commits to homebridge-homeassistant") - [Chris Huegle (@chuegle)](https://github.com/chuegle "1 total commits to the home-assistant organization, 1 commit to netdisco") +- [Chris Jones (@fezfox)](https://github.com/fezfox "2 total commits to the home-assistant organization, 2 commits to home-assistant.github.io") - [Chris Monteiro (@cmonteiro128)](https://github.com/cmonteiro128 "2 total commits to the home-assistant organization, 2 commits to home-assistant.github.io") - [Chris Mulder (@chrisvis)](https://github.com/chrisvis "2 total commits to the home-assistant organization, 2 commits to home-assistant") - [Chris Smolen (@smolz)](https://github.com/smolz "10 total commits to the home-assistant organization, 6 commits to home-assistant.github.io, 4 commits to appdaemon") @@ -189,34 +203,38 @@ This page contains a list of people who have contributed in one way or another t - [Christian Brædstrup (@LinuxChristian)](https://github.com/LinuxChristian "8 total commits to the home-assistant organization, 8 commits to home-assistant") - [Christian Lasarczyk (@ChrisLasar)](https://github.com/ChrisLasar "2 total commits to the home-assistant organization, 2 commits to home-assistant.github.io") - [Christian Studer (@cstuder)](https://github.com/cstuder "4 total commits to the home-assistant organization, 4 commits to home-assistant.github.io") -- [ChristianKuehnel (@ChristianKuehnel)](https://github.com/ChristianKuehnel "21 total commits to the home-assistant organization, 12 commits to home-assistant, 9 commits to home-assistant.github.io") +- [ChristianKuehnel (@ChristianKuehnel)](https://github.com/ChristianKuehnel "37 total commits to the home-assistant organization, 22 commits to home-assistant, 15 commits to home-assistant.github.io") - [Christoffer Kylvåg (@christoe)](https://github.com/christoe "2 total commits to the home-assistant organization, 2 commits to home-assistant.github.io") - [Christoph Wagner (@Christoph-Wagner)](https://github.com/Christoph-Wagner "4 total commits to the home-assistant organization, 4 commits to home-assistant.github.io") +- [Christopher Vella (@chrisvella)](https://github.com/chrisvella "2 total commits to the home-assistant organization, 2 commits to home-assistant.github.io") - [Christopher Viel (@Chris-V)](https://github.com/Chris-V "5 total commits to the home-assistant organization, 3 commits to home-assistant, 2 commits to home-assistant.github.io") - [chrysn (@chrysn)](https://github.com/chrysn "65 total commits to the home-assistant organization, 65 commits to libcoap") - [chz^3 (@chzchzchz)](https://github.com/chzchzchz "1 total commits to the home-assistant organization, 1 commit to pi-gen") - [Ciquattro (@CiquattroFPV)](https://github.com/CiquattroFPV "3 total commits to the home-assistant organization, 3 commits to home-assistant.github.io") -- [clach04 (@clach04)](https://github.com/clach04 "3 total commits to the home-assistant organization, 3 commits to home-assistant.github.io") -- [Claus F. Strasburger (@cfstras)](https://github.com/cfstras "5 total commits to the home-assistant organization, 5 commits to pi-gen") -- [cogneato (@cogneato)](https://github.com/cogneato "7 total commits to the home-assistant organization, 7 commits to home-assistant.github.io") +- [citruz (@citruz)](https://github.com/citruz "4 total commits to the home-assistant organization, 4 commits to home-assistant") +- [clach04 (@clach04)](https://github.com/clach04 "4 total commits to the home-assistant organization, 3 commits to home-assistant.github.io, 1 commit to hassbian-scripts") +- [Claus F\. Strasburger (@cfstras)](https://github.com/cfstras "5 total commits to the home-assistant organization, 5 commits to pi-gen") +- [cogneato (@cogneato)](https://github.com/cogneato "15 total commits to the home-assistant organization, 15 commits to home-assistant.github.io") - [Colin Dunn (@colindunn)](https://github.com/colindunn "2 total commits to the home-assistant organization, 2 commits to home-assistant") -- [Colin O'Dell (@colinodell)](https://github.com/colinodell "24 total commits to the home-assistant organization, 13 commits to home-assistant, 11 commits to home-assistant.github.io") +- [Colin Frei (@colinfrei)](https://github.com/colinfrei "2 total commits to the home-assistant organization, 2 commits to home-assistant.github.io") +- [Colin O'Dell (@colinodell)](https://github.com/colinodell "27 total commits to the home-assistant organization, 16 commits to home-assistant, 11 commits to home-assistant.github.io") - [Colin Teubner (@netopiax)](https://github.com/netopiax "2 total commits to the home-assistant organization, 2 commits to home-assistant.github.io") - [Conrad Juhl Andersen (@cnrd)](https://github.com/cnrd "7 total commits to the home-assistant organization, 4 commits to home-assistant, 3 commits to home-assistant.github.io") - [Constantine Grantcharov (@conz27)](https://github.com/conz27 "1 total commits to the home-assistant organization, 1 commit to libcoap") - [Constantine Poltyrev (@shprota)](https://github.com/shprota "1 total commits to the home-assistant organization, 1 commit to appdaemon") - [Corban Mailloux (@corbanmailloux)](https://github.com/corbanmailloux "18 total commits to the home-assistant organization, 18 commits to home-assistant.github.io") - [Corey Pauley (@devspacenine)](https://github.com/devspacenine "5 total commits to the home-assistant organization, 3 commits to home-assistant.github.io, 2 commits to home-assistant") -- [Craig J. Ward (@wardcraigj)](https://github.com/wardcraigj "27 total commits to the home-assistant organization, 20 commits to home-assistant, 7 commits to home-assistant.github.io") +- [corneyl (@corneyl)](https://github.com/corneyl "3 total commits to the home-assistant organization, 3 commits to home-assistant") +- [Craig J\. Ward (@wardcraigj)](https://github.com/wardcraigj "27 total commits to the home-assistant organization, 20 commits to home-assistant, 7 commits to home-assistant.github.io") - [CTLS (@CTLS)](https://github.com/CTLS "3 total commits to the home-assistant organization, 3 commits to home-assistant") - [CV (@dagobert)](https://github.com/dagobert "4 total commits to the home-assistant organization, 4 commits to home-assistant.github.io") -- [cxlwill (@cxlwill)](https://github.com/cxlwill "2 total commits to the home-assistant organization, 2 commits to home-assistant-polymer") -- [Dale Higgs (@dale3h)](https://github.com/dale3h "33 total commits to the home-assistant organization, 21 commits to home-assistant.github.io, 10 commits to home-assistant, 1 commit to hassbot, 1 commit to homebridge-homeassistant") +- [cxlwill (@cxlwill)](https://github.com/cxlwill "4 total commits to the home-assistant organization, 2 commits to home-assistant-polymer, 2 commits to hassbian-scripts") +- [Dale Higgs (@dale3h)](https://github.com/dale3h "36 total commits to the home-assistant organization, 24 commits to home-assistant.github.io, 10 commits to home-assistant, 1 commit to hassbot, 1 commit to homebridge-homeassistant") - [Dan (@danieljkemp)](https://github.com/danieljkemp "23 total commits to the home-assistant organization, 16 commits to home-assistant, 7 commits to home-assistant.github.io") - [Dan Chen (@djchen)](https://github.com/djchen "2 total commits to the home-assistant organization, 2 commits to home-assistant") - [Dan Cinnamon (@Cinntax)](https://github.com/Cinntax "17 total commits to the home-assistant organization, 14 commits to home-assistant, 3 commits to home-assistant.github.io") - [Dan Faulknor (@danielfaulknor)](https://github.com/danielfaulknor "2 total commits to the home-assistant organization, 2 commits to home-assistant.github.io") -- [Dan Nixon (@DanNixon)](https://github.com/DanNixon "21 total commits to the home-assistant organization, 16 commits to home-assistant, 5 commits to home-assistant.github.io") +- [Dan Nixon (@DanNixon)](https://github.com/DanNixon "25 total commits to the home-assistant organization, 19 commits to home-assistant, 6 commits to home-assistant.github.io") - [Dan Ports (@drkp)](https://github.com/drkp "4 total commits to the home-assistant organization, 4 commits to home-assistant") - [Dan Sarginson (@dansarginson)](https://github.com/dansarginson "2 total commits to the home-assistant organization, 2 commits to home-assistant") - [Dan Smith (@kk7ds)](https://github.com/kk7ds "84 total commits to the home-assistant organization, 68 commits to home-assistant, 14 commits to home-assistant.github.io, 2 commits to home-assistant-polymer") @@ -224,14 +242,15 @@ This page contains a list of people who have contributed in one way or another t - [Dani (@danichispa)](https://github.com/danichispa "9 total commits to the home-assistant organization, 9 commits to home-assistant.github.io") - [Daniel (@delneet)](https://github.com/delneet "2 total commits to the home-assistant organization, 2 commits to home-assistant.github.io") - [Daniel Escoz (@Darkhogg)](https://github.com/Darkhogg "3 total commits to the home-assistant organization, 3 commits to home-assistant.github.io") -- [Daniel Høyer Iversen (@Danielhiversen)](https://github.com/Danielhiversen "376 total commits to the home-assistant organization, 253 commits to home-assistant, 119 commits to home-assistant.github.io, 4 commits to home-assistant-polymer") -- [Daniel Perna (@danielperna84)](https://github.com/danielperna84 "83 total commits to the home-assistant organization, 39 commits to home-assistant.github.io, 38 commits to home-assistant, 6 commits to hassio-addons") +- [Daniel Høyer Iversen (@Danielhiversen)](https://github.com/Danielhiversen "303 total commits to the home-assistant organization, 189 commits to home-assistant, 111 commits to home-assistant.github.io, 3 commits to home-assistant-polymer") +- [Daniel Perna (@danielperna84)](https://github.com/danielperna84 "88 total commits to the home-assistant organization, 42 commits to home-assistant, 39 commits to home-assistant.github.io, 7 commits to hassio-addons") - [Daniel Peukert (@dpeukert)](https://github.com/dpeukert "3 total commits to the home-assistant organization, 2 commits to home-assistant.github.io, 1 commit to home-assistant-polymer") - [Daniel Schaal (@schaal)](https://github.com/schaal "2 total commits to the home-assistant organization, 2 commits to home-assistant") +- [Daniel Shokouhi (@dshokouhi)](https://github.com/dshokouhi "12 total commits to the home-assistant organization, 12 commits to home-assistant.github.io") - [Daniel Stone (@daniel-stoneuk)](https://github.com/daniel-stoneuk "2 total commits to the home-assistant organization, 2 commits to home-assistant.github.io") - [Daniel Trnka (@trnila)](https://github.com/trnila "2 total commits to the home-assistant organization, 2 commits to appdaemon") - [Daniel Watkins (@OddBloke)](https://github.com/OddBloke "3 total commits to the home-assistant organization, 3 commits to home-assistant") -- [Daniel Welch (@danielwelch)](https://github.com/danielwelch "2 total commits to the home-assistant organization, 2 commits to homebridge-homeassistant") +- [Daniel Welch (@danielwelch)](https://github.com/danielwelch "6 total commits to the home-assistant organization, 3 commits to home-assistant.github.io, 2 commits to homebridge-homeassistant, 1 commit to hassio-addons") - [DanielXYZ2000 (@DanielXYZ2000)](https://github.com/DanielXYZ2000 "3 total commits to the home-assistant organization, 2 commits to home-assistant.github.io, 1 commit to hassio-addons") - [Daniyar Yeralin (@yeralin)](https://github.com/yeralin "1 total commits to the home-assistant organization, 1 commit to homebridge-homeassistant") - [dasos (@dasos)](https://github.com/dasos "11 total commits to the home-assistant organization, 7 commits to home-assistant, 3 commits to home-assistant.github.io, 1 commit to netdisco") @@ -240,130 +259,120 @@ This page contains a list of people who have contributed in one way or another t - [Dave Banks (@djbanks)](https://github.com/djbanks "2 total commits to the home-assistant organization, 2 commits to appdaemon") - [Dave J (@kxtcd950)](https://github.com/kxtcd950 "3 total commits to the home-assistant organization, 3 commits to hassbian-scripts") - [DaveSergeant (@dethpickle)](https://github.com/dethpickle "2 total commits to the home-assistant organization, 2 commits to home-assistant") -- [David (@fanaticDavid)](https://github.com/fanaticDavid "14 total commits to the home-assistant organization, 10 commits to home-assistant.github.io, 3 commits to home-assistant, 1 commit to home-assistant-polymer") -- [David (Drew) Jackson (@David-Jackson)](https://github.com/David-Jackson "2 total commits to the home-assistant organization, 2 commits to home-assistant.github.io") +- [David (@fanaticDavid)](https://github.com/fanaticDavid "16 total commits to the home-assistant organization, 12 commits to home-assistant.github.io, 3 commits to home-assistant, 1 commit to home-assistant-polymer") +- [David \(Drew\) Jackson (@David-Jackson)](https://github.com/David-Jackson "2 total commits to the home-assistant organization, 2 commits to home-assistant.github.io") +- [David Broadfoot (@dlbroadfoot)](https://github.com/dlbroadfoot "3 total commits to the home-assistant organization, 3 commits to home-assistant") - [David De Sloovere (@DavidDeSloovere)](https://github.com/DavidDeSloovere "16 total commits to the home-assistant organization, 16 commits to home-assistant.github.io") - [David Fiel (@dfiel)](https://github.com/dfiel "2 total commits to the home-assistant organization, 2 commits to home-assistant") - [David Grant (@davegravy)](https://github.com/davegravy "6 total commits to the home-assistant organization, 4 commits to home-assistant.github.io, 2 commits to home-assistant") -- [David McNett (@nugget)](https://github.com/nugget "10 total commits to the home-assistant organization, 5 commits to home-assistant, 5 commits to home-assistant.github.io") +- [David McNett (@nugget)](https://github.com/nugget "10 total commits to the home-assistant organization, 5 commits to home-assistant.github.io, 5 commits to home-assistant") - [David Ohayon (@ohayon)](https://github.com/ohayon "3 total commits to the home-assistant organization, 3 commits to issue-bot") - [David Straub (@DavidMStraub)](https://github.com/DavidMStraub "9 total commits to the home-assistant organization, 5 commits to home-assistant, 4 commits to home-assistant.github.io") - [David Wang (@dcwangmit01)](https://github.com/dcwangmit01 "2 total commits to the home-assistant organization, 2 commits to pi-gen") -- [David-Leon Pohl (@DavidLP)](https://github.com/DavidLP "15 total commits to the home-assistant organization, 13 commits to home-assistant, 2 commits to home-assistant.github.io") +- [David\-Leon Pohl (@DavidLP)](https://github.com/DavidLP "15 total commits to the home-assistant organization, 13 commits to home-assistant, 2 commits to home-assistant.github.io") - [davidedmundson (@davidedmundson)](https://github.com/davidedmundson "7 total commits to the home-assistant organization, 4 commits to home-assistant, 3 commits to home-assistant.github.io") - [Dawid Wróbel (@wrobelda)](https://github.com/wrobelda "5 total commits to the home-assistant organization, 5 commits to home-assistant.github.io") - [Dean Camera (@abcminiuser)](https://github.com/abcminiuser "4 total commits to the home-assistant organization, 2 commits to home-assistant, 2 commits to home-assistant.github.io") - [deisi (@deisi)](https://github.com/deisi "10 total commits to the home-assistant organization, 10 commits to home-assistant") - [Delio Castillo (@jangeador)](https://github.com/jangeador "2 total commits to the home-assistant organization, 2 commits to hassio-addons") -- [Demid Lupin (@lupin-de-mid)](https://github.com/lupin-de-mid "5 total commits to the home-assistant organization, 3 commits to home-assistant.github.io, 2 commits to home-assistant") +- [Demid Lupin (@lupin-de-mid)](https://github.com/lupin-de-mid "3 total commits to the home-assistant organization, 3 commits to home-assistant.github.io") - [Denix (@denics)](https://github.com/denics "2 total commits to the home-assistant organization, 2 commits to home-assistant.github.io") - [Dennis de Greef (@dennisdegreef)](https://github.com/dennisdegreef "2 total commits to the home-assistant organization, 2 commits to home-assistant") - [Dennis Karpienski (@TheRealLink)](https://github.com/TheRealLink "24 total commits to the home-assistant organization, 15 commits to home-assistant-polymer, 6 commits to home-assistant, 2 commits to home-assistant.github.io, 1 commit to netdisco") - [Dennis Sutch (@sutch)](https://github.com/sutch "2 total commits to the home-assistant organization, 2 commits to home-assistant.github.io") - [Derek (@itchaboy)](https://github.com/itchaboy "5 total commits to the home-assistant organization, 5 commits to home-assistant.github.io") - [Derek Brooks (@broox)](https://github.com/broox "39 total commits to the home-assistant organization, 30 commits to home-assistant, 9 commits to home-assistant.github.io") -- [dersger (@dersger)](https://github.com/dersger "1 total commits to the home-assistant organization, 1 commit to home-assistant-polymer") +- [dersger (@dersger)](https://github.com/dersger "4 total commits to the home-assistant organization, 3 commits to home-assistant, 1 commit to home-assistant-polymer") - [devdelay (@devdelay)](https://github.com/devdelay "16 total commits to the home-assistant organization, 7 commits to home-assistant.github.io, 5 commits to home-assistant, 4 commits to homebridge-homeassistant") - [Devon Peet (@dpeet)](https://github.com/dpeet "5 total commits to the home-assistant organization, 5 commits to home-assistant.github.io") -- [Diogo Gomes (@dgomes)](https://github.com/dgomes "22 total commits to the home-assistant organization, 11 commits to home-assistant, 11 commits to home-assistant.github.io") +- [Diogo Gomes (@dgomes)](https://github.com/dgomes "46 total commits to the home-assistant organization, 28 commits to home-assistant, 18 commits to home-assistant.github.io") - [DoloresHA (@DoloresHA)](https://github.com/DoloresHA "2 total commits to the home-assistant organization, 2 commits to home-assistant.github.io") - [Domantas (@Dohxis)](https://github.com/Dohxis "1 total commits to the home-assistant organization, 1 commit to home-assistant-polymer") -- [Dougal Matthews (@d0ugal)](https://github.com/d0ugal "4 total commits to the home-assistant organization, 2 commits to home-assistant, 2 commits to home-assistant.github.io") -- [dramamoose (@dramamoose)](https://github.com/dramamoose "3 total commits to the home-assistant organization, 3 commits to home-assistant.github.io") +- [Dougal Matthews (@d0ugal)](https://github.com/d0ugal "3 total commits to the home-assistant organization, 3 commits to home-assistant") +- [dramamoose (@dramamoose)](https://github.com/dramamoose "7 total commits to the home-assistant organization, 4 commits to home-assistant, 3 commits to home-assistant.github.io") - [DrewSK (@dzsquared)](https://github.com/dzsquared "8 total commits to the home-assistant organization, 8 commits to home-assistant.github.io") -- [DubhAd (@DubhAd)](https://github.com/DubhAd "128 total commits to the home-assistant organization, 128 commits to home-assistant.github.io") +- [DubhAd (@DubhAd)](https://github.com/DubhAd "240 total commits to the home-assistant organization, 240 commits to home-assistant.github.io") - [Duoxilian (@Duoxilian)](https://github.com/Duoxilian "11 total commits to the home-assistant organization, 6 commits to home-assistant.github.io, 5 commits to home-assistant") - [ebpetway (@ebpetway)](https://github.com/ebpetway "55 total commits to the home-assistant organization, 55 commits to warrant") -- [Edwin Smulders (@Dutchy-)](https://github.com/Dutchy- "4 total commits to the home-assistant organization, 2 commits to home-assistant, 2 commits to home-assistant.github.io") +- [Edwin Smulders (@Dutchy-)](https://github.com/Dutchy- "2 total commits to the home-assistant organization, 2 commits to home-assistant") - [Egor Tsinko (@etsinko)](https://github.com/etsinko "12 total commits to the home-assistant organization, 9 commits to home-assistant, 3 commits to home-assistant.github.io") -- [Eitan Mosenkis (@emosenkis)](https://github.com/emosenkis "6 total commits to the home-assistant organization, 3 commits to home-assistant, 2 commits to home-assistant.github.io, 1 commit to netdisco") +- [Eitan Mosenkis (@emosenkis)](https://github.com/emosenkis "4 total commits to the home-assistant organization, 3 commits to home-assistant, 1 commit to netdisco") - [eldanb (@eldanb)](https://github.com/eldanb "1 total commits to the home-assistant organization, 1 commit to homebridge-homeassistant") -- [Eleftherios Chamakiotis (@lexam79)](https://github.com/lexam79 "4 total commits to the home-assistant organization, 2 commits to home-assistant, 2 commits to home-assistant.github.io") -- [Ellis Percival (@flyte)](https://github.com/flyte "31 total commits to the home-assistant organization, 25 commits to home-assistant, 6 commits to home-assistant.github.io") -- [Emil Horpen Hetty (@emilhetty)](https://github.com/emilhetty "2 total commits to the home-assistant organization, 2 commits to home-assistant.github.io") +- [Eleftherios Chamakiotis (@lexam79)](https://github.com/lexam79 "2 total commits to the home-assistant organization, 2 commits to home-assistant") +- [Ellis Percival (@flyte)](https://github.com/flyte "29 total commits to the home-assistant organization, 25 commits to home-assistant, 4 commits to home-assistant.github.io") - [endor-force (@endor-force)](https://github.com/endor-force "9 total commits to the home-assistant organization, 4 commits to hassio-addons, 4 commits to home-assistant.github.io, 1 commit to hassio-build") - [engrbm87 (@engrbm87)](https://github.com/engrbm87 "3 total commits to the home-assistant organization, 3 commits to appdaemon") - [Eric Hagan (@ehagan)](https://github.com/ehagan "4 total commits to the home-assistant organization, 3 commits to home-assistant, 1 commit to home-assistant-polymer") - [Eric Oosting (@eoosting)](https://github.com/eoosting "3 total commits to the home-assistant organization, 3 commits to home-assistant.github.io") - [Eric Rolf (@xrolfex)](https://github.com/xrolfex "13 total commits to the home-assistant organization, 13 commits to home-assistant") -- [Eric Thompson (@er0ck)](https://github.com/er0ck "2 total commits to the home-assistant organization, 2 commits to home-assistant.github.io") -- [Erik Eriksson (@molobrakos)](https://github.com/molobrakos "111 total commits to the home-assistant organization, 97 commits to home-assistant, 11 commits to home-assistant.github.io, 3 commits to netdisco") -- [Erik-jan Riemers (@riemers)](https://github.com/riemers "14 total commits to the home-assistant organization, 13 commits to home-assistant.github.io, 1 commit to hassbian-scripts") -- [escoand (@escoand)](https://github.com/escoand "3 total commits to the home-assistant organization, 3 commits to home-assistant") +- [Erik Eriksson (@molobrakos)](https://github.com/molobrakos "116 total commits to the home-assistant organization, 100 commits to home-assistant, 13 commits to home-assistant.github.io, 3 commits to netdisco") +- [Erik\-jan Riemers (@riemers)](https://github.com/riemers "14 total commits to the home-assistant organization, 13 commits to home-assistant.github.io, 1 commit to hassbian-scripts") +- [escoand (@escoand)](https://github.com/escoand "8 total commits to the home-assistant organization, 6 commits to home-assistant, 2 commits to netdisco") - [ettisan (@ettisan)](https://github.com/ettisan "8 total commits to the home-assistant organization, 8 commits to home-assistant") - [Eu (@covrig)](https://github.com/covrig "1 total commits to the home-assistant organization, 1 commit to home-assistant-polymer") - [Eugenio Panadero (@azogue)](https://github.com/azogue "76 total commits to the home-assistant organization, 45 commits to home-assistant, 25 commits to home-assistant.github.io, 3 commits to homebridge-homeassistant, 3 commits to home-assistant-polymer") - [Ezra Bowden (@bn0)](https://github.com/bn0 "2 total commits to the home-assistant organization, 2 commits to warrant") -- [Fabian Affolter (@fabaff)](https://github.com/fabaff "4534 total commits to the home-assistant organization, 2916 commits to home-assistant.github.io, 1515 commits to home-assistant, 32 commits to home-assistant-assets, 30 commits to home-assistant-notebooks, 11 commits to hassio-build, 11 commits to home-assistant-polymer, 8 commits to netdisco, 5 commits to hassio-addons, 3 commits to development-docs, 2 commits to hassio, 1 commit to home-assistant-js-websocket") +- [Fabian Affolter (@fabaff)](https://github.com/fabaff "4643 total commits to the home-assistant organization, 2964 commits to home-assistant.github.io, 1567 commits to home-assistant, 32 commits to home-assistant-assets, 31 commits to home-assistant-notebooks, 11 commits to hassio-build, 11 commits to home-assistant-polymer, 8 commits to netdisco, 5 commits to hassio-addons, 4 commits to hassio, 3 commits to development-docs, 3 commits to hassio-os, 2 commits to home-assistant-iOS, 1 commit to example-custom-config, 1 commit to home-assistant-js-websocket") - [Fabian Heredia Montiel (@fabianhjr)](https://github.com/fabianhjr "4 total commits to the home-assistant organization, 4 commits to home-assistant") -- [Fabien Piuzzi (@reefab)](https://github.com/reefab "1 total commits to the home-assistant organization, 1 commit to home-assistant-polymer") +- [Fabien Piuzzi (@reefab)](https://github.com/reefab "3 total commits to the home-assistant organization, 2 commits to home-assistant, 1 commit to home-assistant-polymer") - [Fabrizio Furnari (@fabfurnari)](https://github.com/fabfurnari "5 total commits to the home-assistant organization, 3 commits to home-assistant.github.io, 2 commits to home-assistant") - [fakezeta (@fakezeta)](https://github.com/fakezeta "7 total commits to the home-assistant organization, 7 commits to home-assistant") -- [Fares Rihani (@anchepiece)](https://github.com/anchepiece "2 total commits to the home-assistant organization, 2 commits to home-assistant.github.io") - [Felix (@xifle)](https://github.com/xifle "2 total commits to the home-assistant organization, 2 commits to home-assistant") - [Felix Krause (@KrauseFx)](https://github.com/KrauseFx "27 total commits to the home-assistant organization, 27 commits to issue-bot") - [Ferry van Zeelst (@StaticCube)](https://github.com/StaticCube "6 total commits to the home-assistant organization, 4 commits to home-assistant.github.io, 2 commits to home-assistant") - [Finbarr Brady (@fbradyirl)](https://github.com/fbradyirl "8 total commits to the home-assistant organization, 8 commits to home-assistant") - [Florian Holzapfel (@florianholzapfel)](https://github.com/florianholzapfel "11 total commits to the home-assistant organization, 4 commits to home-assistant, 4 commits to home-assistant.github.io, 3 commits to netdisco") -- [Florian Klien (@flowolf)](https://github.com/flowolf "16 total commits to the home-assistant organization, 13 commits to home-assistant.github.io, 3 commits to home-assistant") +- [Florian Klien (@flowolf)](https://github.com/flowolf "17 total commits to the home-assistant organization, 14 commits to home-assistant.github.io, 3 commits to home-assistant") - [florianj1 (@florianj1)](https://github.com/florianj1 "1 total commits to the home-assistant organization, 1 commit to hassio") - [florincosta (@florincosta)](https://github.com/florincosta "6 total commits to the home-assistant organization, 3 commits to home-assistant, 3 commits to home-assistant.github.io") - [Fonta (@f0nt4)](https://github.com/f0nt4 "4 total commits to the home-assistant organization, 4 commits to home-assistant.github.io") -- [Franck Nijhof (@frenck)](https://github.com/frenck "29 total commits to the home-assistant organization, 20 commits to home-assistant.github.io, 5 commits to hassio, 2 commits to home-assistant-polymer, 1 commit to hassio-cli, 1 commit to appdaemon") +- [Franck Nijhof (@frenck)](https://github.com/frenck "30 total commits to the home-assistant organization, 21 commits to home-assistant.github.io, 5 commits to hassio, 2 commits to home-assistant-polymer, 1 commit to hassio-cli, 1 commit to appdaemon") - [Frank (@syphernl)](https://github.com/syphernl "1 total commits to the home-assistant organization, 1 commit to home-assistant-polymer") - [Frantz (@rofrantz)](https://github.com/rofrantz "16 total commits to the home-assistant organization, 9 commits to home-assistant, 4 commits to home-assistant.github.io, 3 commits to netdisco") - [Frederic Hemberger (@fhemberger)](https://github.com/fhemberger "93 total commits to the home-assistant organization, 93 commits to home-assistant.github.io") -- [Fredrik Fjeld (@fredrikfjeld)](https://github.com/fredrikfjeld "2 total commits to the home-assistant organization, 2 commits to home-assistant.github.io") -- [Fredrik Lindqvist (@Landrash)](https://github.com/Landrash "183 total commits to the home-assistant organization, 77 commits to hassbian-scripts, 70 commits to home-assistant.github.io, 31 commits to pi-gen, 4 commits to home-assistant, 1 commit to home-assistant-polymer") +- [Frederik Bolding (@FrederikBolding)](https://github.com/FrederikBolding "4 total commits to the home-assistant organization, 4 commits to home-assistant") +- [Fredrik Lindqvist (@Landrash)](https://github.com/Landrash "212 total commits to the home-assistant organization, 100 commits to hassbian-scripts, 73 commits to home-assistant.github.io, 34 commits to pi-gen, 4 commits to home-assistant, 1 commit to home-assistant-polymer") - [freol35241 (@freol35241)](https://github.com/freol35241 "3 total commits to the home-assistant organization, 3 commits to home-assistant") - [fuga2136 (@fuga2136)](https://github.com/fuga2136 "13 total commits to the home-assistant organization, 13 commits to home-assistant.github.io") - [Gabor SZOLLOSI (@szogi)](https://github.com/szogi "3 total commits to the home-assistant organization, 2 commits to home-assistant, 1 commit to appdaemon") - [GadgetReactor (@GadgetReactor)](https://github.com/GadgetReactor "2 total commits to the home-assistant organization, 2 commits to home-assistant") -- [Gavin Mogan (@halkeye)](https://github.com/halkeye "2 total commits to the home-assistant organization, 2 commits to home-assistant.github.io") - [Geoff Norton (@kangaroo)](https://github.com/kangaroo "14 total commits to the home-assistant organization, 14 commits to home-assistant") -- [George.M (@nodinosaur)](https://github.com/nodinosaur "8 total commits to the home-assistant organization, 6 commits to home-assistant.github.io, 2 commits to home-assistant") +- [George\.M (@nodinosaur)](https://github.com/nodinosaur "8 total commits to the home-assistant organization, 6 commits to home-assistant.github.io, 2 commits to home-assistant") - [Georgi Kirichkov (@kirichkov)](https://github.com/kirichkov "17 total commits to the home-assistant organization, 11 commits to home-assistant.github.io, 5 commits to home-assistant, 1 commit to appdaemon") - [Georgi Yanev (@jumpalottahigh)](https://github.com/jumpalottahigh "6 total commits to the home-assistant organization, 4 commits to home-assistant.github.io, 2 commits to home-assistant-polymer") - [Georgii Staroselskii (@staroselskii)](https://github.com/staroselskii "1 total commits to the home-assistant organization, 1 commit to pi-gen") -- [Gerard (@gerard33)](https://github.com/gerard33 "3 total commits to the home-assistant organization, 3 commits to home-assistant.github.io") +- [Gerard (@gerard33)](https://github.com/gerard33 "9 total commits to the home-assistant organization, 5 commits to home-assistant.github.io, 4 commits to home-assistant") - [Gergely Imreh (@imrehg)](https://github.com/imrehg "16 total commits to the home-assistant organization, 11 commits to home-assistant, 5 commits to home-assistant.github.io") - [Gianluca Barbaro (@MrMep)](https://github.com/MrMep "24 total commits to the home-assistant organization, 16 commits to home-assistant, 8 commits to home-assistant.github.io") -- [Gianpaolo Macario (@gmacario)](https://github.com/gmacario "2 total commits to the home-assistant organization, 2 commits to home-assistant.github.io") -- [Giel Janssens (@gieljnssns)](https://github.com/gieljnssns "6 total commits to the home-assistant organization, 4 commits to home-assistant, 2 commits to home-assistant.github.io") +- [Giel Janssens (@gieljnssns)](https://github.com/gieljnssns "4 total commits to the home-assistant organization, 4 commits to home-assistant") +- [GitBook Bot (@gitbook-bot)](https://github.com/gitbook-bot "1 total commits to the home-assistant organization, 1 commit to developers.home-assistant") - [githubbuh (@githubbuh)](https://github.com/githubbuh "5 total commits to the home-assistant organization, 5 commits to home-assistant.github.io") - [gitmopp (@gitmopp)](https://github.com/gitmopp "3 total commits to the home-assistant organization, 3 commits to home-assistant.github.io") - [Giuseppe (@glpatcern)](https://github.com/glpatcern "2 total commits to the home-assistant organization, 2 commits to home-assistant") - [GMFalka (@GMFalka)](https://github.com/GMFalka "3 total commits to the home-assistant organization, 3 commits to home-assistant.github.io") -- [Gopal Kildoliya (@gopalkildoliya)](https://github.com/gopalkildoliya "6 total commits to the home-assistant organization, 4 commits to home-assistant, 2 commits to home-assistant.github.io") -- [Graeme Smith (@Instagraeme)](https://github.com/Instagraeme "2 total commits to the home-assistant organization, 2 commits to home-assistant.github.io") +- [Gopal Kildoliya (@gopalkildoliya)](https://github.com/gopalkildoliya "4 total commits to the home-assistant organization, 4 commits to home-assistant") - [Grant McConnaughey (@grantmcconnaughey)](https://github.com/grantmcconnaughey "8 total commits to the home-assistant organization, 8 commits to warrant") -- [GreenTurtwig (@GreenTurtwig)](https://github.com/GreenTurtwig "83 total commits to the home-assistant organization, 75 commits to home-assistant.github.io, 8 commits to home-assistant") -- [Greg Dowling (@pavoni)](https://github.com/pavoni "251 total commits to the home-assistant organization, 224 commits to home-assistant, 25 commits to home-assistant.github.io, 2 commits to netdisco") -- [Greg Laabs (@OverloadUT)](https://github.com/OverloadUT "11 total commits to the home-assistant organization, 8 commits to home-assistant, 3 commits to home-assistant.github.io") +- [GreenTurtwig (@GreenTurtwig)](https://github.com/GreenTurtwig "80 total commits to the home-assistant organization, 75 commits to home-assistant.github.io, 5 commits to home-assistant") +- [Greg Dowling (@pavoni)](https://github.com/pavoni "255 total commits to the home-assistant organization, 228 commits to home-assistant, 25 commits to home-assistant.github.io, 2 commits to netdisco") +- [Greg Laabs (@OverloadUT)](https://github.com/OverloadUT "14 total commits to the home-assistant organization, 11 commits to home-assistant, 3 commits to home-assistant.github.io") - [Greg MacLellan (@gregmac)](https://github.com/gregmac "1 total commits to the home-assistant organization, 1 commit to pi-gen") -- [Greg Stengel (@theCMack)](https://github.com/theCMack "2 total commits to the home-assistant organization, 2 commits to home-assistant.github.io") -- [Greg Stevenson (@gstevenson)](https://github.com/gstevenson "5 total commits to the home-assistant organization, 5 commits to home-assistant.github.io") -- [Greg. A. (@gautric)](https://github.com/gautric "2 total commits to the home-assistant organization, 2 commits to home-assistant") +- [Greg Stevenson (@gstevenson)](https://github.com/gstevenson "3 total commits to the home-assistant organization, 3 commits to home-assistant.github.io") +- [Greg\. A\. (@gautric)](https://github.com/gautric "2 total commits to the home-assistant organization, 2 commits to home-assistant") - [GTH (@gunnarhelgason)](https://github.com/gunnarhelgason "2 total commits to the home-assistant organization, 2 commits to appdaemon") - [Guillaume Rischard (@grischard)](https://github.com/grischard "1 total commits to the home-assistant organization, 1 commit to home-assistant-polymer") - [Gustav Ahlberg (@Gyran)](https://github.com/Gyran "20 total commits to the home-assistant organization, 20 commits to home-assistant") -- [Guyanthalas (@Guyanthalas)](https://github.com/Guyanthalas "2 total commits to the home-assistant organization, 2 commits to home-assistant.github.io") - [gwendalg (@gwendalg)](https://github.com/gwendalg "3 total commits to the home-assistant organization, 3 commits to home-assistant") -- [Hamid (@hamid-elaosta)](https://github.com/hamid-elaosta "3 total commits to the home-assistant organization, 3 commits to home-assistant.github.io") -- [Hao Hu (@howiehu)](https://github.com/howiehu "2 total commits to the home-assistant organization, 2 commits to home-assistant.github.io") -- [happyleavesaoc (@happyleavesaoc)](https://github.com/happyleavesaoc "109 total commits to the home-assistant organization, 86 commits to home-assistant, 22 commits to home-assistant.github.io, 1 commit to home-assistant-polymer") -- [Harald Nagel (@haraldnagel)](https://github.com/haraldnagel "8 total commits to the home-assistant organization, 6 commits to home-assistant, 2 commits to home-assistant.github.io") -- [Hari Menon (@floydpink)](https://github.com/floydpink "2 total commits to the home-assistant organization, 2 commits to home-assistant.github.io") +- [happyleavesaoc (@happyleavesaoc)](https://github.com/happyleavesaoc "114 total commits to the home-assistant organization, 90 commits to home-assistant, 23 commits to home-assistant.github.io, 1 commit to home-assistant-polymer") +- [Harald Nagel (@haraldnagel)](https://github.com/haraldnagel "6 total commits to the home-assistant organization, 6 commits to home-assistant") - [Harris Borawski (@hborawski)](https://github.com/hborawski "2 total commits to the home-assistant organization, 2 commits to home-assistant") - [hawk259 (@hawk259)](https://github.com/hawk259 "13 total commits to the home-assistant organization, 7 commits to home-assistant, 5 commits to home-assistant.github.io, 1 commit to home-assistant-polymer") - [Heath Paddock (@heathbar)](https://github.com/heathbar "6 total commits to the home-assistant organization, 6 commits to home-assistant") - [Heiko Rothe (@mKeRix)](https://github.com/mKeRix "20 total commits to the home-assistant organization, 15 commits to home-assistant, 5 commits to home-assistant.github.io") -- [Heiko Thiery (@hthiery)](https://github.com/hthiery "4 total commits to the home-assistant organization, 2 commits to home-assistant, 2 commits to home-assistant.github.io") +- [Heiko Thiery (@hthiery)](https://github.com/hthiery "7 total commits to the home-assistant organization, 4 commits to home-assistant, 3 commits to home-assistant.github.io") - [Hellowlol (@Hellowlol)](https://github.com/Hellowlol "4 total commits to the home-assistant organization, 3 commits to netdisco, 1 commit to appdaemon") - [Helmut Januschka (@hjanuschka)](https://github.com/hjanuschka "3 total commits to the home-assistant organization, 3 commits to issue-bot") - [Henning Dickten (@hensing)](https://github.com/hensing "2 total commits to the home-assistant organization, 2 commits to home-assistant") -- [Henrik Aronsson (@heennkkee)](https://github.com/heennkkee "2 total commits to the home-assistant organization, 2 commits to home-assistant.github.io") -- [Henrik Nicolaisen (@hmn)](https://github.com/hmn "6 total commits to the home-assistant organization, 6 commits to home-assistant") +- [Henrik Nicolaisen (@hmn)](https://github.com/hmn "8 total commits to the home-assistant organization, 8 commits to home-assistant") - [Hernán Rossetto (@hmronline)](https://github.com/hmronline "2 total commits to the home-assistant organization, 2 commits to home-assistant") - [heytcass (@heytcass)](https://github.com/heytcass "5 total commits to the home-assistant organization, 5 commits to home-assistant.github.io") - [Hillary Fraley (@hillaryfraley)](https://github.com/hillaryfraley "12 total commits to the home-assistant organization, 12 commits to home-assistant.github.io") @@ -371,95 +380,94 @@ This page contains a list of people who have contributed in one way or another t - [Hugo Dupras (@jabesq)](https://github.com/jabesq "28 total commits to the home-assistant organization, 20 commits to home-assistant, 8 commits to home-assistant.github.io") - [Hugo Gresse (@HugoGresse)](https://github.com/HugoGresse "8 total commits to the home-assistant organization, 8 commits to home-assistant.github.io") - [Hung Le (@hungle)](https://github.com/hungle "1 total commits to the home-assistant organization, 1 commit to libcoap") -- [Huw Davies (@beardedgeek)](https://github.com/beardedgeek "2 total commits to the home-assistant organization, 2 commits to home-assistant.github.io") - [Hydreliox (@HydrelioxGitHub)](https://github.com/HydrelioxGitHub "46 total commits to the home-assistant organization, 34 commits to home-assistant, 12 commits to home-assistant.github.io") -- [Iain Matchett (@matchett808)](https://github.com/matchett808 "2 total commits to the home-assistant organization, 2 commits to home-assistant.github.io") - [Ian Copp (@icopp)](https://github.com/icopp "3 total commits to the home-assistant organization, 3 commits to home-assistant") - [ianj001 (@ianj001)](https://github.com/ianj001 "7 total commits to the home-assistant organization, 7 commits to home-assistant.github.io") - [icovada (@icovada)](https://github.com/icovada "6 total commits to the home-assistant organization, 3 commits to home-assistant, 3 commits to home-assistant.github.io") +- [Igor Bernstein (@igorbernstein2)](https://github.com/igorbernstein2 "2 total commits to the home-assistant organization, 2 commits to home-assistant") - [Igor Shults (@ishults)](https://github.com/ishults "12 total commits to the home-assistant organization, 6 commits to home-assistant, 5 commits to home-assistant.github.io, 1 commit to home-assistant-polymer") -- [Ioan Loosley (@ioangogo)](https://github.com/ioangogo "9 total commits to the home-assistant organization, 9 commits to home-assistant.github.io") -- [IoTmessenger (@IoTmessenger)](https://github.com/IoTmessenger "2 total commits to the home-assistant organization, 2 commits to home-assistant.github.io") +- [Ioan Loosley (@ioangogo)](https://github.com/ioangogo "10 total commits to the home-assistant organization, 10 commits to home-assistant.github.io") - [Issac Kelly (@issackelly)](https://github.com/issackelly "3 total commits to the home-assistant organization, 3 commits to home-assistant") -- [J-CMartin (@J-CMartin)](https://github.com/J-CMartin "2 total commits to the home-assistant organization, 2 commits to home-assistant.github.io") -- [J. B. Rainsberger (@jbrains)](https://github.com/jbrains "2 total commits to the home-assistant organization, 2 commits to home-assistant.github.io") - [Jacen (@jacen92)](https://github.com/jacen92 "2 total commits to the home-assistant organization, 2 commits to pi-gen") - [jack (@jackmakesthings)](https://github.com/jackmakesthings "3 total commits to the home-assistant organization, 3 commits to home-assistant.github.io") - [Jack Chapple (@jchapple)](https://github.com/jchapple "2 total commits to the home-assistant organization, 2 commits to home-assistant") - [Jack Fan (@JackWindows)](https://github.com/JackWindows "2 total commits to the home-assistant organization, 2 commits to home-assistant") - [Jack Minardi (@jminardi)](https://github.com/jminardi "8 total commits to the home-assistant organization, 8 commits to home-assistant") -- [Jacob Mansfield (@cyberjacob)](https://github.com/cyberjacob "2 total commits to the home-assistant organization, 2 commits to home-assistant") +- [Jacob Mansfield (@cyberjacob)](https://github.com/cyberjacob "3 total commits to the home-assistant organization, 3 commits to home-assistant") - [Jacob Minnis (@jminn)](https://github.com/jminn "2 total commits to the home-assistant organization, 2 commits to home-assistant") - [Jacob Siverskog (@jsiverskog)](https://github.com/jsiverskog "1 total commits to the home-assistant organization, 1 commit to pi-gen") -- [Jacob Tomlinson (@jacobtomlinson)](https://github.com/jacobtomlinson "8 total commits to the home-assistant organization, 6 commits to home-assistant.github.io, 2 commits to home-assistant") +- [Jacob Tomlinson (@jacobtomlinson)](https://github.com/jacobtomlinson "6 total commits to the home-assistant organization, 4 commits to home-assistant.github.io, 2 commits to home-assistant") - [Jaimyn Mayer (@jabelone)](https://github.com/jabelone "1 total commits to the home-assistant organization, 1 commit to hassbian-scripts") -- [Jake McCrary (@jakemcc)](https://github.com/jakemcc "2 total commits to the home-assistant organization, 2 commits to home-assistant.github.io") - [Jakub Bittner (@rexcze)](https://github.com/rexcze "2 total commits to the home-assistant organization, 2 commits to home-assistant-polymer") - [James Cole (@jamespcole)](https://github.com/jamespcole "94 total commits to the home-assistant organization, 93 commits to home-assistant, 1 commit to home-assistant-js") -- [James Ruan (@jamesruan)](https://github.com/jamesruan "1 total commits to the home-assistant organization, 1 commit to pi-gen") -- [Jamie van Dyke (@fearoffish)](https://github.com/fearoffish "3 total commits to the home-assistant organization, 2 commits to home-assistant.github.io, 1 commit to home-assistant-iOS") -- [JammyDodger231 (@JammyDodger231)](https://github.com/JammyDodger231 "4 total commits to the home-assistant organization, 4 commits to home-assistant.github.io") -- [Jan Almeroth (@jalmeroth)](https://github.com/jalmeroth "8 total commits to the home-assistant organization, 5 commits to home-assistant, 2 commits to home-assistant.github.io, 1 commit to home-assistant-polymer") +- [James Marsh (@doctorjames)](https://github.com/doctorjames "2 total commits to the home-assistant organization, 2 commits to home-assistant") +- [James Ruan (@jamesruan)](https://github.com/jamesruan "2 total commits to the home-assistant organization, 2 commits to pi-gen") +- [Jamie van Dyke (@fearoffish)](https://github.com/fearoffish "1 total commits to the home-assistant organization, 1 commit to home-assistant-iOS") +- [JammyDodger231 (@JammyDodger231)](https://github.com/JammyDodger231 "5 total commits to the home-assistant organization, 5 commits to home-assistant.github.io") +- [Jan Almeroth (@jalmeroth)](https://github.com/jalmeroth "6 total commits to the home-assistant organization, 5 commits to home-assistant, 1 commit to home-assistant-polymer") - [Jan Harkes (@jaharkes)](https://github.com/jaharkes "110 total commits to the home-assistant organization, 100 commits to home-assistant, 10 commits to netdisco") - [Jan Losinski (@janLo)](https://github.com/janLo "21 total commits to the home-assistant organization, 16 commits to home-assistant, 5 commits to home-assistant.github.io") - [Jan Pobořil (@iBobik)](https://github.com/iBobik "3 total commits to the home-assistant organization, 3 commits to home-assistant.github.io") - [Jan Willhaus (@janwh)](https://github.com/janwh "3 total commits to the home-assistant organization, 3 commits to home-assistant.github.io") -- [Janne Grunau (@jannau)](https://github.com/jannau "5 total commits to the home-assistant organization, 3 commits to home-assistant, 2 commits to home-assistant.github.io") -- [Jared Beckham (@jtbeckha)](https://github.com/jtbeckha "4 total commits to the home-assistant organization, 2 commits to home-assistant, 2 commits to home-assistant.github.io") -- [Jared J. (@jjensn)](https://github.com/jjensn "1 total commits to the home-assistant organization, 1 commit to netdisco") +- [Janne Grunau (@jannau)](https://github.com/jannau "3 total commits to the home-assistant organization, 3 commits to home-assistant") +- [Jared Beckham (@jtbeckha)](https://github.com/jtbeckha "2 total commits to the home-assistant organization, 2 commits to home-assistant") +- [Jared J\. (@jjensn)](https://github.com/jjensn "1 total commits to the home-assistant organization, 1 commit to netdisco") - [Jason Carter (@JasonCarter80)](https://github.com/JasonCarter80 "7 total commits to the home-assistant organization, 4 commits to home-assistant, 3 commits to home-assistant.github.io") - [Jason Hite (@jasonmhite)](https://github.com/jasonmhite "6 total commits to the home-assistant organization, 6 commits to appdaemon") - [Javier González Calleja (@gonzalezcalleja)](https://github.com/gonzalezcalleja "2 total commits to the home-assistant organization, 2 commits to home-assistant") - [Jay Stevens (@Jay2645)](https://github.com/Jay2645 "3 total commits to the home-assistant organization, 3 commits to home-assistant.github.io") - [JAYMAN-ATX (@JAYMAN-ATX)](https://github.com/JAYMAN-ATX "2 total commits to the home-assistant organization, 2 commits to homebridge-homeassistant") +- [JC Connell (@jcconnell)](https://github.com/jcconnell "7 total commits to the home-assistant organization, 4 commits to home-assistant.github.io, 3 commits to home-assistant") - [Jean Regisser (@jeanregisser)](https://github.com/jeanregisser "2 total commits to the home-assistant organization, 2 commits to home-assistant") -- [Jean-Michel Julien (@KurdyMalloy)](https://github.com/KurdyMalloy "1 total commits to the home-assistant organization, 1 commit to libcoap") -- [Jean-Philippe Bouillot (@Jypy)](https://github.com/Jypy "2 total commits to the home-assistant organization, 2 commits to home-assistant") +- [Jean\-Michel Julien (@KurdyMalloy)](https://github.com/KurdyMalloy "1 total commits to the home-assistant organization, 1 commit to libcoap") +- [Jean\-Philippe Bouillot (@Jypy)](https://github.com/Jypy "2 total commits to the home-assistant organization, 2 commits to home-assistant") - [Jeff McGehee (@jlmcgehee21)](https://github.com/jlmcgehee21 "2 total commits to the home-assistant organization, 2 commits to home-assistant") - [Jeff Schroeder (@SEJeff)](https://github.com/SEJeff "17 total commits to the home-assistant organization, 17 commits to home-assistant") - [Jeff Wilson (@jawilson)](https://github.com/jawilson "24 total commits to the home-assistant organization, 19 commits to home-assistant, 5 commits to home-assistant.github.io") - [Jeffrey Lin (@linjef)](https://github.com/linjef "2 total commits to the home-assistant organization, 2 commits to home-assistant") - [Jens (@jhoepken)](https://github.com/jhoepken "3 total commits to the home-assistant organization, 3 commits to home-assistant.github.io") -- [Jens Østergaard Nielsen (@dingusdk)](https://github.com/dingusdk "3 total commits to the home-assistant organization, 3 commits to home-assistant.github.io") -- [Jerad Meisner (@jeradM)](https://github.com/jeradM "2 total commits to the home-assistant organization, 2 commits to home-assistant") +- [Jens Østergaard Nielsen (@dingusdk)](https://github.com/dingusdk "5 total commits to the home-assistant organization, 3 commits to home-assistant.github.io, 2 commits to home-assistant") +- [Jerad Meisner (@jeradM)](https://github.com/jeradM "6 total commits to the home-assistant organization, 6 commits to home-assistant") - [Jeremiah Wuenschel (@jer)](https://github.com/jer "3 total commits to the home-assistant organization, 3 commits to home-assistant.github.io") -- [Jeremy (@Wutname1)](https://github.com/Wutname1 "2 total commits to the home-assistant organization, 2 commits to home-assistant.github.io") - [Jeremy Williams (@jwillaz)](https://github.com/jwillaz "5 total commits to the home-assistant organization, 5 commits to home-assistant.github.io") - [jeremysv (@jeremysv)](https://github.com/jeremysv "3 total commits to the home-assistant organization, 3 commits to home-assistant.github.io") -- [Jeroen ter Heerdt (@jeroenterheerdt)](https://github.com/jeroenterheerdt "29 total commits to the home-assistant organization, 16 commits to home-assistant, 13 commits to home-assistant.github.io") +- [Jeroen ter Heerdt (@jeroenterheerdt)](https://github.com/jeroenterheerdt "36 total commits to the home-assistant organization, 20 commits to home-assistant, 16 commits to home-assistant.github.io") - [Jerold Albertson (@jeroldalbertson-wf)](https://github.com/jeroldalbertson-wf "5 total commits to the home-assistant organization, 5 commits to home-assistant.github.io") -- [Jerry Workman (@JerryWorkman)](https://github.com/JerryWorkman "4 total commits to the home-assistant organization, 4 commits to home-assistant.github.io") -- [Jesse Hills (@jesserockz)](https://github.com/jesserockz "3 total commits to the home-assistant organization, 3 commits to home-assistant") +- [Jerry Workman (@JerryWorkman)](https://github.com/JerryWorkman "8 total commits to the home-assistant organization, 8 commits to home-assistant.github.io") +- [Jesse Hills (@jesserockz)](https://github.com/jesserockz "9 total commits to the home-assistant organization, 9 commits to home-assistant") - [Jesse Newland (@jnewland)](https://github.com/jnewland "14 total commits to the home-assistant organization, 11 commits to home-assistant, 3 commits to hubot-home-assistant") - [JesseWebDotCom (@JesseWebDotCom)](https://github.com/JesseWebDotCom "16 total commits to the home-assistant organization, 8 commits to home-assistant, 8 commits to home-assistant.github.io") - [jgrieger1 (@jgrieger1)](https://github.com/jgrieger1 "1 total commits to the home-assistant organization, 1 commit to appdaemon") +- [jiafengwang (@jiafengwang)](https://github.com/jiafengwang "1 total commits to the home-assistant organization, 1 commit to appdaemon") - [jimbob1001 (@jimbob1001)](https://github.com/jimbob1001 "4 total commits to the home-assistant organization, 4 commits to home-assistant.github.io") - [Joakim Nohlgård (@gebart)](https://github.com/gebart "2 total commits to the home-assistant organization, 2 commits to libcoap") -- [Joakim Sørensen (@ludeeus)](https://github.com/ludeeus "43 total commits to the home-assistant organization, 30 commits to hassbian-scripts, 13 commits to home-assistant.github.io") +- [Joakim Sørensen (@ludeeus)](https://github.com/ludeeus "107 total commits to the home-assistant organization, 89 commits to hassbian-scripts, 18 commits to home-assistant.github.io") - [Job (@jmvermeulen)](https://github.com/jmvermeulen "2 total commits to the home-assistant organization, 2 commits to home-assistant") - [jodur (@jodur)](https://github.com/jodur "3 total commits to the home-assistant organization, 3 commits to home-assistant.github.io") -- [Joe Lu (@snjoetw)](https://github.com/snjoetw "16 total commits to the home-assistant organization, 12 commits to home-assistant, 4 commits to home-assistant.github.io") +- [Joe Lu (@snjoetw)](https://github.com/snjoetw "24 total commits to the home-assistant organization, 18 commits to home-assistant, 5 commits to home-assistant.github.io, 1 commit to appdaemon") - [Joe McMonagle (@joemcmonagle)](https://github.com/joemcmonagle "13 total commits to the home-assistant organization, 13 commits to home-assistant.github.io") - [joe248 (@joe248)](https://github.com/joe248 "3 total commits to the home-assistant organization, 3 commits to home-assistant") - [Joeboyc2 (@Joeboyc2)](https://github.com/Joeboyc2 "15 total commits to the home-assistant organization, 15 commits to home-assistant.github.io") - [Johan Bloemberg (@aequitas)](https://github.com/aequitas "43 total commits to the home-assistant organization, 35 commits to home-assistant, 7 commits to home-assistant.github.io, 1 commit to netdisco") - [Johan Haals (@jhaals)](https://github.com/jhaals "1 total commits to the home-assistant organization, 1 commit to appdaemon") - [Johan van der Kuijl (@Rubyan)](https://github.com/Rubyan "4 total commits to the home-assistant organization, 3 commits to home-assistant.github.io, 1 commit to appdaemon") -- [Johann Kellerman (@kellerza)](https://github.com/kellerza "144 total commits to the home-assistant organization, 114 commits to home-assistant, 30 commits to home-assistant.github.io") -- [Johannes K. (@roadrash2108)](https://github.com/roadrash2108 "4 total commits to the home-assistant organization, 4 commits to home-assistant.github.io") +- [Johann Kellerman (@kellerza)](https://github.com/kellerza "177 total commits to the home-assistant organization, 145 commits to home-assistant, 32 commits to home-assistant.github.io") +- [Johannes K\. (@roadrash2108)](https://github.com/roadrash2108 "4 total commits to the home-assistant organization, 4 commits to home-assistant.github.io") - [John (@J-C-B)](https://github.com/J-C-B "5 total commits to the home-assistant organization, 5 commits to home-assistant.github.io") -- [John Arild Berentsen (@turbokongen)](https://github.com/turbokongen "200 total commits to the home-assistant organization, 148 commits to home-assistant, 37 commits to home-assistant.github.io, 15 commits to home-assistant-polymer") +- [John Allen (@jra3)](https://github.com/jra3 "2 total commits to the home-assistant organization, 2 commits to home-assistant") +- [John Arild Berentsen (@turbokongen)](https://github.com/turbokongen "204 total commits to the home-assistant organization, 151 commits to home-assistant, 37 commits to home-assistant.github.io, 16 commits to home-assistant-polymer") - [John Lindley (@jwl17330536)](https://github.com/jwl17330536 "1 total commits to the home-assistant organization, 1 commit to appdaemon") - [John McLaughlin (@loghound)](https://github.com/loghound "2 total commits to the home-assistant organization, 2 commits to home-assistant") -- [John Mihalic (@mezz64)](https://github.com/mezz64 "46 total commits to the home-assistant organization, 32 commits to home-assistant, 12 commits to home-assistant.github.io, 1 commit to hadashboard, 1 commit to home-assistant-polymer") +- [John Mihalic (@mezz64)](https://github.com/mezz64 "50 total commits to the home-assistant organization, 36 commits to home-assistant, 12 commits to home-assistant.github.io, 1 commit to hadashboard, 1 commit to home-assistant-polymer") - [Johnny Chadda (@joch)](https://github.com/joch "1 total commits to the home-assistant organization, 1 commit to home-assistant-polymer") - [Jon (@JonMurphy)](https://github.com/JonMurphy "3 total commits to the home-assistant organization, 3 commits to home-assistant.github.io") - [Jon Caruana (@joncar)](https://github.com/joncar "3 total commits to the home-assistant organization, 3 commits to home-assistant") -- [Jon Griffith (@arretx)](https://github.com/arretx "11 total commits to the home-assistant organization, 10 commits to home-assistant.github.io, 1 commit to appdaemon") -- [Jon Maddox (@maddox)](https://github.com/maddox "103 total commits to the home-assistant organization, 79 commits to home-assistant, 16 commits to homebridge-homeassistant, 8 commits to home-assistant.github.io") +- [Jon Griffith (@arretx)](https://github.com/arretx "12 total commits to the home-assistant organization, 11 commits to home-assistant.github.io, 1 commit to appdaemon") +- [Jon Maddox (@maddox)](https://github.com/maddox "107 total commits to the home-assistant organization, 82 commits to home-assistant, 16 commits to homebridge-homeassistant, 9 commits to home-assistant.github.io") - [Jonas Pedersen (@JonasPed)](https://github.com/JonasPed "1 total commits to the home-assistant organization, 1 commit to appdaemon") - [Jonatan Castro (@jcastro)](https://github.com/jcastro "7 total commits to the home-assistant organization, 7 commits to home-assistant.github.io") - [Jonathan Baginski (@patchedsoul)](https://github.com/patchedsoul "115 total commits to the home-assistant organization, 87 commits to fabric-home-assistant, 28 commits to home-assistant.github.io") +- [Jonathan Weinberg (@jonathanweinberg)](https://github.com/jonathanweinberg "3 total commits to the home-assistant organization, 3 commits to home-assistant.github.io") - [joopert (@joopert)](https://github.com/joopert "6 total commits to the home-assistant organization, 6 commits to home-assistant") - [Jordi (@hokus15)](https://github.com/hokus15 "3 total commits to the home-assistant organization, 3 commits to home-assistant.github.io") - [Jordy (@jbarrancos)](https://github.com/jbarrancos "40 total commits to the home-assistant organization, 40 commits to home-assistant") @@ -467,39 +475,42 @@ This page contains a list of people who have contributed in one way or another t - [Joseph Carter (@iKarith)](https://github.com/iKarith "9 total commits to the home-assistant organization, 9 commits to pi-gen") - [Joseph Piron (@eagleamon)](https://github.com/eagleamon "3 total commits to the home-assistant organization, 3 commits to home-assistant") - [Josh (@karlw00t)](https://github.com/karlw00t "2 total commits to the home-assistant organization, 2 commits to home-assistant") -- [Josh Anderson (@andersonshatch)](https://github.com/andersonshatch "7 total commits to the home-assistant organization, 4 commits to home-assistant, 3 commits to homebridge-homeassistant") +- [Josh Anderson (@andersonshatch)](https://github.com/andersonshatch "8 total commits to the home-assistant organization, 5 commits to home-assistant, 3 commits to homebridge-homeassistant") - [Josh Nichols (@technicalpickles)](https://github.com/technicalpickles "28 total commits to the home-assistant organization, 15 commits to home-assistant, 13 commits to home-assistant.github.io") - [Josh Wright (@JshWright)](https://github.com/JshWright "28 total commits to the home-assistant organization, 20 commits to home-assistant, 8 commits to home-assistant.github.io") - [jpcomtois (@jpcomtois)](https://github.com/jpcomtois "1 total commits to the home-assistant organization, 1 commit to libcoap") - [JudgeDredd (@JudgeDreddKLC)](https://github.com/JudgeDreddKLC "10 total commits to the home-assistant organization, 10 commits to home-assistant.github.io") -- [Juggels (@Juggels)](https://github.com/Juggels "8 total commits to the home-assistant organization, 5 commits to home-assistant, 3 commits to home-assistant.github.io") +- [Juggels (@Juggels)](https://github.com/Juggels "11 total commits to the home-assistant organization, 7 commits to home-assistant, 4 commits to home-assistant.github.io") - [Julian Kaffke (@jaykay)](https://github.com/jaykay "1 total commits to the home-assistant organization, 1 commit to hassio-addons") - [Julian Kahnert (@JulianKahnert)](https://github.com/JulianKahnert "5 total commits to the home-assistant organization, 3 commits to home-assistant.github.io, 2 commits to home-assistant") -- [Julius Mittenzwei (@Julius2342)](https://github.com/Julius2342 "19 total commits to the home-assistant organization, 12 commits to home-assistant, 7 commits to home-assistant.github.io") +- [Julius Mittenzwei (@Julius2342)](https://github.com/Julius2342 "31 total commits to the home-assistant organization, 24 commits to home-assistant, 7 commits to home-assistant.github.io") - [jumpkick (@jumpkick)](https://github.com/jumpkick "15 total commits to the home-assistant organization, 12 commits to home-assistant, 3 commits to home-assistant.github.io") - [Justin Dray (@justin8)](https://github.com/justin8 "9 total commits to the home-assistant organization, 7 commits to home-assistant.github.io, 2 commits to home-assistant") -- [Justin Hayes (@GussyH)](https://github.com/GussyH "7 total commits to the home-assistant organization, 7 commits to hadashboard") +- [Justin Hayes (@GussyH)](https://github.com/GussyH "8 total commits to the home-assistant organization, 7 commits to hadashboard, 1 commit to appdaemon") - [Justin Weberg (@justweb1)](https://github.com/justweb1 "26 total commits to the home-assistant organization, 13 commits to home-assistant-polymer, 7 commits to hassbot, 4 commits to home-assistant, 1 commit to home-assistant-js, 1 commit to hassio") - [Justyn Shull (@justyns)](https://github.com/justyns "5 total commits to the home-assistant organization, 5 commits to home-assistant") -- [Kane610 (@Kane610)](https://github.com/Kane610 "23 total commits to the home-assistant organization, 12 commits to home-assistant, 9 commits to home-assistant.github.io, 1 commit to netdisco, 1 commit to home-assistant-polymer") - [Karen Goode (@kfgoode)](https://github.com/kfgoode "4 total commits to the home-assistant organization, 4 commits to home-assistant") -- [karlkar (@karlkar)](https://github.com/karlkar "5 total commits to the home-assistant organization, 5 commits to home-assistant") +- [karlkar (@karlkar)](https://github.com/karlkar "15 total commits to the home-assistant organization, 10 commits to home-assistant, 5 commits to home-assistant.github.io") - [Keaton Taylor (@keatontaylor)](https://github.com/keatontaylor "7 total commits to the home-assistant organization, 4 commits to home-assistant, 3 commits to home-assistant.github.io") - [Keith Lamprecht (@Nixon506E)](https://github.com/Nixon506E "2 total commits to the home-assistant organization, 2 commits to home-assistant") - [Ken Bannister (@kb2ma)](https://github.com/kb2ma "1 total commits to the home-assistant organization, 1 commit to libcoap") - [Ken Davidson (@kwdavidson)](https://github.com/kwdavidson "13 total commits to the home-assistant organization, 11 commits to home-assistant.github.io, 2 commits to appdaemon") -- [kennedyshead (@kennedyshead)](https://github.com/kennedyshead "8 total commits to the home-assistant organization, 8 commits to home-assistant") +- [kennedyshead (@kennedyshead)](https://github.com/kennedyshead "10 total commits to the home-assistant organization, 10 commits to home-assistant") - [Kenny Millington (@kmdm)](https://github.com/kmdm "2 total commits to the home-assistant organization, 2 commits to home-assistant") - [Kevin (@Mister-Espria)](https://github.com/Mister-Espria "2 total commits to the home-assistant organization, 2 commits to home-assistant") - [Kevin Fronczak (@fronzbot)](https://github.com/fronzbot "19 total commits to the home-assistant organization, 11 commits to home-assistant, 8 commits to home-assistant.github.io") - [Kevin Gisi (@gisikw)](https://github.com/gisikw "5 total commits to the home-assistant organization, 5 commits to home-assistant.github.io") - [Kevin Gottsman (@gottsman)](https://github.com/gottsman "6 total commits to the home-assistant organization, 6 commits to home-assistant.github.io") +- [Kevin Raddatz (@chronm)](https://github.com/chronm "2 total commits to the home-assistant organization, 2 commits to home-assistant") - [Kevin Siml (@appzer)](https://github.com/appzer "3 total commits to the home-assistant organization, 3 commits to home-assistant") - [Keyasha Brothern (@KMBrothern)](https://github.com/KMBrothern "4 total commits to the home-assistant organization, 4 commits to home-assistant.github.io") - [kfcook (@kfcook)](https://github.com/kfcook "3 total commits to the home-assistant organization, 3 commits to home-assistant") +- [Khole (@KJonline)](https://github.com/KJonline "2 total commits to the home-assistant organization, 2 commits to home-assistant") - [kireyeu (@kireyeu)](https://github.com/kireyeu "4 total commits to the home-assistant organization, 4 commits to home-assistant-notebooks") -- [Klaas Hoekema (@KlaasH)](https://github.com/KlaasH "12 total commits to the home-assistant organization, 5 commits to home-assistant, 5 commits to home-assistant.github.io, 2 commits to home-assistant-polymer") +- [Klaas Hoekema (@KlaasH)](https://github.com/KlaasH "12 total commits to the home-assistant organization, 5 commits to home-assistant.github.io, 5 commits to home-assistant, 2 commits to home-assistant-polymer") - [Klaus (@k-laus)](https://github.com/k-laus "1 total commits to the home-assistant organization, 1 commit to appdaemon") +- [koolsb (@koolsb)](https://github.com/koolsb "3 total commits to the home-assistant organization, 3 commits to home-assistant") +- [Kory Prince (@korylprince)](https://github.com/korylprince "4 total commits to the home-assistant organization, 4 commits to home-assistant-polymer") - [Krasimir Chariyski (@Chariyski)](https://github.com/Chariyski "4 total commits to the home-assistant organization, 4 commits to home-assistant.github.io") - [Krasimir Zhelev (@zhelev)](https://github.com/zhelev "1 total commits to the home-assistant organization, 1 commit to netdisco") - [kroimon (@kroimon)](https://github.com/kroimon "1 total commits to the home-assistant organization, 1 commit to netdisco") @@ -509,217 +520,225 @@ This page contains a list of people who have contributed in one way or another t - [lee-js (@lee-js)](https://github.com/lee-js "3 total commits to the home-assistant organization, 3 commits to home-assistant.github.io") - [Leon99 (@Leon99)](https://github.com/Leon99 "1 total commits to the home-assistant organization, 1 commit to appdaemon") - [Leonardo Saraiva (@vyper)](https://github.com/vyper "3 total commits to the home-assistant organization, 3 commits to home-assistant.github.io") -- [Lev Aronsky (@aronsky)](https://github.com/aronsky "11 total commits to the home-assistant organization, 8 commits to home-assistant, 3 commits to home-assistant.github.io") -- [Lewis Juggins (@lwis)](https://github.com/lwis "64 total commits to the home-assistant organization, 51 commits to home-assistant, 12 commits to home-assistant.github.io, 1 commit to home-assistant-polymer") +- [Lev Aronsky (@aronsky)](https://github.com/aronsky "14 total commits to the home-assistant organization, 11 commits to home-assistant, 3 commits to home-assistant.github.io") +- [Lewis Juggins (@lwis)](https://github.com/lwis "66 total commits to the home-assistant organization, 53 commits to home-assistant, 12 commits to home-assistant.github.io, 1 commit to home-assistant-polymer") - [lichtteil (@lichtteil)](https://github.com/lichtteil "3 total commits to the home-assistant organization, 3 commits to home-assistant.github.io") -- [Lindsay Ward (@lindsaymarkward)](https://github.com/lindsaymarkward "17 total commits to the home-assistant organization, 13 commits to home-assistant.github.io, 4 commits to home-assistant") +- [Lindsay Ward (@lindsaymarkward)](https://github.com/lindsaymarkward "18 total commits to the home-assistant organization, 13 commits to home-assistant.github.io, 5 commits to home-assistant") - [linuxlurak (@linuxlurak)](https://github.com/linuxlurak "5 total commits to the home-assistant organization, 3 commits to home-assistant.github.io, 2 commits to hadashboard") - [linvinus (@linvinus)](https://github.com/linvinus "1 total commits to the home-assistant organization, 1 commit to home-assistant-polymer") - [lrmate (@lrmate)](https://github.com/lrmate "3 total commits to the home-assistant organization, 3 commits to home-assistant") -- [Luar Roji (@cyberplant)](https://github.com/cyberplant "6 total commits to the home-assistant organization, 4 commits to home-assistant.github.io, 2 commits to home-assistant") -- [luca-angemi (@luca-angemi)](https://github.com/luca-angemi "1 total commits to the home-assistant organization, 1 commit to home-assistant-polymer") +- [Luar Roji (@cyberplant)](https://github.com/cyberplant "4 total commits to the home-assistant organization, 4 commits to home-assistant.github.io") +- [Luc Touraille (@stilllman)](https://github.com/stilllman "1 total commits to the home-assistant organization, 1 commit to netdisco") +- [Luca Angemi (@luca-angemi)](https://github.com/luca-angemi "1 total commits to the home-assistant organization, 1 commit to home-assistant-polymer") - [LucaSoldi (@LucaSoldi)](https://github.com/LucaSoldi "6 total commits to the home-assistant organization, 6 commits to home-assistant") - [Lucien Guimier (@guimier)](https://github.com/guimier "1 total commits to the home-assistant organization, 1 commit to libcoap") - [Ludovic (@ldvc)](https://github.com/ldvc "1 total commits to the home-assistant organization, 1 commit to home-assistant-polymer") - [Ludovico de Nittis (@RyuzakiKK)](https://github.com/RyuzakiKK "3 total commits to the home-assistant organization, 3 commits to home-assistant.github.io") - [Lukas (@lukas-hetzenecker)](https://github.com/lukas-hetzenecker "14 total commits to the home-assistant organization, 10 commits to home-assistant, 4 commits to home-assistant.github.io") -- [Lukas Barth (@tinloaf)](https://github.com/tinloaf "32 total commits to the home-assistant organization, 19 commits to home-assistant, 11 commits to home-assistant.github.io, 2 commits to home-assistant-polymer") +- [Lukas Barth (@tinloaf)](https://github.com/tinloaf "33 total commits to the home-assistant organization, 20 commits to home-assistant, 11 commits to home-assistant.github.io, 2 commits to home-assistant-polymer") - [Lukas Ecklmayr (@outrun0506)](https://github.com/outrun0506 "6 total commits to the home-assistant organization, 5 commits to home-assistant.github.io, 1 commit to home-assistant-polymer") - [Lukas Porubcan (@Luc3as)](https://github.com/Luc3as "1 total commits to the home-assistant organization, 1 commit to home-assistant-polymer") - [Luke Armstrong (@lukearmstrong)](https://github.com/lukearmstrong "3 total commits to the home-assistant organization, 3 commits to home-assistant.github.io") - [LvivEchoes (@LvivEchoes)](https://github.com/LvivEchoes "8 total commits to the home-assistant organization, 4 commits to home-assistant, 3 commits to home-assistant.github.io, 1 commit to home-assistant-polymer") - [Maarten Groeneweg (@lazytesting)](https://github.com/lazytesting "1 total commits to the home-assistant organization, 1 commit to hassio-addons") -- [Maciej Bieniek (@bieniu)](https://github.com/bieniu "4 total commits to the home-assistant organization, 3 commits to home-assistant, 1 commit to home-assistant-polymer") +- [Maciej Bieniek (@bieniu)](https://github.com/bieniu "5 total commits to the home-assistant organization, 4 commits to home-assistant, 1 commit to home-assistant-polymer") - [Maciej Sokołowski (@matemaciek)](https://github.com/matemaciek "5 total commits to the home-assistant organization, 4 commits to home-assistant, 1 commit to hassio-build") - [Maciej Wasilak (@mwasilak)](https://github.com/mwasilak "1 total commits to the home-assistant organization, 1 commit to libcoap") - [Magnus Ihse Bursie (@magicus)](https://github.com/magicus "16 total commits to the home-assistant organization, 9 commits to home-assistant, 4 commits to netdisco, 3 commits to home-assistant.github.io") - [Magnus Lyckå (@magnus-lycka)](https://github.com/magnus-lycka "1 total commits to the home-assistant organization, 1 commit to netdisco") - [MagnusKnutas (@MagnusKnutas)](https://github.com/MagnusKnutas "29 total commits to the home-assistant organization, 29 commits to home-assistant") -- [Mahasri Kalavala (@skalavala)](https://github.com/skalavala "20 total commits to the home-assistant organization, 20 commits to home-assistant.github.io") -- [Maikel Wever (@maikelwever)](https://github.com/maikelwever "2 total commits to the home-assistant organization, 2 commits to home-assistant") +- [Mahasri Kalavala (@skalavala)](https://github.com/skalavala "28 total commits to the home-assistant organization, 28 commits to home-assistant.github.io") +- [makemeasandwich (@makemeasandwich)](https://github.com/makemeasandwich "12 total commits to the home-assistant organization, 12 commits to home-assistant") - [Marc Egli (@frog32)](https://github.com/frog32 "11 total commits to the home-assistant organization, 8 commits to home-assistant, 3 commits to home-assistant.github.io") -- [Marc Forth (@mf-social)](https://github.com/mf-social "13 total commits to the home-assistant organization, 12 commits to home-assistant.github.io, 1 commit to fabric-home-assistant") +- [Marc Forth (@mf-social)](https://github.com/mf-social "25 total commits to the home-assistant organization, 24 commits to home-assistant.github.io, 1 commit to fabric-home-assistant") +- [Marc Khouri (@ubnt-marc-khouri)](https://github.com/ubnt-marc-khouri "3 total commits to the home-assistant organization, 2 commits to home-assistant-polymer, 1 commit to hassio-build") - [Marc Pabst (@mxtra)](https://github.com/mxtra "1 total commits to the home-assistant organization, 1 commit to home-assistant-polymer") -- [Marc Plano-Lesay (@Kernald)](https://github.com/Kernald "12 total commits to the home-assistant organization, 10 commits to home-assistant.github.io, 2 commits to home-assistant") +- [Marc Plano\-Lesay (@Kernald)](https://github.com/Kernald "10 total commits to the home-assistant organization, 10 commits to home-assistant.github.io") - [Marcel030nl (@Marcel030nl)](https://github.com/Marcel030nl "5 total commits to the home-assistant organization, 5 commits to home-assistant.github.io") -- [Marcelo Moreira de Mello (@tchellomello)](https://github.com/tchellomello "140 total commits to the home-assistant organization, 77 commits to home-assistant, 61 commits to home-assistant.github.io, 1 commit to home-assistant-assets, 1 commit to home-assistant-polymer") +- [Marcelo Moreira de Mello (@tchellomello)](https://github.com/tchellomello "141 total commits to the home-assistant organization, 77 commits to home-assistant, 62 commits to home-assistant.github.io, 1 commit to home-assistant-assets, 1 commit to home-assistant-polymer") +- [Marcin Domański (@kabturek)](https://github.com/kabturek "2 total commits to the home-assistant organization, 2 commits to appdaemon") - [Marcin Jaworski (@yawor)](https://github.com/yawor "12 total commits to the home-assistant organization, 12 commits to appdaemon") - [Marco (@marconett)](https://github.com/marconett "3 total commits to the home-assistant organization, 3 commits to appdaemon") -- [Marcus Schmidt (@mar-schmidt)](https://github.com/mar-schmidt "2 total commits to the home-assistant organization, 2 commits to home-assistant") +- [Marco Orovecchia (@Oro)](https://github.com/Oro "3 total commits to the home-assistant organization, 3 commits to home-assistant") - [Marijn Giesen (@marijngiesen)](https://github.com/marijngiesen "5 total commits to the home-assistant organization, 5 commits to hadashboard") -- [Marius (@ciotlosm)](https://github.com/ciotlosm "12 total commits to the home-assistant organization, 7 commits to home-assistant-polymer, 5 commits to home-assistant") -- [Mark Coombes (@marthoc)](https://github.com/marthoc "3 total commits to the home-assistant organization, 3 commits to home-assistant") +- [Marius (@ciotlosm)](https://github.com/ciotlosm "13 total commits to the home-assistant organization, 8 commits to home-assistant-polymer, 5 commits to home-assistant") +- [Mark Coombes (@marthoc)](https://github.com/marthoc "6 total commits to the home-assistant organization, 6 commits to home-assistant") - [Mark Grosen (@mgsb)](https://github.com/mgsb "1 total commits to the home-assistant organization, 1 commit to netdisco") - [Mark Huson (@mehuman)](https://github.com/mehuman "11 total commits to the home-assistant organization, 11 commits to home-assistant.github.io") +- [Mark Perdue (@markperdue)](https://github.com/markperdue "3 total commits to the home-assistant organization, 3 commits to home-assistant.github.io") +- [mark9white (@mark9white)](https://github.com/mark9white "1 total commits to the home-assistant organization, 1 commit to hassio") - [markferry (@markferry)](https://github.com/markferry "3 total commits to the home-assistant organization, 3 commits to home-assistant") -- [Markus (@iMarkus)](https://github.com/iMarkus "3 total commits to the home-assistant organization, 2 commits to home-assistant, 1 commit to hassio") +- [Markus (@iMarkus)](https://github.com/iMarkus "1 total commits to the home-assistant organization, 1 commit to hassio") - [Markus Becker (@markushx)](https://github.com/markushx "6 total commits to the home-assistant organization, 6 commits to libcoap") - [Markus Peter (@bimbar)](https://github.com/bimbar "3 total commits to the home-assistant organization, 3 commits to home-assistant") - [Markus Stenberg (@fingon)](https://github.com/fingon "6 total commits to the home-assistant organization, 6 commits to home-assistant") - [Martin Berg (@mbrrg)](https://github.com/mbrrg "7 total commits to the home-assistant organization, 4 commits to home-assistant, 3 commits to home-assistant.github.io") -- [Martin Donlon (@wickerwaka)](https://github.com/wickerwaka "2 total commits to the home-assistant organization, 2 commits to home-assistant") -- [Martin Eberhardt (@DarkFox)](https://github.com/DarkFox "4 total commits to the home-assistant organization, 4 commits to home-assistant.github.io") -- [Martin Hjelmare (@MartinHjelmare)](https://github.com/MartinHjelmare "143 total commits to the home-assistant organization, 114 commits to home-assistant, 29 commits to home-assistant.github.io") +- [Martin Eberhardt (@DarkFox)](https://github.com/DarkFox "5 total commits to the home-assistant organization, 5 commits to home-assistant.github.io") +- [Martin Hjelmare (@MartinHjelmare)](https://github.com/MartinHjelmare "154 total commits to the home-assistant organization, 125 commits to home-assistant, 29 commits to home-assistant.github.io") - [Martin Rowan (@shortbloke)](https://github.com/shortbloke "3 total commits to the home-assistant organization, 3 commits to home-assistant") -- [Martin Vacula (@MatoKafkac)](https://github.com/MatoKafkac "2 total commits to the home-assistant organization, 2 commits to home-assistant") - [Martin Weinelt (@mweinelt)](https://github.com/mweinelt "17 total commits to the home-assistant organization, 9 commits to home-assistant, 7 commits to home-assistant.github.io, 1 commit to home-assistant-polymer") - [Martokk (@martokk)](https://github.com/martokk "3 total commits to the home-assistant organization, 3 commits to home-assistant.github.io") -- [Mateusz Drab (@mateuszdrab)](https://github.com/mateuszdrab "2 total commits to the home-assistant organization, 2 commits to home-assistant") - [Mathew Peterson (@mathewpeterson)](https://github.com/mathewpeterson "1 total commits to the home-assistant organization, 1 commit to homebridge-homeassistant") -- [Matt N. (@mnoorenberghe)](https://github.com/mnoorenberghe "52 total commits to the home-assistant organization, 24 commits to home-assistant-iOS, 17 commits to home-assistant.github.io, 9 commits to home-assistant, 1 commit to homebridge-homeassistant, 1 commit to home-assistant-polymer") +- [Matt N\. (@mnoorenberghe)](https://github.com/mnoorenberghe "54 total commits to the home-assistant organization, 25 commits to home-assistant-iOS, 17 commits to home-assistant.github.io, 9 commits to home-assistant, 2 commits to home-assistant-polymer, 1 commit to homebridge-homeassistant") - [Matt Rogers (@rogersmj)](https://github.com/rogersmj "20 total commits to the home-assistant organization, 20 commits to hadashboard") -- [Matt Schmitt (@schmittx)](https://github.com/schmittx "37 total commits to the home-assistant organization, 23 commits to homebridge-homeassistant, 7 commits to home-assistant, 4 commits to home-assistant.github.io, 3 commits to home-assistant-polymer") -- [Matt White (@mw-white)](https://github.com/mw-white "10 total commits to the home-assistant organization, 5 commits to home-assistant, 5 commits to home-assistant.github.io") +- [Matt Schmitt (@schmittx)](https://github.com/schmittx "68 total commits to the home-assistant organization, 52 commits to homebridge-homeassistant, 9 commits to home-assistant, 4 commits to home-assistant.github.io, 3 commits to home-assistant-polymer") +- [Matt White (@mw-white)](https://github.com/mw-white "10 total commits to the home-assistant organization, 5 commits to home-assistant.github.io, 5 commits to home-assistant") - [Matteo Lampugnani (@t30)](https://github.com/t30 "7 total commits to the home-assistant organization, 7 commits to home-assistant.github.io") - [Matthew Bowen (@mgbowen)](https://github.com/mgbowen "3 total commits to the home-assistant organization, 3 commits to home-assistant.github.io") -- [Matthew Garrett (@mjg59)](https://github.com/mjg59 "10 total commits to the home-assistant organization, 7 commits to home-assistant, 3 commits to home-assistant.github.io") -- [Matthew Schick (@mattsch)](https://github.com/mattsch "2 total commits to the home-assistant organization, 2 commits to home-assistant") +- [Matthew Garrett (@mjg59)](https://github.com/mjg59 "20 total commits to the home-assistant organization, 13 commits to home-assistant, 7 commits to home-assistant.github.io") +- [Matthew Rollings (@stealthcopter)](https://github.com/stealthcopter "3 total commits to the home-assistant organization, 3 commits to home-assistant.github.io") - [Matthew Treinish (@mtreinish)](https://github.com/mtreinish "20 total commits to the home-assistant organization, 13 commits to home-assistant, 7 commits to home-assistant.github.io") - [Matthias Dötsch (@brainexe)](https://github.com/brainexe "1 total commits to the home-assistant organization, 1 commit to home-assistant-polymer") +- [Matthias Urlichs (@smurfix)](https://github.com/smurfix "3 total commits to the home-assistant organization, 3 commits to appdaemon") +- [Mattias Welponer (@mxworm)](https://github.com/mxworm "3 total commits to the home-assistant organization, 3 commits to home-assistant") - [mattie47 (@mattie47)](https://github.com/mattie47 "3 total commits to the home-assistant organization, 3 commits to home-assistant.github.io") -- [mauriciobonani (@mauriciobonani)](https://github.com/mauriciobonani "7 total commits to the home-assistant organization, 7 commits to home-assistant.github.io") +- [Max Prokhorov (@mcspr)](https://github.com/mcspr "1 total commits to the home-assistant organization, 1 commit to home-assistant-polymer") - [Max Rumpf (@Maxr1998)](https://github.com/Maxr1998 "3 total commits to the home-assistant organization, 3 commits to home-assistant.github.io") -- [maxlaverse (@maxlaverse)](https://github.com/maxlaverse "5 total commits to the home-assistant organization, 5 commits to home-assistant") +- [maxclaey (@maxclaey)](https://github.com/maxclaey "8 total commits to the home-assistant organization, 5 commits to home-assistant, 3 commits to home-assistant.github.io") +- [maxlaverse (@maxlaverse)](https://github.com/maxlaverse "6 total commits to the home-assistant organization, 6 commits to home-assistant") - [mboeru (@mboeru)](https://github.com/mboeru "1 total commits to the home-assistant organization, 1 commit to home-assistant-iOS") -- [Menno Blom (@b10m)](https://github.com/b10m "6 total commits to the home-assistant organization, 3 commits to home-assistant.github.io, 2 commits to home-assistant, 1 commit to netdisco") +- [mcfrojd (@mcfrojd)](https://github.com/mcfrojd "3 total commits to the home-assistant organization, 3 commits to home-assistant.github.io") +- [Menno Blom (@b10m)](https://github.com/b10m "4 total commits to the home-assistant organization, 3 commits to home-assistant.github.io, 1 commit to netdisco") - [mertenats (@mertenats)](https://github.com/mertenats "4 total commits to the home-assistant organization, 4 commits to home-assistant.github.io") - [Micha LaQua (@milaq)](https://github.com/milaq "3 total commits to the home-assistant organization, 3 commits to home-assistant") -- [Michael (@hartmms)](https://github.com/hartmms "6 total commits to the home-assistant organization, 4 commits to home-assistant.github.io, 2 commits to home-assistant") +- [Michael (@hartmms)](https://github.com/hartmms "4 total commits to the home-assistant organization, 4 commits to home-assistant.github.io") - [Michael Auchter (@auchter)](https://github.com/auchter "13 total commits to the home-assistant organization, 13 commits to home-assistant") -- [Michael Fester (@michaelfester)](https://github.com/michaelfester "5 total commits to the home-assistant organization, 3 commits to home-assistant.github.io, 2 commits to home-assistant") +- [Michael Fester (@michaelfester)](https://github.com/michaelfester "4 total commits to the home-assistant organization, 4 commits to home-assistant.github.io") - [Michael Furtak (@mfurtak)](https://github.com/mfurtak "5 total commits to the home-assistant organization, 5 commits to issue-bot") - [Michael Gilbert (@Zyell)](https://github.com/Zyell "8 total commits to the home-assistant organization, 8 commits to home-assistant") -- [Michael Heinemann (@heinemml)](https://github.com/heinemml "2 total commits to the home-assistant organization, 2 commits to home-assistant") -- [Michael Kutý (@michaelkuty)](https://github.com/michaelkuty "2 total commits to the home-assistant organization, 2 commits to home-assistant") +- [Michael Kutý (@michaelkuty)](https://github.com/michaelkuty "3 total commits to the home-assistant organization, 3 commits to home-assistant") - [Michael Luggen (@l00mi)](https://github.com/l00mi "4 total commits to the home-assistant organization, 4 commits to home-assistant.github.io") -- [Michael Prokop (@mika)](https://github.com/mika "2 total commits to the home-assistant organization, 2 commits to home-assistant") - [Michael Requeny (@requenym)](https://github.com/requenym "14 total commits to the home-assistant organization, 14 commits to home-assistant.github.io") - [Michael Shim (@shimeez)](https://github.com/shimeez "1 total commits to the home-assistant organization, 1 commit to fabric-home-assistant") -- [Michaël Arnauts (@michaelarnauts)](https://github.com/michaelarnauts "62 total commits to the home-assistant organization, 32 commits to home-assistant, 26 commits to home-assistant.github.io, 3 commits to home-assistant-polymer, 1 commit to netdisco") +- [Michaël Arnauts (@michaelarnauts)](https://github.com/michaelarnauts "64 total commits to the home-assistant organization, 33 commits to home-assistant, 27 commits to home-assistant.github.io, 3 commits to home-assistant-polymer, 1 commit to netdisco") - [Michel Settembrino (@Michel-Settembrino)](https://github.com/Michel-Settembrino "3 total commits to the home-assistant organization, 3 commits to home-assistant.github.io") - [micw (@micw)](https://github.com/micw "8 total commits to the home-assistant organization, 5 commits to home-assistant, 3 commits to home-assistant.github.io") +- [Mike (@mradziwo)](https://github.com/mradziwo "1 total commits to the home-assistant organization, 1 commit to appdaemon") - [Mike Christianson (@MikeChristianson)](https://github.com/MikeChristianson "6 total commits to the home-assistant organization, 6 commits to home-assistant") -- [Mike Megally (@cmsimike)](https://github.com/cmsimike "7 total commits to the home-assistant organization, 7 commits to home-assistant") +- [Mike Megally (@cmsimike)](https://github.com/cmsimike "14 total commits to the home-assistant organization, 9 commits to home-assistant, 5 commits to home-assistant.github.io") - [Mike Nestor (@mnestor)](https://github.com/mnestor "6 total commits to the home-assistant organization, 5 commits to home-assistant, 1 commit to home-assistant-polymer") -- [Mike Roberts (@m-roberts)](https://github.com/m-roberts "1 total commits to the home-assistant organization, 1 commit to pi-gen") +- [Mike O'Driscoll (@mikeodr)](https://github.com/mikeodr "8 total commits to the home-assistant organization, 5 commits to home-assistant.github.io, 3 commits to home-assistant") - [Mikkel Høgh (@mikl)](https://github.com/mikl "3 total commits to the home-assistant organization, 3 commits to home-assistant.github.io") -- [Milan V. (@milanvo)](https://github.com/milanvo "18 total commits to the home-assistant organization, 10 commits to home-assistant, 7 commits to home-assistant.github.io, 1 commit to home-assistant-polymer") +- [Milan V\. (@milanvo)](https://github.com/milanvo "18 total commits to the home-assistant organization, 10 commits to home-assistant, 7 commits to home-assistant.github.io, 1 commit to home-assistant-polymer") - [miniconfig (@miniconfig)](https://github.com/miniconfig "27 total commits to the home-assistant organization, 20 commits to home-assistant, 7 commits to home-assistant.github.io") - [Minims (@Minims)](https://github.com/Minims "3 total commits to the home-assistant organization, 3 commits to homebridge-homeassistant") -- [Mister Wil (@MisterWil)](https://github.com/MisterWil "17 total commits to the home-assistant organization, 11 commits to home-assistant, 6 commits to home-assistant.github.io") +- [Mister Wil (@MisterWil)](https://github.com/MisterWil "20 total commits to the home-assistant organization, 14 commits to home-assistant, 6 commits to home-assistant.github.io") - [Mitesh Patel (@gurumitts)](https://github.com/gurumitts "9 total commits to the home-assistant organization, 5 commits to home-assistant, 4 commits to home-assistant.github.io") -- [Mitko Masarliev (@masarliev)](https://github.com/masarliev "10 total commits to the home-assistant organization, 7 commits to home-assistant, 3 commits to home-assistant.github.io") -- [mjj4791 (@mjj4791)](https://github.com/mjj4791 "22 total commits to the home-assistant organization, 15 commits to home-assistant.github.io, 7 commits to home-assistant") +- [Mitko Masarliev (@masarliev)](https://github.com/masarliev "12 total commits to the home-assistant organization, 8 commits to home-assistant, 4 commits to home-assistant.github.io") +- [mjj4791 (@mjj4791)](https://github.com/mjj4791 "23 total commits to the home-assistant organization, 15 commits to home-assistant.github.io, 8 commits to home-assistant") - [mmmmmtasty (@mmmmmtasty)](https://github.com/mmmmmtasty "8 total commits to the home-assistant organization, 8 commits to appdaemon") - [Molodax (@Molodax)](https://github.com/Molodax "7 total commits to the home-assistant organization, 7 commits to home-assistant.github.io") -- [Moon Shot (@moonshot)](https://github.com/moonshot "2 total commits to the home-assistant organization, 2 commits to home-assistant") -- [moose51789 (@moose51789)](https://github.com/moose51789 "1 total commits to the home-assistant organization, 1 commit to home-assistant-polymer") - [moskovskiy82 (@moskovskiy82)](https://github.com/moskovskiy82 "6 total commits to the home-assistant organization, 6 commits to home-assistant.github.io") - [motir (@motir)](https://github.com/motir "1 total commits to the home-assistant organization, 1 commit to appdaemon") +- [mountainsandcode (@mountainsandcode)](https://github.com/mountainsandcode "3 total commits to the home-assistant organization, 3 commits to home-assistant.github.io") - [mukundv (@mukundv)](https://github.com/mukundv "3 total commits to the home-assistant organization, 3 commits to home-assistant.github.io") - [Mārtiņš Grunskis (@grunskis)](https://github.com/grunskis "1 total commits to the home-assistant organization, 1 commit to netdisco") -- [Nate (@BillyNate)](https://github.com/BillyNate "2 total commits to the home-assistant organization, 2 commits to home-assistant") +- [Nash Kaminski (@nkaminski)](https://github.com/nkaminski "1 total commits to the home-assistant organization, 1 commit to home-assistant-polymer") - [Nathan Flynn (@eperdeme)](https://github.com/eperdeme "1 total commits to the home-assistant organization, 1 commit to hassio-addons") -- [Nathan Henrie (@n8henrie)](https://github.com/n8henrie "19 total commits to the home-assistant organization, 9 commits to home-assistant, 6 commits to home-assistant.github.io, 2 commits to homebridge-homeassistant, 1 commit to appdaemon, 1 commit to home-assistant-polymer") -- [Neil Lathwood (@laf)](https://github.com/laf "5 total commits to the home-assistant organization, 3 commits to home-assistant.github.io, 2 commits to home-assistant") +- [Nathan Henrie (@n8henrie)](https://github.com/n8henrie "19 total commits to the home-assistant organization, 9 commits to home-assistant, 6 commits to home-assistant.github.io, 2 commits to homebridge-homeassistant, 1 commit to home-assistant-polymer, 1 commit to appdaemon") +- [Neil Lathwood (@laf)](https://github.com/laf "3 total commits to the home-assistant organization, 3 commits to home-assistant.github.io") - [Nelis Willers (@NelisW)](https://github.com/NelisW "1 total commits to the home-assistant organization, 1 commit to fabric-home-assistant") - [NeLLyMerC (@NeLLyMerC)](https://github.com/NeLLyMerC "5 total commits to the home-assistant organization, 5 commits to home-assistant.github.io") - [neonbunny (@neonbunny)](https://github.com/neonbunny "3 total commits to the home-assistant organization, 3 commits to home-assistant.github.io") -- [Nicholas Amadori (@namadori)](https://github.com/namadori "3 total commits to the home-assistant organization, 3 commits to home-assistant.github.io") +- [Nicholas Amadori (@namadori)](https://github.com/namadori "4 total commits to the home-assistant organization, 4 commits to home-assistant.github.io") - [Nicholas Griffin (@nicholasgriffintn)](https://github.com/nicholasgriffintn "6 total commits to the home-assistant organization, 6 commits to home-assistant.github.io") -- [Nicholas Sielicki (@sielicki)](https://github.com/sielicki "2 total commits to the home-assistant organization, 2 commits to home-assistant") -- [Nick (@quadportnick)](https://github.com/quadportnick "2 total commits to the home-assistant organization, 2 commits to home-assistant") - [Nick Touran (@partofthething)](https://github.com/partofthething "38 total commits to the home-assistant organization, 25 commits to home-assistant, 13 commits to home-assistant.github.io") -- [Nick Waring (@nickwaring)](https://github.com/nickwaring "2 total commits to the home-assistant organization, 2 commits to home-assistant") -- [Nicko van Someren (@nickovs)](https://github.com/nickovs "2 total commits to the home-assistant organization, 2 commits to home-assistant") +- [Nicko van Someren (@nickovs)](https://github.com/nickovs "3 total commits to the home-assistant organization, 3 commits to home-assistant") - [Nicolas Graziano (@ngraziano)](https://github.com/ngraziano "3 total commits to the home-assistant organization, 3 commits to home-assistant") - [Nicolas Martignoni (@martignoni)](https://github.com/martignoni "1 total commits to the home-assistant organization, 1 commit to pi-gen") +- [nielstron (@nielstron)](https://github.com/nielstron "2 total commits to the home-assistant organization, 2 commits to netdisco") - [Nigel Rook (@NigelRook)](https://github.com/NigelRook "1 total commits to the home-assistant organization, 1 commit to home-assistant-polymer") - [Niklas (@niklaswa)](https://github.com/niklaswa "4 total commits to the home-assistant organization, 4 commits to home-assistant.github.io") -- [Nikolas Beutler (@biacz)](https://github.com/biacz "2 total commits to the home-assistant organization, 2 commits to home-assistant") +- [Niklas Wagner (@Skaronator)](https://github.com/Skaronator "7 total commits to the home-assistant organization, 7 commits to home-assistant.github.io") - [Nolan Gilley (@nkgilley)](https://github.com/nkgilley "123 total commits to the home-assistant organization, 95 commits to home-assistant, 28 commits to home-assistant.github.io") - [nordlead2005 (@nordlead2005)](https://github.com/nordlead2005 "3 total commits to the home-assistant organization, 3 commits to home-assistant.github.io") - [NotoriousBDG (@notoriousbdg)](https://github.com/notoriousbdg "3 total commits to the home-assistant organization, 3 commits to hassio-addons") -- [NovapaX (@NovapaX)](https://github.com/NovapaX "9 total commits to the home-assistant organization, 4 commits to home-assistant-polymer, 4 commits to home-assistant, 1 commit to home-assistant-assets") +- [NovapaX (@NovapaX)](https://github.com/NovapaX "56 total commits to the home-assistant organization, 50 commits to home-assistant-polymer, 5 commits to home-assistant, 1 commit to home-assistant-assets") - [ntalekt (@ntalekt)](https://github.com/ntalekt "6 total commits to the home-assistant organization, 6 commits to home-assistant.github.io") - [Nuno Sousa (@nunofgs)](https://github.com/nunofgs "5 total commits to the home-assistant organization, 4 commits to home-assistant, 1 commit to homebridge-homeassistant") - [obgm (@obgm)](https://github.com/obgm "480 total commits to the home-assistant organization, 480 commits to libcoap") -- [OLD PROFILE! Go to /dennisreimann (@dbloete)](https://github.com/dbloete "5 total commits to the home-assistant organization, 5 commits to home-assistant.github.io") -- [Ole-Kenneth (@olekenneth)](https://github.com/olekenneth "1 total commits to the home-assistant organization, 1 commit to homebridge-homeassistant") +- [OLD PROFILE\! Go to /dennisreimann (@dbloete)](https://github.com/dbloete "5 total commits to the home-assistant organization, 5 commits to home-assistant.github.io") +- [Ole\-Kenneth (@olekenneth)](https://github.com/olekenneth "1 total commits to the home-assistant organization, 1 commit to homebridge-homeassistant") - [Oleksii Serdiuk (@leppa)](https://github.com/leppa "4 total commits to the home-assistant organization, 4 commits to home-assistant") - [Oliv3rDog (@Oliv3rDog)](https://github.com/Oliv3rDog "3 total commits to the home-assistant organization, 3 commits to home-assistant.github.io") -- [Oliver (@scarface-4711)](https://github.com/scarface-4711 "24 total commits to the home-assistant organization, 14 commits to home-assistant, 9 commits to home-assistant.github.io, 1 commit to netdisco") +- [Oliver (@scarface-4711)](https://github.com/scarface-4711 "27 total commits to the home-assistant organization, 17 commits to home-assistant, 9 commits to home-assistant.github.io, 1 commit to netdisco") - [Oliver van Porten (@mcdeck)](https://github.com/mcdeck "10 total commits to the home-assistant organization, 10 commits to home-assistant") - [Open Home Automation (@open-homeautomation)](https://github.com/open-homeautomation "41 total commits to the home-assistant organization, 29 commits to home-assistant, 12 commits to home-assistant.github.io") +- [Otto Winter (@OttoWinter)](https://github.com/OttoWinter "56 total commits to the home-assistant organization, 45 commits to home-assistant, 8 commits to home-assistant.github.io, 3 commits to home-assistant-polymer") - [oznu (@oznu)](https://github.com/oznu "1 total commits to the home-assistant organization, 1 commit to homebridge-homeassistant") - [Parker Moore (@parkr)](https://github.com/parkr "60 total commits to the home-assistant organization, 60 commits to home-assistant.github.io") - [pascal (@passie)](https://github.com/passie "4 total commits to the home-assistant organization, 3 commits to home-assistant, 1 commit to home-assistant-polymer") - [Pascal Bach (@bachp)](https://github.com/bachp "10 total commits to the home-assistant organization, 9 commits to home-assistant, 1 commit to netdisco") -- [Pascal Vizeli (@pvizeli)](https://github.com/pvizeli "2415 total commits to the home-assistant organization, 953 commits to hassio, 452 commits to home-assistant, 347 commits to hassio-build, 326 commits to hassio-addons, 307 commits to home-assistant.github.io, 16 commits to hassio-addons-example, 11 commits to hassio-cli, 1 commit to home-assistant-js-websocket, 1 commit to hassio-os, 1 commit to netdisco") +- [Pascal Vizeli (@pvizeli)](https://github.com/pvizeli "3005 total commits to the home-assistant organization, 1174 commits to hassio, 462 commits to home-assistant, 374 commits to hassio-build, 339 commits to hassio-addons, 318 commits to home-assistant.github.io, 307 commits to hassio-os, 16 commits to hassio-addons-example, 13 commits to hassio-cli, 1 commit to home-assistant-js-websocket, 1 commit to netdisco") - [Pat Thoyts (@patthoyts)](https://github.com/patthoyts "2 total commits to the home-assistant organization, 2 commits to netdisco") - [Patrick Aikens (@duckpuppy)](https://github.com/duckpuppy "3 total commits to the home-assistant organization, 3 commits to home-assistant.github.io") - [Patrick Easters (@patrickeasters)](https://github.com/patrickeasters "5 total commits to the home-assistant organization, 5 commits to home-assistant.github.io") - [Patrik (@ggravlingen)](https://github.com/ggravlingen "8 total commits to the home-assistant organization, 5 commits to home-assistant, 3 commits to home-assistant.github.io") - [Paul Annekov (@PaulAnnekov)](https://github.com/PaulAnnekov "4 total commits to the home-assistant organization, 4 commits to home-assistant") - [Paul Hendry (@pshendry)](https://github.com/pshendry "1 total commits to the home-assistant organization, 1 commit to warrant") +- [Paul Jimenez (@pjz)](https://github.com/pjz "3 total commits to the home-assistant organization, 3 commits to home-assistant.github.io") - [Paul Nicholls (@pauln)](https://github.com/pauln "2 total commits to the home-assistant organization, 2 commits to netdisco") - [Paul Sokolovsky (@pfalcon)](https://github.com/pfalcon "6 total commits to the home-assistant organization, 3 commits to netdisco, 3 commits to home-assistant") - [Pavel Ponomarev (@awsum)](https://github.com/awsum "2 total commits to the home-assistant organization, 2 commits to home-assistant-polymer") - [PawelWMS (@PawelWMS)](https://github.com/PawelWMS "12 total commits to the home-assistant organization, 12 commits to libcoap") - [Pedro Navarro (@pedronavf)](https://github.com/pedronavf "3 total commits to the home-assistant organization, 3 commits to home-assistant.github.io") - [Pedro Pombeiro (@PombeirP)](https://github.com/PombeirP "3 total commits to the home-assistant organization, 3 commits to home-assistant.github.io") -- [Per Osbäck (@perosb)](https://github.com/perosb "13 total commits to the home-assistant organization, 13 commits to home-assistant") +- [Per Osbäck (@perosb)](https://github.com/perosb "18 total commits to the home-assistant organization, 18 commits to home-assistant") - [Per Sandström (@persandstrom)](https://github.com/persandstrom "124 total commits to the home-assistant organization, 98 commits to home-assistant, 14 commits to home-assistant.github.io, 12 commits to home-assistant-polymer") - [Pete Peterson (@petey)](https://github.com/petey "1 total commits to the home-assistant organization, 1 commit to home-assistant-polymer") -- [PeteBa (@PeteBa)](https://github.com/PeteBa "7 total commits to the home-assistant organization, 5 commits to home-assistant, 2 commits to home-assistant-polymer") +- [PeteBa (@PeteBa)](https://github.com/PeteBa "8 total commits to the home-assistant organization, 5 commits to home-assistant, 3 commits to home-assistant-polymer") - [Peter Epley (@epleypa)](https://github.com/epleypa "6 total commits to the home-assistant organization, 6 commits to home-assistant.github.io") - [Petr Vraník (@konikvranik)](https://github.com/konikvranik "11 total commits to the home-assistant organization, 6 commits to home-assistant, 5 commits to home-assistant.github.io") - [pezinek (@pezinek)](https://github.com/pezinek "8 total commits to the home-assistant organization, 8 commits to home-assistant") - [Phil (@godloth)](https://github.com/godloth "10 total commits to the home-assistant organization, 10 commits to home-assistant.github.io") -- [Phil Cole (@filcole)](https://github.com/filcole "8 total commits to the home-assistant organization, 5 commits to home-assistant.github.io, 3 commits to home-assistant") +- [Phil Cole (@filcole)](https://github.com/filcole "9 total commits to the home-assistant organization, 6 commits to home-assistant.github.io, 3 commits to home-assistant") - [Phil Elson (@pelson)](https://github.com/pelson "3 total commits to the home-assistant organization, 3 commits to home-assistant") - [Phil Frost (@bitglue)](https://github.com/bitglue "8 total commits to the home-assistant organization, 8 commits to home-assistant") -- [Phil Haack (@Haacked)](https://github.com/Haacked "3 total commits to the home-assistant organization, 3 commits to home-assistant.github.io") - [Phil Hawthorne (@philhawthorne)](https://github.com/philhawthorne "24 total commits to the home-assistant organization, 18 commits to home-assistant.github.io, 6 commits to home-assistant") -- [Phil Kates (@philk)](https://github.com/philk "7 total commits to the home-assistant organization, 7 commits to home-assistant") +- [Phil Kates (@philk)](https://github.com/philk "11 total commits to the home-assistant organization, 8 commits to home-assistant, 3 commits to home-assistant.github.io") - [Philip Hofstetter (@pilif)](https://github.com/pilif "6 total commits to the home-assistant organization, 6 commits to home-assistant.github.io") +- [Philip Howard (@Gadgetoid)](https://github.com/Gadgetoid "1 total commits to the home-assistant organization, 1 commit to pi-gen") - [Philip Kleimeyer (@philklei)](https://github.com/philklei "4 total commits to the home-assistant organization, 4 commits to home-assistant") - [Philip Lundrigan (@philipbl)](https://github.com/philipbl "65 total commits to the home-assistant organization, 56 commits to home-assistant, 9 commits to home-assistant.github.io") +- [Philip Rosenberg\-Watt (@PhilRW)](https://github.com/PhilRW "10 total commits to the home-assistant organization, 7 commits to home-assistant, 3 commits to home-assistant.github.io") - [Philipp Hellmich (@runningman84)](https://github.com/runningman84 "4 total commits to the home-assistant organization, 4 commits to home-assistant.github.io") -- [Philipp Schmitt (@pschmitt)](https://github.com/pschmitt "37 total commits to the home-assistant organization, 24 commits to home-assistant, 11 commits to home-assistant.github.io, 1 commit to appdaemon, 1 commit to hassio-build") +- [Philipp Schmitt (@pschmitt)](https://github.com/pschmitt "38 total commits to the home-assistant organization, 25 commits to home-assistant, 11 commits to home-assistant.github.io, 1 commit to hassio-build, 1 commit to appdaemon") - [Phill Price (@phillprice)](https://github.com/phillprice "11 total commits to the home-assistant organization, 11 commits to home-assistant.github.io") -- [PhracturedBlue (@PhracturedBlue)](https://github.com/PhracturedBlue "25 total commits to the home-assistant organization, 15 commits to home-assistant, 9 commits to home-assistant.github.io, 1 commit to home-assistant-polymer") +- [PhracturedBlue (@PhracturedBlue)](https://github.com/PhracturedBlue "33 total commits to the home-assistant organization, 20 commits to home-assistant, 12 commits to home-assistant.github.io, 1 commit to home-assistant-polymer") - [Pierre Ståhl (@postlund)](https://github.com/postlund "49 total commits to the home-assistant organization, 32 commits to home-assistant, 11 commits to home-assistant.github.io, 4 commits to netdisco, 2 commits to home-assistant-polymer") - [Piratonym (@Piratonym)](https://github.com/Piratonym "2 total commits to the home-assistant organization, 2 commits to home-assistant") - [pkonnekermetametrics (@pkonnekermetametrics)](https://github.com/pkonnekermetametrics "5 total commits to the home-assistant organization, 5 commits to warrant") - [PuckStar (@PuckStar)](https://github.com/PuckStar "7 total commits to the home-assistant organization, 7 commits to home-assistant.github.io") -- [R Huish (@Genestealer)](https://github.com/Genestealer "22 total commits to the home-assistant organization, 22 commits to home-assistant.github.io") +- [R Huish (@Genestealer)](https://github.com/Genestealer "23 total commits to the home-assistant organization, 23 commits to home-assistant.github.io") - [Raiford (@raiford)](https://github.com/raiford "1 total commits to the home-assistant organization, 1 commit to hassio-addons") -- [Rasmus (@rasmusbe)](https://github.com/rasmusbe "2 total commits to the home-assistant organization, 2 commits to home-assistant") - [rbflurry (@rbflurry)](https://github.com/rbflurry "16 total commits to the home-assistant organization, 13 commits to home-assistant.github.io, 3 commits to home-assistant") -- [Reed Riley (@reedriley)](https://github.com/reedriley "2 total commits to the home-assistant organization, 2 commits to home-assistant") +- [Reed Riley (@reedriley)](https://github.com/reedriley "3 total commits to the home-assistant organization, 3 commits to home-assistant") - [Rendili (@Rendili)](https://github.com/Rendili "3 total commits to the home-assistant organization, 3 commits to home-assistant") -- [Rene Nulsch (@ReneNulschDE)](https://github.com/ReneNulschDE "14 total commits to the home-assistant organization, 9 commits to home-assistant, 5 commits to home-assistant.github.io") +- [Rene Nulsch (@ReneNulschDE)](https://github.com/ReneNulschDE "21 total commits to the home-assistant organization, 14 commits to home-assistant, 7 commits to home-assistant.github.io") - [Rene Tode (@ReneTode)](https://github.com/ReneTode "38 total commits to the home-assistant organization, 38 commits to appdaemon") -- [René Kliment (@renekliment)](https://github.com/renekliment "2 total commits to the home-assistant organization, 2 commits to home-assistant") - [Reza Moallemi (@moallemi)](https://github.com/moallemi "1 total commits to the home-assistant organization, 1 commit to home-assistant-polymer") - [rhooper (@rhooper)](https://github.com/rhooper "27 total commits to the home-assistant organization, 25 commits to home-assistant, 2 commits to hadashboard") - [Riccardo Canta (@commento)](https://github.com/commento "3 total commits to the home-assistant organization, 3 commits to home-assistant") - [Richard Arends (@Mosibi)](https://github.com/Mosibi "8 total commits to the home-assistant organization, 8 commits to home-assistant") - [Richard Cox (@Khabi)](https://github.com/Khabi "15 total commits to the home-assistant organization, 9 commits to home-assistant, 6 commits to home-assistant.github.io") -- [Richard Leurs (@R1chardTM)](https://github.com/R1chardTM "15 total commits to the home-assistant organization, 8 commits to home-assistant, 6 commits to home-assistant.github.io, 1 commit to home-assistant-polymer") +- [Richard Leurs (@R1chardTM)](https://github.com/R1chardTM "13 total commits to the home-assistant organization, 6 commits to home-assistant.github.io, 6 commits to home-assistant, 1 commit to home-assistant-polymer") +- [Richard Lucas (@lucasweb78)](https://github.com/lucasweb78 "9 total commits to the home-assistant organization, 9 commits to home-assistant") +- [Richard Niemand (@rniemand)](https://github.com/rniemand "1 total commits to the home-assistant organization, 1 commit to example-custom-config") - [Rick (@rcuddy)](https://github.com/rcuddy "1 total commits to the home-assistant organization, 1 commit to pi-gen") - [rkabadi (@rkabadi)](https://github.com/rkabadi "17 total commits to the home-assistant organization, 17 commits to home-assistant") - [Rob Capellini (@capellini)](https://github.com/capellini "3 total commits to the home-assistant organization, 3 commits to home-assistant") +- [Rob Cranfill (@RobCranfill)](https://github.com/RobCranfill "3 total commits to the home-assistant organization, 3 commits to home-assistant.github.io") - [Rob Slifka (@rslifka)](https://github.com/rslifka "5 total commits to the home-assistant organization, 5 commits to home-assistant.github.io") -- [Robbie Trencheny (@robbiet480)](https://github.com/robbiet480 "1315 total commits to the home-assistant organization, 646 commits to home-assistant-iOS, 259 commits to home-assistant, 248 commits to home-assistant.github.io, 91 commits to homebridge-homeassistant, 15 commits to home-assistant-polymer, 9 commits to hubot-home-assistant, 8 commits to Analytics-Receiver, 6 commits to netdisco, 3 commits to home-assistant-js-websocket, 3 commits to scenegen, 3 commits to appdaemon, 3 commits to hassbot, 3 commits to organization, 3 commits to hadashboard, 3 commits to home-assistant-js, 2 commits to LabelBot, 2 commits to micropython-home-assistant, 2 commits to fabric-home-assistant, 2 commits to home-assistant-notebooks, 2 commits to lambda-home-assistant-github, 2 commits to home-assistant-assets") -- [Robby Grossman (@freerobby)](https://github.com/freerobby "2 total commits to the home-assistant organization, 2 commits to home-assistant") -- [Robin (@robmarkcole)](https://github.com/robmarkcole "17 total commits to the home-assistant organization, 10 commits to home-assistant.github.io, 6 commits to home-assistant, 1 commit to home-assistant-assets") +- [Robbie Trencheny (@robbiet480)](https://github.com/robbiet480 "1317 total commits to the home-assistant organization, 646 commits to home-assistant-iOS, 259 commits to home-assistant, 249 commits to home-assistant.github.io, 92 commits to homebridge-homeassistant, 15 commits to home-assistant-polymer, 9 commits to hubot-home-assistant, 8 commits to Analytics-Receiver, 6 commits to netdisco, 3 commits to hassbot, 3 commits to appdaemon, 3 commits to scenegen, 3 commits to organization, 3 commits to home-assistant-js-websocket, 3 commits to hadashboard, 3 commits to home-assistant-js, 2 commits to LabelBot, 2 commits to lambda-home-assistant-github, 2 commits to fabric-home-assistant, 2 commits to home-assistant-notebooks, 2 commits to micropython-home-assistant, 2 commits to home-assistant-assets") +- [Robert (@metbril)](https://github.com/metbril "3 total commits to the home-assistant organization, 3 commits to home-assistant.github.io") +- [Robert Schütz (@dotlambda)](https://github.com/dotlambda "2 total commits to the home-assistant organization, 1 commit to netdisco, 1 commit to appdaemon") +- [Robert Svensson (@Kane610)](https://github.com/Kane610 "40 total commits to the home-assistant organization, 24 commits to home-assistant, 14 commits to home-assistant.github.io, 1 commit to home-assistant-polymer, 1 commit to netdisco") +- [Robin (@robmarkcole)](https://github.com/robmarkcole "42 total commits to the home-assistant organization, 27 commits to home-assistant.github.io, 14 commits to home-assistant, 1 commit to home-assistant-assets") - [Robin Laurén (@llauren)](https://github.com/llauren "1 total commits to the home-assistant organization, 1 commit to appdaemon") - [Roddie Hasan (@eiddor)](https://github.com/eiddor "6 total commits to the home-assistant organization, 6 commits to home-assistant.github.io") - [Roi Dayan (@roidayan)](https://github.com/roidayan "6 total commits to the home-assistant organization, 6 commits to home-assistant") - [roiff (@roiff)](https://github.com/roiff "1 total commits to the home-assistant organization, 1 commit to homebridge-homeassistant") -- [Ron Klinkien (@cyberjunky)](https://github.com/cyberjunky "5 total commits to the home-assistant organization, 3 commits to home-assistant.github.io, 2 commits to home-assistant") +- [Ron Klinkien (@cyberjunky)](https://github.com/cyberjunky "3 total commits to the home-assistant organization, 3 commits to home-assistant.github.io") - [Ron Miller (@brainyron)](https://github.com/brainyron "1 total commits to the home-assistant organization, 1 commit to hassio-addons") - [roqeer (@roqeer)](https://github.com/roqeer "3 total commits to the home-assistant organization, 3 commits to home-assistant") - [Ross Schulman (@rschulman)](https://github.com/rschulman "1 total commits to the home-assistant organization, 1 commit to pi-gen") @@ -728,32 +747,33 @@ This page contains a list of people who have contributed in one way or another t - [rubund (@rubund)](https://github.com/rubund "4 total commits to the home-assistant organization, 4 commits to home-assistant") - [Ruslan Kiyanchuk (@zoresvit)](https://github.com/zoresvit "1 total commits to the home-assistant organization, 1 commit to pi-gen") - [Russ K (@rkubes)](https://github.com/rkubes "2 total commits to the home-assistant organization, 2 commits to pi-gen") -- [Russell Cloran (@rcloran)](https://github.com/rcloran "23 total commits to the home-assistant organization, 19 commits to home-assistant, 4 commits to homebridge-homeassistant") +- [Russell Cloran (@rcloran)](https://github.com/rcloran "31 total commits to the home-assistant organization, 27 commits to home-assistant, 4 commits to homebridge-homeassistant") - [Ryan Bahm (@rdbahm)](https://github.com/rdbahm "3 total commits to the home-assistant organization, 3 commits to home-assistant.github.io") -- [Ryan Borstelmann (@SlothCroissant)](https://github.com/SlothCroissant "3 total commits to the home-assistant organization, 3 commits to home-assistant.github.io") - [Ryan Daigle (@rwdaigle)](https://github.com/rwdaigle "3 total commits to the home-assistant organization, 3 commits to home-assistant.github.io") +- [Ryan Jarvis (@Cabalist)](https://github.com/Cabalist "1 total commits to the home-assistant organization, 1 commit to hassbian-scripts") - [Ryan Kraus (@rmkraus)](https://github.com/rmkraus "193 total commits to the home-assistant organization, 163 commits to home-assistant, 15 commits to home-assistant.github.io, 14 commits to home-assistant-polymer, 1 commit to home-assistant-notebooks") -- [Ryan McLean (@ryanm101)](https://github.com/ryanm101 "69 total commits to the home-assistant organization, 57 commits to hassio-cli, 7 commits to home-assistant, 5 commits to home-assistant.github.io") +- [Ryan McLean (@ryanm101)](https://github.com/ryanm101 "96 total commits to the home-assistant organization, 74 commits to hassio-cli, 16 commits to home-assistant, 6 commits to home-assistant.github.io") - [Ryan Turner (@turnrye)](https://github.com/turnrye "6 total commits to the home-assistant organization, 6 commits to home-assistant") - [Sabesto (@Sabesto)](https://github.com/Sabesto "3 total commits to the home-assistant organization, 3 commits to home-assistant") -- [Sam Birch (@hotplot)](https://github.com/hotplot "2 total commits to the home-assistant organization, 2 commits to home-assistant") +- [Sacha Telgenhof (@stelgenhof)](https://github.com/stelgenhof "3 total commits to the home-assistant organization, 3 commits to home-assistant.github.io") - [Sam Holmes (@sam3d)](https://github.com/sam3d "4 total commits to the home-assistant organization, 4 commits to pi-gen") - [sam-io (@sam-io)](https://github.com/sam-io "3 total commits to the home-assistant organization, 3 commits to home-assistant") - [sander76 (@sander76)](https://github.com/sander76 "41 total commits to the home-assistant organization, 37 commits to home-assistant, 4 commits to home-assistant.github.io") -- [Scott Bradshaw (@swbradshaw)](https://github.com/swbradshaw "2 total commits to the home-assistant organization, 2 commits to home-assistant") +- [Scott Bradshaw (@swbradshaw)](https://github.com/swbradshaw "4 total commits to the home-assistant organization, 4 commits to home-assistant") - [Scott Griffin (@scottocs11)](https://github.com/scottocs11 "7 total commits to the home-assistant organization, 7 commits to home-assistant.github.io") - [Scott O'Neil (@americanwookie)](https://github.com/americanwookie "7 total commits to the home-assistant organization, 4 commits to home-assistant, 3 commits to home-assistant.github.io") - [Scott Reston (@ih8gates)](https://github.com/ih8gates "9 total commits to the home-assistant organization, 8 commits to home-assistant.github.io, 1 commit to home-assistant-polymer") -- [Sean Dague (@sdague)](https://github.com/sdague "73 total commits to the home-assistant organization, 50 commits to home-assistant, 14 commits to home-assistant.github.io, 5 commits to home-assistant-polymer, 3 commits to netdisco, 1 commit to home-assistant-js") +- [Sean Dague (@sdague)](https://github.com/sdague "75 total commits to the home-assistant organization, 52 commits to home-assistant, 14 commits to home-assistant.github.io, 5 commits to home-assistant-polymer, 3 commits to netdisco, 1 commit to home-assistant-js") - [Sean Gollschewsky (@gollo)](https://github.com/gollo "17 total commits to the home-assistant organization, 10 commits to home-assistant, 4 commits to home-assistant.github.io, 3 commits to hassio-build") -- [Sean Wilson (@swilson)](https://github.com/swilson "2 total commits to the home-assistant organization, 2 commits to home-assistant") -- [Sebastian (@sebk-666)](https://github.com/sebk-666 "3 total commits to the home-assistant organization, 3 commits to home-assistant.github.io") +- [Sean Wilson (@swilson)](https://github.com/swilson "5 total commits to the home-assistant organization, 4 commits to home-assistant, 1 commit to home-assistant-polymer") +- [Sebastian (@sebk-666)](https://github.com/sebk-666 "5 total commits to the home-assistant organization, 5 commits to home-assistant.github.io") - [Sebastian (@sgso)](https://github.com/sgso "3 total commits to the home-assistant organization, 3 commits to libcoap") -- [Sebastian Muszynski (@syssi)](https://github.com/syssi "51 total commits to the home-assistant organization, 26 commits to home-assistant, 23 commits to home-assistant.github.io, 2 commits to home-assistant-polymer") +- [Sebastian Muszynski (@syssi)](https://github.com/syssi "115 total commits to the home-assistant organization, 69 commits to home-assistant, 42 commits to home-assistant.github.io, 2 commits to home-assistant-polymer, 2 commits to netdisco") - [Sebastian von Minckwitz (@teodoc)](https://github.com/teodoc "1 total commits to the home-assistant organization, 1 commit to home-assistant-polymer") - [Semir Patel (@analogue)](https://github.com/analogue "2 total commits to the home-assistant organization, 2 commits to appdaemon") - [Sergey Isachenko (@zabuldon)](https://github.com/zabuldon "9 total commits to the home-assistant organization, 9 commits to home-assistant") - [Sergey Vishnikin (@armicron)](https://github.com/armicron "33 total commits to the home-assistant organization, 33 commits to warrant") +- [Sergio Viudes (@sjvc)](https://github.com/sjvc "3 total commits to the home-assistant organization, 3 commits to home-assistant") - [sfam (@sfam)](https://github.com/sfam "65 total commits to the home-assistant organization, 58 commits to home-assistant, 5 commits to home-assistant.github.io, 1 commit to netdisco, 1 commit to home-assistant-polymer") - [sharukins (@sharukins)](https://github.com/sharukins "3 total commits to the home-assistant organization, 3 commits to hassio-build") - [siebert (@siebert)](https://github.com/siebert "3 total commits to the home-assistant organization, 3 commits to home-assistant") @@ -762,60 +782,61 @@ This page contains a list of people who have contributed in one way or another t - [Sjors Spoorendonk (@sjorsjes)](https://github.com/sjorsjes "4 total commits to the home-assistant organization, 4 commits to home-assistant.github.io") - [sjoshi10 (@sjoshi10)](https://github.com/sjoshi10 "1 total commits to the home-assistant organization, 1 commit to warrant") - [snizzleorg (@snizzleorg)](https://github.com/snizzleorg "5 total commits to the home-assistant organization, 5 commits to hadashboard") -- [St. John Johnson (@stjohnjohnson)](https://github.com/stjohnjohnson "9 total commits to the home-assistant organization, 5 commits to home-assistant, 4 commits to home-assistant.github.io") +- [St\. John Johnson (@stjohnjohnson)](https://github.com/stjohnjohnson "9 total commits to the home-assistant organization, 5 commits to home-assistant, 4 commits to home-assistant.github.io") - [Stefan Jonasson (@stefan-jonasson)](https://github.com/stefan-jonasson "12 total commits to the home-assistant organization, 8 commits to home-assistant, 4 commits to home-assistant.github.io") - [Stefano Scipioni (@scipioni)](https://github.com/scipioni "3 total commits to the home-assistant organization, 3 commits to home-assistant") - [Steltek (@Steltek)](https://github.com/Steltek "1 total commits to the home-assistant organization, 1 commit to home-assistant-polymer") +- [stephanerosi (@stephanerosi)](https://github.com/stephanerosi "7 total commits to the home-assistant organization, 7 commits to home-assistant") - [Stephen Edgar (@ntwb)](https://github.com/ntwb "1 total commits to the home-assistant organization, 1 commit to fabric-home-assistant") -- [Stephen Hoekstra (@shoekstra)](https://github.com/shoekstra "2 total commits to the home-assistant organization, 2 commits to home-assistant") - [Stephen Yeargin (@stephenyeargin)](https://github.com/stephenyeargin "1 total commits to the home-assistant organization, 1 commit to home-assistant-polymer") -- [Steven Looman (@StevenLooman)](https://github.com/StevenLooman "2 total commits to the home-assistant organization, 2 commits to home-assistant") +- [Steve Easley (@SteveEasley)](https://github.com/SteveEasley "3 total commits to the home-assistant organization, 3 commits to home-assistant") - [Stu Gott (@stu-gott)](https://github.com/stu-gott "9 total commits to the home-assistant organization, 5 commits to home-assistant.github.io, 4 commits to home-assistant") -- [Stuart Mumford (@Cadair)](https://github.com/Cadair "2 total commits to the home-assistant organization, 2 commits to home-assistant") - [Stuart Williams (@stuwil)](https://github.com/stuwil "1 total commits to the home-assistant organization, 1 commit to netdisco") - [swanwila (@swanwila)](https://github.com/swanwila "1 total commits to the home-assistant organization, 1 commit to home-assistant-polymer") - [System Tester (@systemtester)](https://github.com/systemtester "3 total commits to the home-assistant organization, 3 commits to home-assistant.github.io") -- [Sytone (@sytone)](https://github.com/sytone "9 total commits to the home-assistant organization, 6 commits to home-assistant.github.io, 2 commits to home-assistant, 1 commit to hassio-build") -- [Sébastien RAMAGE (@doudz)](https://github.com/doudz "3 total commits to the home-assistant organization, 3 commits to home-assistant") +- [Sytone (@sytone)](https://github.com/sytone "7 total commits to the home-assistant organization, 6 commits to home-assistant.github.io, 1 commit to hassio-build") - [Sören Oldag (@soldag)](https://github.com/soldag "15 total commits to the home-assistant organization, 8 commits to home-assistant.github.io, 7 commits to home-assistant") +- [Tabakhase (@tabakhase)](https://github.com/tabakhase "1 total commits to the home-assistant organization, 1 commit to home-assistant-polymer") +- [tadly (@tadly)](https://github.com/tadly "4 total commits to the home-assistant organization, 4 commits to home-assistant") - [tango-foxtrot (@tango-foxtrot)](https://github.com/tango-foxtrot "1 total commits to the home-assistant organization, 1 commit to netdisco") - [Taylor Peet (@RePeet13)](https://github.com/RePeet13 "9 total commits to the home-assistant organization, 9 commits to home-assistant.github.io") - [Teagan Glenn (@Teagan42)](https://github.com/Teagan42 "59 total commits to the home-assistant organization, 49 commits to home-assistant, 9 commits to home-assistant.github.io, 1 commit to home-assistant-js") - [Ted Drain (@TD22057)](https://github.com/TD22057 "4 total commits to the home-assistant organization, 4 commits to home-assistant") - [tedstriker (@tedstriker)](https://github.com/tedstriker "3 total commits to the home-assistant organization, 3 commits to home-assistant.github.io") - [Teemu Mikkonen (@T3m3z)](https://github.com/T3m3z "3 total commits to the home-assistant organization, 3 commits to home-assistant") -- [Teemu Patja (@tpatja)](https://github.com/tpatja "2 total commits to the home-assistant organization, 2 commits to home-assistant") -- [Teemu R. (@rytilahti)](https://github.com/rytilahti "45 total commits to the home-assistant organization, 36 commits to home-assistant, 7 commits to home-assistant.github.io, 2 commits to netdisco") +- [Teemu R\. (@rytilahti)](https://github.com/rytilahti "53 total commits to the home-assistant organization, 40 commits to home-assistant, 9 commits to home-assistant.github.io, 4 commits to netdisco") - [Teguh Sobirin (@tjstyle)](https://github.com/tjstyle "2 total commits to the home-assistant organization, 2 commits to pi-gen") - [Tentoe (@Tentoe)](https://github.com/Tentoe "1 total commits to the home-assistant organization, 1 commit to home-assistant-polymer") - [Theb-1 (@Theb-1)](https://github.com/Theb-1 "5 total commits to the home-assistant organization, 5 commits to home-assistant") - [thecynic (@thecynic)](https://github.com/thecynic "4 total commits to the home-assistant organization, 4 commits to home-assistant") +- [TheFrogDaddy (@TheFrogDaddy)](https://github.com/TheFrogDaddy "1 total commits to the home-assistant organization, 1 commit to appdaemon") +- [themanieldaniel (@themanieldaniel)](https://github.com/themanieldaniel "8 total commits to the home-assistant organization, 8 commits to home-assistant.github.io") - [Theodor Lindquist (@theolind)](https://github.com/theolind "25 total commits to the home-assistant organization, 25 commits to home-assistant") -- [Thiago Oliveira (@chilicheech)](https://github.com/chilicheech "3 total commits to the home-assistant organization, 3 commits to home-assistant") -- [Thibault Cohen (@titilambert)](https://github.com/titilambert "44 total commits to the home-assistant organization, 31 commits to home-assistant, 13 commits to home-assistant.github.io") +- [Thiago Oliveira (@chilicheech)](https://github.com/chilicheech "4 total commits to the home-assistant organization, 4 commits to home-assistant") +- [Thibault Cohen (@titilambert)](https://github.com/titilambert "47 total commits to the home-assistant organization, 34 commits to home-assistant, 13 commits to home-assistant.github.io") - [Thibault Maekelbergh (@thibmaek)](https://github.com/thibmaek "4 total commits to the home-assistant organization, 3 commits to home-assistant.github.io, 1 commit to hassio-addons") -- [Thijs de Jong (@bakedraccoon)](https://github.com/bakedraccoon "9 total commits to the home-assistant organization, 9 commits to home-assistant") +- [Thijs de Jong (@bakedraccoon)](https://github.com/bakedraccoon "20 total commits to the home-assistant organization, 16 commits to home-assistant, 4 commits to home-assistant.github.io") - [ThinkPadNL (@ThinkPadNL)](https://github.com/ThinkPadNL "4 total commits to the home-assistant organization, 4 commits to home-assistant.github.io") -- [Thom Troy (@ttroy50)](https://github.com/ttroy50 "12 total commits to the home-assistant organization, 7 commits to home-assistant.github.io, 5 commits to home-assistant") -- [Thomas Friedel (@tfriedel)](https://github.com/tfriedel "2 total commits to the home-assistant organization, 2 commits to home-assistant") +- [Thom Troy (@ttroy50)](https://github.com/ttroy50 "13 total commits to the home-assistant organization, 7 commits to home-assistant.github.io, 6 commits to home-assistant") - [Thomas Petazzoni (@tpetazzoni)](https://github.com/tpetazzoni "1 total commits to the home-assistant organization, 1 commit to libcoap") - [Thomas Phillips (@thomas-phillips-nz)](https://github.com/thomas-phillips-nz "2 total commits to the home-assistant organization, 2 commits to pi-gen") - [Thomas Purchas (@thomaspurchas)](https://github.com/thomaspurchas "1 total commits to the home-assistant organization, 1 commit to homebridge-homeassistant") - [Thomas Pötsch (@thp-comnets)](https://github.com/thp-comnets "7 total commits to the home-assistant organization, 7 commits to libcoap") -- [thrawnarn (@thrawnarn)](https://github.com/thrawnarn "1 total commits to the home-assistant organization, 1 commit to netdisco") -- [ThUnD3r|Gr33n (@thundergreen)](https://github.com/thundergreen "4 total commits to the home-assistant organization, 4 commits to home-assistant.github.io") +- [thrawnarn (@thrawnarn)](https://github.com/thrawnarn "9 total commits to the home-assistant organization, 5 commits to home-assistant, 3 commits to home-assistant.github.io, 1 commit to netdisco") +- [ThUnD3r\|Gr33n (@thundergreen)](https://github.com/thundergreen "4 total commits to the home-assistant organization, 4 commits to home-assistant.github.io") - [tijuca (@tijuca)](https://github.com/tijuca "106 total commits to the home-assistant organization, 106 commits to libcoap") -- [Tim Lyakhovetskiy (@tlyakhov)](https://github.com/tlyakhov "2 total commits to the home-assistant organization, 2 commits to home-assistant") - [Tim Wilbrink (@TWilb)](https://github.com/TWilb "15 total commits to the home-assistant organization, 15 commits to home-assistant-iOS") +- [Timo (@timotk)](https://github.com/timotk "1 total commits to the home-assistant organization, 1 commit to netdisco") - [timstanley1985 (@timstanley1985)](https://github.com/timstanley1985 "4 total commits to the home-assistant organization, 4 commits to home-assistant.github.io") - [TJ Rana (@tjrana)](https://github.com/tjrana "1 total commits to the home-assistant organization, 1 commit to pi-gen") - [tleegaard (@tleegaard)](https://github.com/tleegaard "1 total commits to the home-assistant organization, 1 commit to home-assistant-polymer") - [Tobie Booth (@tobiebooth)](https://github.com/tobiebooth "4 total commits to the home-assistant organization, 3 commits to home-assistant, 1 commit to home-assistant-polymer") -- [Toby Gray (@tobygray)](https://github.com/tobygray "3 total commits to the home-assistant organization, 3 commits to home-assistant") -- [Tod Schmidt (@tschmidty69)](https://github.com/tschmidty69 "19 total commits to the home-assistant organization, 15 commits to home-assistant, 3 commits to home-assistant.github.io, 1 commit to hassio-addons") +- [Toby Gray (@tobygray)](https://github.com/tobygray "4 total commits to the home-assistant organization, 4 commits to home-assistant") +- [Tod Schmidt (@tschmidty69)](https://github.com/tschmidty69 "26 total commits to the home-assistant organization, 20 commits to home-assistant, 5 commits to home-assistant.github.io, 1 commit to hassio-addons") - [toddeye (@toddeye)](https://github.com/toddeye "20 total commits to the home-assistant organization, 20 commits to home-assistant") - [Tom Dickman (@tdickman)](https://github.com/tdickman "3 total commits to the home-assistant organization, 3 commits to home-assistant") - [Tom Duijf (@tomduijf)](https://github.com/tomduijf "70 total commits to the home-assistant organization, 53 commits to home-assistant, 9 commits to home-assistant.github.io, 6 commits to home-assistant-polymer, 2 commits to netdisco") +- [Tom Harris (@teharris1)](https://github.com/teharris1 "5 total commits to the home-assistant organization, 5 commits to home-assistant") - [Tom Hoover (@tomhoover)](https://github.com/tomhoover "3 total commits to the home-assistant organization, 3 commits to home-assistant.github.io") - [Tom Matheussen (@Tommatheussen)](https://github.com/Tommatheussen "13 total commits to the home-assistant organization, 6 commits to home-assistant, 4 commits to home-assistant-polymer, 3 commits to home-assistant.github.io") - [Tom Usher (@tomusher)](https://github.com/tomusher "1 total commits to the home-assistant organization, 1 commit to netdisco") @@ -824,6 +845,7 @@ This page contains a list of people who have contributed in one way or another t - [TopdRob (@TopdRob)](https://github.com/TopdRob "7 total commits to the home-assistant organization, 7 commits to home-assistant") - [Torkild Retvedt (@torkildr)](https://github.com/torkildr "2 total commits to the home-assistant organization, 2 commits to appdaemon") - [Toshik (@Toshik)](https://github.com/Toshik "1 total commits to the home-assistant organization, 1 commit to homebridge-homeassistant") +- [Touliloup (@RiRomain)](https://github.com/RiRomain "3 total commits to the home-assistant organization, 3 commits to home-assistant.github.io") - [tradiuz (@tradiuz)](https://github.com/tradiuz "5 total commits to the home-assistant organization, 5 commits to home-assistant.github.io") - [travislreno (@travislreno)](https://github.com/travislreno "3 total commits to the home-assistant organization, 3 commits to home-assistant.github.io") - [trbs (@trbs)](https://github.com/trbs "1 total commits to the home-assistant organization, 1 commit to netdisco") @@ -833,7 +855,7 @@ This page contains a list of people who have contributed in one way or another t - [Tsvi Mostovicz (@tsvi)](https://github.com/tsvi "9 total commits to the home-assistant organization, 5 commits to home-assistant.github.io, 4 commits to home-assistant") - [Tyler Page (@iamtpage)](https://github.com/iamtpage "3 total commits to the home-assistant organization, 3 commits to home-assistant.github.io") - [Tõnis Tobre (@tobre6)](https://github.com/tobre6 "1 total commits to the home-assistant organization, 1 commit to homebridge-homeassistant") -- [uchagani (@uchagani)](https://github.com/uchagani "5 total commits to the home-assistant organization, 4 commits to home-assistant, 1 commit to home-assistant-polymer") +- [uchagani (@uchagani)](https://github.com/uchagani "8 total commits to the home-assistant organization, 7 commits to home-assistant, 1 commit to home-assistant-polymer") - [Uli (@uehler)](https://github.com/uehler "5 total commits to the home-assistant organization, 5 commits to home-assistant.github.io") - [UnrealKazu (@UnrealKazu)](https://github.com/UnrealKazu "1 total commits to the home-assistant organization, 1 commit to home-assistant-polymer") - [upsert (@upsert)](https://github.com/upsert "1 total commits to the home-assistant organization, 1 commit to netdisco") @@ -842,7 +864,7 @@ This page contains a list of people who have contributed in one way or another t - [Victor Cerutti (@victorcerutti)](https://github.com/victorcerutti "3 total commits to the home-assistant organization, 3 commits to home-assistant-polymer") - [Viet Dzung (@dzungpv)](https://github.com/dzungpv "1 total commits to the home-assistant organization, 1 commit to home-assistant-polymer") - [Vignesh Venkat (@vickyg3)](https://github.com/vickyg3 "9 total commits to the home-assistant organization, 5 commits to home-assistant, 4 commits to home-assistant.github.io") -- [Ville Skyttä (@scop)](https://github.com/scop "22 total commits to the home-assistant organization, 14 commits to home-assistant, 4 commits to home-assistant.github.io, 3 commits to netdisco, 1 commit to hassio-build") +- [Ville Skyttä (@scop)](https://github.com/scop "40 total commits to the home-assistant organization, 19 commits to home-assistant, 10 commits to home-assistant.github.io, 4 commits to netdisco, 3 commits to hassio-addons, 2 commits to hassio-build, 2 commits to home-assistant-polymer") - [viswa-swami (@viswa-swami)](https://github.com/viswa-swami "9 total commits to the home-assistant organization, 9 commits to home-assistant") - [Vlad Korniev (@vkorn)](https://github.com/vkorn "1 total commits to the home-assistant organization, 1 commit to hassio-build") - [vllungu (@vllungu)](https://github.com/vllungu "3 total commits to the home-assistant organization, 3 commits to libcoap") @@ -851,16 +873,16 @@ This page contains a list of people who have contributed in one way or another t - [Wesley Young (@wesdyoung)](https://github.com/wesdyoung "1 total commits to the home-assistant organization, 1 commit to warrant") - [Wilco Land (@Wilco89)](https://github.com/Wilco89 "3 total commits to the home-assistant organization, 3 commits to home-assistant.github.io") - [Will Heid (@bassclarinetl2)](https://github.com/bassclarinetl2 "20 total commits to the home-assistant organization, 19 commits to home-assistant.github.io, 1 commit to fabric-home-assistant") -- [Will W. (@tiktok7)](https://github.com/tiktok7 "4 total commits to the home-assistant organization, 4 commits to home-assistant") +- [Will W\. (@tiktok7)](https://github.com/tiktok7 "4 total commits to the home-assistant organization, 4 commits to home-assistant") - [Willems Davy (@joyrider3774)](https://github.com/joyrider3774 "4 total commits to the home-assistant organization, 4 commits to home-assistant.github.io") - [William Johansson (@radhus)](https://github.com/radhus "1 total commits to the home-assistant organization, 1 commit to hassio") - [William Scanlon (@w1ll1am23)](https://github.com/w1ll1am23 "111 total commits to the home-assistant organization, 76 commits to home-assistant, 33 commits to home-assistant.github.io, 2 commits to netdisco") - [williamlehman (@williamlehman)](https://github.com/williamlehman "1 total commits to the home-assistant organization, 1 commit to home-assistant-polymer") - [wind-rider (@wind-rider)](https://github.com/wind-rider "5 total commits to the home-assistant organization, 5 commits to home-assistant") - [wokar (@wokar)](https://github.com/wokar "12 total commits to the home-assistant organization, 8 commits to home-assistant, 4 commits to home-assistant.github.io") -- [Wolf-Bastian Pöttner (@BastianPoe)](https://github.com/BastianPoe "7 total commits to the home-assistant organization, 4 commits to home-assistant, 3 commits to home-assistant.github.io") -- [Wolfgang Malgadey (@wmalgadey)](https://github.com/wmalgadey "4 total commits to the home-assistant organization, 4 commits to home-assistant") -- [XECDesign (@XECDesign)](https://github.com/XECDesign "133 total commits to the home-assistant organization, 133 commits to pi-gen") +- [Wolf\-Bastian Pöttner (@BastianPoe)](https://github.com/BastianPoe "7 total commits to the home-assistant organization, 4 commits to home-assistant, 3 commits to home-assistant.github.io") +- [Wolfgang Malgadey (@wmalgadey)](https://github.com/wmalgadey "5 total commits to the home-assistant organization, 5 commits to home-assistant") +- [XECDesign (@XECDesign)](https://github.com/XECDesign "138 total commits to the home-assistant organization, 138 commits to pi-gen") - [Xorso (@Xorso)](https://github.com/Xorso "22 total commits to the home-assistant organization, 21 commits to home-assistant, 1 commit to hassio-addons") - [Yannick POLLART (@ypollart)](https://github.com/ypollart "8 total commits to the home-assistant organization, 4 commits to home-assistant, 4 commits to home-assistant.github.io") - [Yasin Soliman (@yasinS)](https://github.com/yasinS "4 total commits to the home-assistant organization, 4 commits to home-assistant.github.io") @@ -869,9 +891,9 @@ This page contains a list of people who have contributed in one way or another t - [Zhao Lu (@zlu)](https://github.com/zlu "4 total commits to the home-assistant organization, 4 commits to home-assistant.github.io") - [Zio Tibia (@ziotibia81)](https://github.com/ziotibia81 "12 total commits to the home-assistant organization, 7 commits to home-assistant.github.io, 5 commits to home-assistant") - [Zorks (@Zorks)](https://github.com/Zorks "5 total commits to the home-assistant organization, 5 commits to home-assistant.github.io") -- [Åskar Andersson (@olskar)](https://github.com/olskar "6 total commits to the home-assistant organization, 5 commits to home-assistant.github.io, 1 commit to hassbian-scripts") +- [Åskar Andersson (@olskar)](https://github.com/olskar "9 total commits to the home-assistant organization, 5 commits to home-assistant.github.io, 3 commits to home-assistant, 1 commit to hassbian-scripts") This page is irregularly updated using the [`credits_generator` tool](https://github.com/home-assistant/home-assistant.github.io/tree/next/credits_generator). If you think that you are missing, please let us know. -This page was last updated Saturday, February 10th 2018, 4:03:45 pm UTC. +This page was last updated Sunday, April 29th 2018, 4:35:15 pm UTC. diff --git a/source/developers/development.markdown b/source/developers/development.markdown index f2f79b70c4..ea7c7bd480 100644 --- a/source/developers/development.markdown +++ b/source/developers/development.markdown @@ -9,23 +9,6 @@ sharing: true footer: true --- -Home Assistant is built from the ground up to be easily extensible using components. Home Assistant uses [Python 3](https://www.python.org/) for the backend and [Polymer (Web components)](https://www.polymer-project.org/) for the frontend. - -Home Assistant is open-source and MIT-licensed. Here are links to the source: - - - [home-assistant](https://github.com/home-assistant/home-assistant): Python server backend. - - [home-assistant-polymer](https://github.com/home-assistant/home-assistant-polymer): Polymer UI. - -For those new to contributing to open source software, make sure you are familiar with all of the tools and concepts used in Home Assistant before you start. - -When contributing Home Assistant code: - - [Github](https://guides.github.com/activities/hello-world/) - - [Pip and Virtual Environments](https://www.dabapps.com/blog/introduction-to-pip-and-virtualenv-python/) - - [Python 3](https://www.python.org/) - - [Pylint](https://www.pylint.org) - - [Flake8](http://flake8.pycqa.org/en/latest/) - - [Tox](http://tox.readthedocs.org/en/latest/) - - [TravisCl](https://travis-ci.org/) - -When contributing 3rd Party code to be used by Home Assistant: - - [Publishing your own PyPI package](https://jeffknupp.com/blog/2013/08/16/open-sourcing-a-python-project-the-right-way/) + \ No newline at end of file diff --git a/source/developers/development_101.markdown b/source/developers/development_101.markdown index 851888479f..7e4858e890 100644 --- a/source/developers/development_101.markdown +++ b/source/developers/development_101.markdown @@ -9,30 +9,6 @@ sharing: true footer: true --- -The goal of development 101 is to get you familiar with the basics of developing for Home Assistant. Before we start, please make sure you familiarize yourself with the [architecture]. - -To get our code running inside Home Assistant we're going to create a custom component. The first step is to locate your config folder. You can find the path to your config folder by opening the Home Assistant frontend, click on the service developer tool icon. It's the path after the text "Path to configuration.yaml". - -Inside your configuration directory create a new folder called `custom_components`. It might be that one already exists, that's fine too. This is the folder that Home Assistant will look at when looking for custom code. - -

    -The Home Assistant API has two variants: a synchronous and an asynchronous version (asyncio). This development course will focus on the synchronous version. -

    - -To verify that everything is working correctly, let's create a small Hello World component. To do so, create a file called `hello_world.py` in your custom components folder. Copy paste the following content to it: - -```python -# The domain of your component. Equal to the filename of your component. -DOMAIN = "hello_world" - - -def setup(hass, config): - """Setup the hello_world component.""" - # States are in the format DOMAIN.OBJECT_ID. - hass.states.set('hello_world.Hello_World', 'Works!') - - # Return boolean to indicate that initialization was successfully. - return True -``` - -[architecture]: /developers/architecture/ + \ No newline at end of file diff --git a/source/developers/development_catching_up.markdown b/source/developers/development_catching_up.markdown index 88f4b73e07..30d098ce99 100644 --- a/source/developers/development_catching_up.markdown +++ b/source/developers/development_catching_up.markdown @@ -9,33 +9,6 @@ sharing: true footer: true --- -If it's taking a while to develop your feature, and you want to catch up with what's in the current Home Assistant `dev` branch, you can use `git rebase`. This will pull the latest Home Assistant changes locally, rewind your commits, bring in the latest changes from Home Assistant, and replay all of your commits on top. - -```bash -# Run this from your feature branch -$ git fetch upstream dev # to pull the latest changes into a local dev branch -$ git rebase upstream/dev # to put those changes into your feature branch before your changes -``` - -If rebase detects conflicts, repeat this process until all changes have been resolved: - -1. `git status` shows you the file with the conflict; edit the file and resolve the lines between `<<<< | >>>>` -3. Add the modified file: `git add ` or `git add .` -4. Continue rebase: `git rebase --continue` -5. Repeat until you've resolved all conflicts - -After rebasing your branch, you will have rewritten history relative to your GitHub fork's branch. When you go to push you will see an error that your history has diverged from the original branch. In order to get your GitHub fork up-to-date with your local branch, you will need to force push, using the following command: - -```bash -# Run this from your feature branch -$ git push origin --force -``` - -Other workflows are covered in detail in the [Github documentation](https://help.github.com/articles/fork-a-repo/). Add an additional `remote` after you clone your fork. - -```bash -$ git remote add upstream https://github.com/home-assistant/home-assistant.git -``` - -Then, `git pull --rebase upstream dev`. - + \ No newline at end of file diff --git a/source/developers/development_checklist.markdown b/source/developers/development_checklist.markdown index 1a1fdb3def..7fb17c4368 100644 --- a/source/developers/development_checklist.markdown +++ b/source/developers/development_checklist.markdown @@ -9,12 +9,6 @@ sharing: true footer: true --- - -Before you commit any changes, check your work against these requirements: - -- All dependencies from [pypi](https://pypi.python.org/pypi) are included via the `REQUIREMENTS` variable in your platform or component and only imported inside functions that use them -- New dependencies are added to `requirements_all.txt` (if applicable), using `script/gen_requirements_all.py` -- The `.coveragerc` file is updated to exclude your platform if there are no tests available or your new code uses a third-party library for communication with the device, service, or sensor -- Documentation is developed for [home-assistant.io](https://home-assistant.io/) - * It's OK to start with adding a docstring with configuration details (for example, sample entry for `configuration.yaml` file) to the file header. Visit the [website documentation](/developers/documentation/) for more information about contributing to [home-assistant.io](https://github.com/home-assistant/home-assistant.github.io). - + \ No newline at end of file diff --git a/source/developers/development_config.markdown b/source/developers/development_config.markdown index 56382ecb61..5d89b5b2b5 100644 --- a/source/developers/development_config.markdown +++ b/source/developers/development_config.markdown @@ -9,27 +9,6 @@ sharing: true footer: true --- -Based on where you are in the code, `config` can mean various things. - -### {% linkable_title On the hass object %} - -On the hass object is an instance of the Config class. The Config class contains the users preferred units, the path to the config directory and which components are loaded. [See available methods.](https://dev-docs.home-assistant.io/en/master/api/core.html#homeassistant.core.Config) - -### {% linkable_title Config passed into component setup %} - -The `config` parameter passed to a component setup is a dictionary containing all of the user supplied configuration. The keys of the dictionary are the component names and the value is another dictionary with the component configuration. - -The object will have already been validated using your `CONFIG_SCHEMA` or `PLATFORM_SCHEMA` if available. If you have defined a `PLATFORM_SCHEMA`, all references to your component (ie `light 2:` etc) will have been changed to be accessible as a list under `config[DOMAIN]`. - -If your configuration file contains the following lines: - -```yaml -example: - host: paulusschoutsen.nl -``` - -Then in the setup method of your component you will be able to refer to `config['example']['host']` to get the value `paulusschoutsen.nl`. - -### {% linkable_title Passed into platform setup %} - -The `config` parameter passed to a platform setup function is only the config for that specific platform. + \ No newline at end of file diff --git a/source/developers/development_environment.markdown b/source/developers/development_environment.markdown index 46017c7f80..4671f6ec64 100644 --- a/source/developers/development_environment.markdown +++ b/source/developers/development_environment.markdown @@ -9,102 +9,6 @@ sharing: true footer: true --- -You'll need to set up a development environment if you want to develop a new feature or component for Home Assistant. Read on to learn how to set up. - -### {% linkable_title Preparing your environment %} - -#### {% linkable_title Developing on Linux %} - -Install the core dependencies. - -```bash -$ sudo apt-get install python3-pip python3-dev python3-venv -``` - -In order to run `script/setup` below you will need some more dependencies. - -```bash -$ sudo apt-get install libssl-dev libxml2-dev libxslt1-dev libjpeg-dev libffi-dev libudev-dev zlib1g-dev -``` - -

    -Different distributions have different package installation mechanisms and sometimes packages names as well. For example Centos would use: `sudo yum install epel-release && sudo yum install python34 python34-devel mysql-devel` -

    - -Additional dependencies exist if you plan to perform Frontend Development, please read the [Frontend](https://home-assistant.io/developers/frontend/) section to learn more. - -#### {% linkable_title Developing on Windows %} - -If you are using Windows as a development platform, make sure that you have the correct Microsoft [Visual C++ build tools](http://landinghub.visualstudio.com/visual-cpp-build-tools) installed. The installation of the most requirements and validation using `tox` will fail if this is not done correctly. Check the [Windows Compilers](https://wiki.python.org/moin/WindowsCompilers) section on the [Python website](https://www.python.org/) for details. - -Due to Home Assistant is mainly designed and developed on Linux distributions it is not recommended to develop on Windows machines. However on Windows 10 machines you should decide to set up a [Linux subsystem](https://docs.microsoft.com/de-de/windows/wsl/install-win10). - -Setup Linux subsystem. - -```bash -$ apt-get update -$ apt-get upgrade -$ echo 'export DISPLAY=:0' >> ~/.bashrc && . ~/.bashrc -$ sudo apt-get install xubuntu-desktop -y -``` - -It is recommended using [PyCharm](https://www.jetbrains.com/pycharm/download/) as debugger. Download and start PyCharm. - -```bash -$ wget https://download.jetbrains.com/python/pycharm-community-20XX.X.tar.gz -$ tar -xzf pycharm-community-20XX.X -$ ./pycharm.sh -``` - -In order to display the PyCharm GUI on Windows you need to run a X-Server like [VcXserv](https://sourceforge.net/projects/vcxsrv/). - -Also, make sure to install or upgrade the `setuptools` Python package. It contains compatibility improvements and adds automatic use of compilers: - -```bash -$ pip install --upgrade setuptools -``` - -#### {% linkable_title Developing on OS X %} - -Install [Homebrew](https://brew.sh/), then use that to install Python 3: - -```bash -$ brew install python3 -``` - -### {% linkable_title Setup Local Repository %} - -Visit the [Home Assistant repository](https://github.com/home-assistant/home-assistant) and click **Fork**. -Once forked, setup your local copy of the source using the commands: - -```bash -$ git clone https://github.com/YOUR_GIT_USERNAME/home-assistant.git -$ cd home-assistant -$ git remote add upstream https://github.com/home-assistant/home-assistant.git -``` - -### {% linkable_title Setting up virtual environment %} - -To isolate your environment from the rest of the system, set up a [`venv`](https://docs.python.org/3/library/venv.html). Within the `home-assistant` directory, create and activate your virtual environment. - -```bash -$ python3 -m venv . -$ source bin/activate -``` -Install the requirements with a provided script named `setup`. - -```bash -$ script/setup -``` - -Invoke your installation. - -```bash -$ hass -``` - -### {% linkable_title Logging %} - -By default logging in home-assistant is tuned for operating in production (set to INFO by default, with some modules set to even less verbose logging levels). - -You can use the [logger](/components/logger/) component to adjust logging to DEBUG to see even more details about what is going on. + \ No newline at end of file diff --git a/source/developers/development_events.markdown b/source/developers/development_events.markdown index e078396fd0..2552fb8e2f 100644 --- a/source/developers/development_events.markdown +++ b/source/developers/development_events.markdown @@ -9,54 +9,6 @@ sharing: true footer: true --- -The core of Home Assistant is driven by events. That means that if you want to respond to something happening, you'll have to respond to events. Most of the times you won't interact directly with the event system but use one of the [event listener helpers][helpers]. - -The event system is very flexible. There are no limitations on the event type, as long as it's a string. Each event can contain data. The data is a dictionary that can contain any data as long as it's JSON serializable. This means that you can use number, string, dictionary and list. - -[List of events that Home Assistant fires.][object] - -### {% linkable_title Firing events %} - -To fire an event, you have to interact with the event bus. The event bus is available on the Home Assistant instance as `hass.bus`. - -Example component that will fire an event when loaded. - -```python -DOMAIN = 'hello_event' - -def setup(hass, config): - """Set up is called when Home Assistant is loading our component.""" - - # Fire event my_cool_event with event data answer=42 - hass.bus.fire('my_cool_event', { - 'answer': 42 - }) -``` - -### {% linkable_title Listening to events %} - -Most of the times you'll not be firing events but instead listen to events. For example, the state change of an entity is broadcasted as an event. - -```python -DOMAIN = 'hello_event' - -def setup(hass, config): - """Set up is called when Home Assistant is loading our component.""" - count = 0 - - # Listener to handle fired events - def handle_event(event): - nonlocal count - count += 1 - print('Total events received:', count) - - # Listen for when my_cool_event is fired - hass.bus.listen('my_cool_event', handle_event) -``` - -#### {% linkable_title Helpers %} - -Home Assistant comes with a lot of bundled helpers to listen to specific types of event. There are helpers to track a point in time, to track a time interval, a state change or the sun set. [See available methods.][helpers] - -[helpers]: https://dev-docs.home-assistant.io/en/master/api/helpers.html#module-homeassistant.helpers.event -[object]: /docs/configuration/events/ + \ No newline at end of file diff --git a/source/developers/development_guidelines.markdown b/source/developers/development_guidelines.markdown index c8b384eb3e..e368c75a1e 100644 --- a/source/developers/development_guidelines.markdown +++ b/source/developers/development_guidelines.markdown @@ -9,73 +9,6 @@ sharing: true footer: true --- -Home Assistant enforces strict [PEP8 style](https://www.python.org/dev/peps/pep-0008/) and [PEP 257 (Docstring Conventions)](https://www.python.org/dev/peps/pep-0257/) compliance on all code submitted. We automatically test every pull request as part of the linting process with [Coveralls](https://coveralls.io/github/home-assistant/home-assistant) and [Travis CI](https://travis-ci.org/home-assistant/home-assistant). - -Summary of the most relevant points: - -- Line length is limited to 79 characters (see below). -- Use 4 spaces per indentation level. We don't use tabs. -- Comments should be full sentences and end with a period. -- [Imports](https://www.python.org/dev/peps/pep-0008/#imports) should be ordered. -- Constants and the content of lists and dictionaries should be in alphabetical order. -- Avoid trailing whitespace but surround binary operators with a single space. -- Line separator should be set to `LF`. - -The maximum line length comes directly from the [PEP8 style guide](https://www.python.org/dev/peps/pep-0008/#maximum-line-length), and is also used by the Python standard library. All code must pass these linting checks, and no exceptions will be made. There have already been numerous requests to increase the maximum line length, but after evaluating the options, the Home Assistant maintainers have decided to stay at 79 characters. This decision is final. - -Those points may require that you adjust your IDE or editor settings. - -## {% linkable_title Our recommendations %} - -For some cases [PEPs](https://www.python.org/dev/peps/) don't make a statement. This section covers our recommendations about the code style. Those points were collected from the existing code and based on what contributors and developers were using the most. This is basically a majority decision, thus you may not agree with it. But we would like to encourage you follow those recommendations to keep the code unified. - -### {% linkable_title Quotes %} - -Use single quotes `'` for single word and `"` for multiple words or sentences. - -```python -ATTR_WATERLEVEL = 'level' -CONF_ATTRIBUTION = "Data provided by the WUnderground weather service" -SENSOR_TYPES = { - 'alerts': ['Alerts', None], -} -``` - -### {% linkable_title File headers %} - -The docstring in the file header should contain a link to the documentation to make it easy to find further information, especially about the configuration or details which are not mentioned in the code. - -```python -""" -Support for MQTT lights. - -For more details about this platform, please refer to the documentation at -https://home-assistant.io/components/light.mqtt/ -""" -``` - -### {% linkable_title Requirements %} - -Please place [Platform requirements](/developers/code_review_platform/#1-requirements) right after the imports. - -```python -[...] -from homeassistant.helpers.entity import Entity - -REQUIREMENTS = ['xmltodict==0.11.0'] -``` - -### {% linkable_title Log messages %} - -There is no need to add the platform or component name to the log messages. This will be added automatically. Like `syslog` messages there shouldn't be any period at the end. Try to avoid brackets and additional quotes around the output to make it easier for users to parse the log. A widely style is shown below but you are free to compose the messages as you like. - -```python -_LOGGER.error("No route to device: %s", self._resource) -``` - -```bash -2017-05-01 14:28:07 ERROR [homeassistant.components.sensor.arest] No route to device: 192.168.0.18 -``` - -Don't print out wrong API keys, tokens, usernames, or passwords. - + \ No newline at end of file diff --git a/source/developers/development_hass_object.markdown b/source/developers/development_hass_object.markdown index d4a5926d2e..e4554ecf7b 100644 --- a/source/developers/development_hass_object.markdown +++ b/source/developers/development_hass_object.markdown @@ -10,29 +10,6 @@ footer: true redirect_from: /developers/component_initialization/ --- -While developing Home Assistant you will see a variable that is everywhere: `hass`. This is the Home Assistant instance that will give you access to all the various parts of the system. - -### {% linkable_title The `hass` object %} - -The Home Assistant instance contains four objects to help you interact with the system. - -| Object | Description | -| ------ | ----------- | -| `hass` | This is the instance of Home Assistant. Allows starting, stopping and enqueing new jobs. [See available methods.](https://dev-docs.home-assistant.io/en/master/api/core.html#homeassistant.core.HomeAssistant) -| `hass.config` | This is the core configuration of Home Assistant exposing location, temperature preferences and config directory path. [See available methods.](https://dev-docs.home-assistant.io/en/master/api/core.html#homeassistant.core.Config) -| `hass.states` | This is the StateMachine. It allows you to set states and track when they are changed. [See available methods.](https://dev-docs.home-assistant.io/en/master/api/core.html#homeassistant.core.StateMachine). | -| `hass.bus` | This is the EventBus. It allows you to trigger and listen for events. [See available methods.](https://dev-docs.home-assistant.io/en/master/api/core.html#homeassistant.core.EventBus). | -| `hass.services` | This is the ServiceRegistry. It allows you to register services. [See available methods.](https://dev-docs.home-assistant.io/en/master/api/core.html#homeassistant.core.ServiceRegistry). | - -### {% linkable_title Where to find `hass` %} - -Depending on what you're writing, there are different ways the `hass` object is made available. - -**Component**
    -Passed into `setup(hass, config)` or `async_setup(hass, config)`. - -**Platform**
    -Passed into `setup_platform(hass, config, add_devices, discovery_info=None)` or `async_setup_platform(hass, config, async_add_devices, discovery_info=None)`. - -**Entity**
    -Available as `self.hass` once the entity has been added via the `add_devices` callback inside a platform. + \ No newline at end of file diff --git a/source/developers/development_services.markdown b/source/developers/development_services.markdown index 1aa11397ed..6d5c203374 100644 --- a/source/developers/development_services.markdown +++ b/source/developers/development_services.markdown @@ -9,47 +9,6 @@ sharing: true footer: true --- -This is a simple "hello world" example to show the basics of registering a service. To use this example, create the file `/custom_components/hello_service.py` and copy the below example code. - -Services can be called from automation and from the service "Developer tools" in the frontend. - -```python -# The domain of your component. Should be equal to the name of your component. -DOMAIN = 'hello_service' - -ATTR_NAME = 'name' -DEFAULT_NAME = 'World' - - -def setup(hass, config): - """Set up is called when Home Assistant is loading our component.""" - - def handle_hello(call): - name = call.data.get(ATTR_NAME, DEFAULT_NAME) - - hass.states.set('hello_service.hello', name) - - hass.services.register(DOMAIN, 'hello', handle_hello) - - # Return boolean to indicate that initialization was successfully. - return True -``` - -Load the component by adding the following to your `configuration.yaml`. When your component is loaded, a new service should be available to call. - -```yaml -# configuration.yaml entry -hello_service: -``` - -Open the frontend and in the sidebar, click the first icon in the developer tool section. This will open the Call Service developer tool. On the right, find your service and click on it. This will automatically fill in the correct values. - -Pressing "Call Service" will now call your service without any parameters. This will cause your service to create a state with the default name 'World'. If you want to specify the name, you have to specify parameters. Add the following JSON as Service Data and press "Call Service again". - -```json -{ - "name": "Planet" -} -``` - -The service will now overwrite the previous state with "Planet". + \ No newline at end of file diff --git a/source/developers/development_states.markdown b/source/developers/development_states.markdown index 6da9e5fbc9..cf3db78b4d 100644 --- a/source/developers/development_states.markdown +++ b/source/developers/development_states.markdown @@ -9,132 +9,6 @@ sharing: true footer: true --- -Home Assistant keeps track of the states of entities in a state machine. The state machine has very few requirements: - - - Each state is related to an entity identified by an entity id. This id is made up of a domain and an object id. For example `light.kitchen_ceiling`. You can make up any combination of domain and object id, even overwriting existing states. - - Each state has a primary attribute that describes the state of the entity. In the case of a light this could be for example "on" and "off". You can store anything you want in the state, as long as it's a string (will be converted if it's not). - - You can store more information about an entity by setting attributes. Attributes is a dictionary that can contain any data that you want. The only requirement is that it's JSON serializable, so you're limited to numbers, strings, dictionaries and lists. - -[Description of the state object.](/docs/configuration/state_object/) - -### {% linkable_title Using states in your component %} - -This is a simple tutorial/example on how to create and set states. We will do our work in a component called "hello_state". The purpose of this component is to display a given text in the frontend. - -To get started, create the file `/custom_components/hello_state.py` and copy the below example code. - -```python -""" -Support for showing text in the frontend. - -For more details about this component, please refer to the documentation at -https://home-assistant.io/cookbook/python_component_basic_state/ -""" -import logging - -_LOGGER = logging.getLogger(__name__) - -DOMAIN = 'hello_state' -DEPENDENCIES = [] - -def setup(hass, config): - """Setup the Hello State component. """ - _LOGGER.info("The 'hello state' component is ready!") - - return True -``` - -1. In the file header we decided to add some details: A short description and the link to the documentation. -2. We want to do some logging. This means that we import the Python logging module and create an alias. -3. The component name is equal to the domain name. -4. At the moment this component has no dependencies. For detail check [dependencies](/developers/component_deps_and_reqs/#dependencies) section. -5. The `setup` function will take care of the initialization of our component. - The component will only write a log message. Keep in mind for later that you have several options for the severity: - - - `_LOGGER.info(msg)` - - `_LOGGER.warning(msg)` - - `_LOGGER.error(msg)` - - `_LOGGER.critical(msg)` - - `_LOGGER.exception(msg)` - -7. We return `True` if everything is ok. - -Add the component to your `configuration.yaml` file. - -```yaml -hello_state: -``` - -After a start or a restart of Home Assistant the component will create an entry in the log. - -```bash -16-03-12 14:16:42 INFO (MainThread) [custom_components.hello_state] The 'hello state' component is ready! -``` - -The next step is the introduction of configuration options. A user can pass configuration options to our component via `configuration.yaml`. To use them we'll use the passed in `config` variable to our `setup` method. - -```python -import logging - -_LOGGER = logging.getLogger(__name__) - -DOMAIN = 'hello_state' -DEPENDENCIES = [] - -CONF_TEXT = 'text' -DEFAULT_TEXT = 'No text!' - -def setup(hass, config): - """Set up the Hello State component. """ - # Get the text from the configuration. Use DEFAULT_TEXT if no name is provided. - text = config[DOMAIN].get(CONF_TEXT, DEFAULT_TEXT) - - # States are in the format DOMAIN.OBJECT_ID - hass.states.set('hello_state.Hello_State', text) - - return True -``` - -To use the latest feature of our component, update the entry in your `configuration.yaml` file. - -```yaml -hello_state: - text: 'Hello, World!' -``` - -Thanks to `DEFAULT_TEXT` variable the component will launch even if no `text:` field is used in the `configuration.yaml` file. Quite often there are variables which are required. It's important to check if all mandatory configuration variables are provided. If not, the setup should fail. We will use `voluptuous` as a helper to achieve this. The next listing shows the essential parts. - -```python -import voluptuous as vol - -import homeassistant.helpers.config_validation as cv - -CONFIG_SCHEMA = vol.Schema({ - DOMAIN: vol.Schema({ - vol.Required(CONF_TEXT): cv.string, - }) -}, extra=vol.ALLOW_EXTRA) -``` - -Now, when `text:` is missing from the config, Home Assistant will alert the user and not setup your component. - -After a start or a restart of Home Assistant the component will be visible in the frontend if the `configuration.yaml` file is up-to-date. - -

    - -

    - -In order to expose attributes for a platform, you will need to define a property called `device_state_attributes` on the entity class, which will return a dictionary of attributes: - -``` -@property -def device_state_attributes(self): - """Return device specific state attributes.""" - return self._attributes -``` - -

    -Entities also have a similar property `state_attributes`, which normally doesn't need to be defined by new platforms. This property is used by base components to add standard sets of attributes to a state. Example: The light component uses `state_attributes` to add brightness to the state dictionary. If you are designing a new component, you should define `state_attributes` instead. -

    - -To get your component included in the Home Assistant releases, follow the steps described in the [Submit your work](https://home-assistant.io/developers/development_submitting/) section. Basically you only need to move your component in the `homeassistant/component/` directory of your fork and create a Pull Request. + \ No newline at end of file diff --git a/source/developers/development_submitting.markdown b/source/developers/development_submitting.markdown index b1439e4551..aaeadba89f 100644 --- a/source/developers/development_submitting.markdown +++ b/source/developers/development_submitting.markdown @@ -9,39 +9,6 @@ sharing: true footer: true --- -Submit your improvements, fixes, and new features to Home Assistant one at a time, using GitHub [Pull Requests](https://help.github.com/articles/using-pull-requests). Here are the steps: - - 1. From your fork's dev branch, create a new branch to hold your changes: - - `git checkout -b some-feature` - - 2. Make your changes, create a [new platform](/developers/add_new_platform/), develop a [new component](/developers/creating_components/), or fix [issues](https://github.com/home-assistant/home-assistant/issues). - - 3. [Test your changes](/developers/development_testing/) and check for style violations. - - 4. If everything looks good according to these [musts](/developers/development_checklist/), commit your changes: - - `git add .` - - `git commit -m "Added some-feature"` - - * Write a meaningful commit message and not only `Update` or `Fix`. - * Use a capital letter to start with your commit message. - * Don't prefix your commit message with `[bla.bla]` or `platform:`. - * Consider adding tests to ensure that your code works. - - 5. Push your committed changes back to your fork on GitHub: - - `git push origin HEAD` - - 6. Follow [these steps](https://help.github.com/articles/creating-a-pull-request/) to create your pull request. - - * On GitHub, navigate to the main page of the Home Assistant repository. - * In the "Branch" menu, choose the branch that contains your commits (from your fork). - * To the right of the Branch menu, click **New pull request**. - * Use the base branch dropdown menu to select the branch you'd like to merge your changes into, then use the compare branch drop-down menu to choose the topic branch you made your changes in. Make sure the Home Assistant branch matches with your forked branch (`dev`) else you will propose ALL commits between branches. - * Type a title and complete the provided description for your pull request. - * Click **Create pull request**. - - 7. Check for comments and suggestions on your pull request and keep an eye on the [CI output](https://travis-ci.org/home-assistant/home-assistant/). - + \ No newline at end of file diff --git a/source/developers/development_testing.markdown b/source/developers/development_testing.markdown index 14dcf03c57..dc24f7bbfe 100644 --- a/source/developers/development_testing.markdown +++ b/source/developers/development_testing.markdown @@ -9,68 +9,6 @@ sharing: true footer: true --- -As states in the [Style guidelines section](/developers/development_guidelines/) all code is checked to verify all unit tests pass and that the code passes the linting tools. Local testing is done using Tox, which has been installed as part of running `script/setup`. To start the tests, simply run it: - -```bash -$ tox -``` -**Important:** Run `tox` before you create your pull request to avoid annoying fixes. - -Running Tox will run unit tests against the locally available Pythons, as well as validate the code and document style using `pycodestyle`, `pydocstyle` and `pylint`. You can run tests on only one tox target -- just use `-e` to select an environment. For example, `tox -e lint` runs the linters only, and `tox -e py34` runs unit tests only on Python 3.4. - -Tox uses virtual environments under the hood to create isolated testing environments. The tox virtual environments will get out-of-date when requirements change, causing test errors. Run `tox -r` to tell Tox to recreate the virtual environments. - -If you are working on tests for a component or platform and you need the dependencies available inside the Tox environment, update the list inside `script/gen_requirements_all.py`. Then run the script and then run `tox -r` to recreate the virtual environments. - -### {% linkable_title Running single tests using Tox %} - -You can pass arguments via Tox to py.test to be able to run single test suites or test files. Replace `py36` with the Python version that you use. - -```bash -# Stop after the first test fails -$ tox -e py36 -- tests/test_core.py -x -# Run test with specified name -$ tox -e py36 -- tests/test_core.py -k test_split_entity_id -# Fail a test after it runs for 2 seconds -$ tox -e py36 -- tests/test_core.py --timeout 2 -# Show the 10 slowest tests -$ tox -e py36 -- tests/test_core.py --duration=10 -``` - -### {% linkable_title Testing outside of Tox %} - -Running tox will invoke the full test suite. Even if you specify which tox target to run, you still run all tests inside that target. That's not very convenient to quickly iterate on your code! To be able to run the specific test suites without Tox, you'll need to install the test dependencies into your Python environment: - -```bash -$ pip3 install -r requirements_test_all.txt -``` - -Now that you have all test dependencies installed, you can run tests on individual files: - -```bash -$ flake8 homeassistant/core.py -$ pylint homeassistant/core.py -$ pydocstyle homeassistant/core.py -$ py.test tests/test_core.py -``` - -You can also run linting tests against all changed files, as reported by `git diff upstream/dev... --diff-filter=d --name-only`, using the `lint` script: - -```bash -$ script/lint -``` - -### {% linkable_title Preventing Linter Errors %} - -Save yourself the hassle of extra commits just to fix style errors by enabling the Flake8 git commit hook. Flake8 will check your code when you try to commit to the repository and block the commit if there are any style errors, which gives you a chance to fix them! - -```bash -$ pip3 install flake8 flake8-docstrings -$ flake8 --install-hook=git -``` - -The `flake8-docstrings` extension will check docstrings according to [PEP257](https://www.python.org/dev/peps/pep-0257/) when running Flake8. - -### {% linkable_title Notes on PyLint and PEP8 validation %} - -If you can't avoid a PyLint warning, add a comment to disable the PyLint check for that line with `# pylint: disable=YOUR-ERROR-NAME`. Example of an unavoidable one is if PyLint incorrectly reports that a certain object doesn't have a certain member. + \ No newline at end of file diff --git a/source/developers/development_validation.markdown b/source/developers/development_validation.markdown index 51fef2d39b..207b61b7d2 100644 --- a/source/developers/development_validation.markdown +++ b/source/developers/development_validation.markdown @@ -9,78 +9,6 @@ sharing: true footer: true --- -The `configuration.yaml` file contains the configuration options for components and platforms. We use [voluptuous](https://pypi.python.org/pypi/voluptuous) to make sure that the configuration provided by the user is valid. Some entries are optional or could be required to set up a platform or a component. Others must be a defined type or from an already-defined list. - -We test the configuration to ensure that users have a great experience and minimize notifications if something is wrong with a platform or component setup before Home Assistant runs. - -Besides [voluptuous](https://pypi.python.org/pypi/voluptuous) default types, many custom types are available. For an overview, take a look at the [config_validation.py](https://github.com/home-assistant/home-assistant/blob/master/homeassistant/helpers/config_validation.py) helper. - -- Types: `string`, `byte`, and `boolean` -- Entity ID: `entity_id` and `entity_ids` -- Numbers: `small_float` and `positive_int` -- Time: `time`, `time_zone` -- Misc: `template`, `slug`, `temperature_unit`, `latitude`, `longitude`, `isfile`, `sun_event`, `ensure_list`, `port`, `url`, and `icon` - -To validate plaforms using [MQTT](/components/mqtt/), `valid_subscribe_topic` and `valid_publish_topic` are available. - -Some things to keep in mind: - -- Use the constants defined in `const.py` -- Import `PLATFORM_SCHEMA` from the parent component and extend it -- Preferred order is `required` first and `optional` second - -### {% linkable_title Snippets %} - -This section contains snippets for the validation we use. - -#### {% linkable_title Default name %} - -It's common to set a default for a sensor if the user doesn't provide a name to use. - -```python -DEFAULT_NAME = 'Sensor name' - -PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend({ - ... - vol.Optional(CONF_NAME, default=DEFAULT_NAME): cv.string, -``` - -#### {% linkable_title Limit the values %} - -You might want to limit the user's input to a couple of options. - -```python -DEFAULT_METHOD = 'GET' - -PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend({ - ... - vol.Optional(CONF_METHOD, default=DEFAULT_METHOD): vol.In(['POST', 'GET']), -``` - -#### {% linkable_title Port %} - -All port numbers are from a range of 1 to 65535. - -```python -DEFAULT_PORT = 993 - -PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend({ - ... - vol.Optional(CONF_PORT, default=DEFAULT_PORT): cv.port, -``` - -#### {% linkable_title Lists %} - -If a sensor has a pre-defined list of available options, test to make sure the configuration entry matches the list. - -```python -SENSOR_TYPES = { - 'article_cache': ('Article Cache', 'MB'), - 'average_download_rate': ('Average Speed', 'MB/s'), -} - -PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend({ - ... - vol.Optional(CONF_MONITORED_VARIABLES, default=[]): - vol.All(cv.ensure_list, [vol.In(SENSOR_TYPES)]), -``` + \ No newline at end of file diff --git a/source/developers/documentation/index.markdown b/source/developers/documentation/index.markdown index 33dd22d859..50370c7802 100644 --- a/source/developers/documentation/index.markdown +++ b/source/developers/documentation/index.markdown @@ -10,7 +10,7 @@ footer: true redirect_from: /developers/website/ --- -The website you are reading now is the home of Home Assistant: [https://home-assistant.io](https://home-assistant.io). This is the place where we provide documentation and additional details about Home Assistant for end users and developers. +The website you are reading now is the home of Home Assistant: [https://www.home-assistant.io](/). This is the place where we provide documentation and additional details about Home Assistant for end users and developers. home-assistant.io is built using [Jekyll](http://github.com/mojombo/jekyll) and [these available dependencies](https://pages.github.com/versions/). The pages are written in [markdown](http://daringfireball.net/projects/markdown/). To add a page, you don't need to know about HTML. diff --git a/source/developers/documentation/standards.markdown b/source/developers/documentation/standards.markdown index 47ae4eab73..05b1223cc6 100644 --- a/source/developers/documentation/standards.markdown +++ b/source/developers/documentation/standards.markdown @@ -16,7 +16,7 @@ To ensure that the documentation for Home Assistant is consistent and easy to fo * The language of the documentation should be American-English. * Don't put two spaces after a period and avoid the "Oxford comma". * Be objective and not gender favoring, polarizing, race related or religion inconsiderate. -* The case of brand names, services, protocols, components, and platforms must match its respective counterpart. E.g. "Z-Wave" **not** "Zwave", "Z-wave", "Z Wave" or "ZWave". Also, "Input Select" **not** "input select" or "Input select". +* The case of brand names, services, protocols, components, and platforms must match its respective counterpart. e.g., "Z-Wave" **not** "Zwave", "Z-wave", "Z Wave" or "ZWave". Also, "Input Select" **not** "input select" or "Input select". * All headings should use the {% raw %}`{% linkable_title %}`{% endraw %} tag. ## {% linkable_title Component and Platform Pages %} @@ -25,23 +25,25 @@ To ensure that the documentation for Home Assistant is consistent and easy to fo * Configuration variables must document the requirement status. * Configuration variables must document the default value, if any. * Configuration variables must document the accepted value types. - * Use `[string, int]` for configuration variables that accept multiple types. + * For configuration variables that accept multiple types, separate the types with a comma (i.e. `string, int`). * Use YAML sequence syntax in the sample code if it is supported. * All examples should be formatted to be included in `configuration.yaml` unless explicitly stated. + * Use capital letters and `_` to indicate that the value needs to be replaced. E.g., `api_key: YOUR_API_KEY` or `api_key: REPLACE_ME`. + * If you know that the API key or value contains [control characters](https://en.wikipedia.org/wiki/YAML#Syntax), e.g., `#`, `[`, `?`, etc., wrap it in quotes and add a note. * Component and platform names should be a link to their respective documentation pages. ## {% linkable_title Templates %} * All examples containing Jinja2 templates should be wrapped **outside** of the code markdown with the {% raw %}`{% raw %}`{% endraw %} tag. * Do not use `states.switch.source.state` in templates. Instead use `states()` and `is_state()`. -* Use double quotes (`"`) for: +* Use double quotes (`"`) for ([more information](#single-vs-double-quotation-marks)): * `friendly_name` * Single-line templates: * `value_template` * `level_template` * `icon_template` * Children of `data_template` -* Use single quotes (`'`) for: +* Use single quotes (`'`) for ([more information](#single-vs-double-quotation-marks): * Strings inside of templates: * States * Entity IDs @@ -67,3 +69,53 @@ redirect_from: /getting-started/android/ ``` Adding a redirect also applies if you move content around in the [documentation](/docs/). + +## {% linkable_title Single vs. Double Quotation Marks %} + +Use single quotes (`'`) for strings inside of a template. It is more obvious to escape a single quote when necessary (i.e. `name` is a possessive noun), because the single quotes that wrap the string are closer in position to the apostrophe inside the string. Use double quotes (`"`) outside of a template (unless it is a multi-line template, in which case outside quotes are not required). + +### {% linkable_title Examples %} + +#### {% linkable_title Double Quotes Outside, Single Quotes Inside (Valid) %} + +{% raw %} +```yaml +automation: + ... + action: + - service: notify.notify + data_template: + message: "{% if trigger.to_state.name == 'Dale\'s Bedroom' %}Someone's in your base, killing your noobs!{% else %}It's just another door.{% endif %}" +``` +{% endraw %} + +#### {% linkable_title Single Quotes Outside, Double Quotes Inside (Invalid) %} + +{% raw %} +```yaml +automation: + ... + action: + - service: notify.notify + data_template: + message: '{% if trigger.to_state.name == "Dale's Bedroom" %}Someone's in your base, killing your noobs!{% else %}It's just another door.{% endif %}' +``` +{% endraw %} + +#### {% linkable_title Multi-Line Template (Valid) %} + +{% raw %} +```yaml +automation: + ... + action: + - service: notify.notify + data_template: + message: >- + {% if trigger.to_state.name == 'Dale\'s Bedroom' %} + Someone's in your base, killing your noobs! + {% else %} + It's just another door. + {% endif %} +``` +{% endraw %} diff --git a/source/developers/frontend.markdown b/source/developers/frontend.markdown index 0fb71208d9..316ca36487 100755 --- a/source/developers/frontend.markdown +++ b/source/developers/frontend.markdown @@ -9,94 +9,6 @@ sharing: true footer: true --- -Home Assistant is built on top of the [Polymer](https://www.polymer-project.org/) webcomponents framework. Polymer allows building encapsulated custom HTML elements. [Home-Assistant-Polymer source code on GitHub.][hass-polymer] - -

    -Do not use development mode in production. Home Assistant uses aggressive caching to improve the mobile experience. This is disabled during development so that you do not have to restart the server in between changes. -

    - -## {% linkable_title Setting up the environment %} - -

    -All commands below need to be run from inside the home-assistant-polymer repository. -

    - -Home Assistant will by default serve the compiled version of the frontend from the hass_frontend Python package. For development you want to work with the unbundled source files which are in the home-assistant-polymer repository. - -First step is to configure Home Assistant to use the development mode for the frontend. Do this by updating the frontend config in your `configuration.yaml` and set the path to the polymer repo: - -```yaml -frontend: - development_repo: -``` - -Next step is to git clone the [home-assistant-polymer repository][hass-polymer]. You can place the repository anywhere on your system but to keep these instructions simple we're cloning the home-assistant-polymer repository as a sibling to the Home Assistant repo. - -```bash -$ git clone https://github.com/home-assistant/home-assistant-polymer.git -$ cd home-assistant-polymer -``` - -After cloning, your folder structure should look like this: - -```text -/home-assistant -/home-assistant-polymer -``` - -Node.js is required to build the frontend. The preferred method of installing node.js is with [nvm](https://github.com/creationix/nvm). Install nvm using the instructions in the [README](https://github.com/creationix/nvm#install-script), and install the correct node.js by running the following command: - -```bash -$ nvm install -``` - -[Yarn](https://yarnpkg.com/en/) is used as the package manager for node modules. [Install yarn using the instructions here.](https://yarnpkg.com/en/docs/install) - -Next, development dependencies need to be installed to bootstrap the frontend development environment. First activate the right Node version and then download all the needed modules and do a first build: - -```bash -$ nvm use -$ script/bootstrap -``` - -This script will use yarn and bower to install all the necessary dependencies necessary for development and do an initial build. - -### {% linkable_title Creating pull requests %} - -If you're planning on issuing a PR back to the Home Assistant codebase you need to fork the polymer project and add your fork as a remote to the Home Assistant Polymer repo. - -```bash -$ git remote add -``` - -When you've made your changes and are ready to push them change to the working directory for the polymer project and then push your changes - -``` bash -$ git add -A -$ git commit -m "Added new feature X" -$ git push -u HEAD -``` - -## {% linkable_title Development %} - -If you are changing `html` files under `/src` or `/panels` - just reload the page in your browser to see changes. -If you are changing javascript files under `/js` you need to have gulp running to watch the source files for changes and build when necessary. - -```bash -$ yarn run dev-watch -``` - -The source code for the frontend can be found in different directories: - - - UI: `/home-assistant-polymer/src/` - - Panels: `/home-assistant-polymer/panels/` - - Javascript code: `/home-assistant-polymer/js/` - -# {% linkable_title Building the Polymer frontend %} - -Building a new version of the frontend is as simple as running `script/build_frontend`. -To use a built version package it: `python setup.py sdist` -Install it: `pip3 install dist/home-assistant-frontend-xxxxxxxx.0.tar.gz --upgrade` -Run Home Assistant without trying to reinstall production package: `hass --skip-pip` - -[hass-polymer]: https://github.com/home-assistant/home-assistant-polymer + \ No newline at end of file diff --git a/source/developers/frontend_add_card.markdown b/source/developers/frontend_add_card.markdown index 2deba80dbc..d10dda464b 100644 --- a/source/developers/frontend_add_card.markdown +++ b/source/developers/frontend_add_card.markdown @@ -9,20 +9,6 @@ sharing: true footer: true --- -The main interface of Home Assistant is a list of the current entities and their states. For each entity in the system, a state card will be rendered. State cards will show an icon, the name of the entity, when the state has last changed and the current state or a control to interact with it. - -![Cards in the frontend](/images/frontend/frontend-cards1.png) - -The different card types can be found [here](https://github.com/home-assistant/home-assistant-polymer/tree/master/src/state-summary). - -Sensors, when not [grouped](/components/group/), are shown as so-called badges on top of the state cards. - -![Badges in the frontend](/images/frontend/frontend-badges.png) - -The different badges are located in the file [`/src/components/entity/ha-state-label-badge.html`](https://github.com/home-assistant/home-assistant-polymer/blob/master/src/components/entity/ha-state-label-badge.html). - -Adding a custom card type can be done with a few simple steps. For this example we will add a new state card for the domain `camera`: - - 1. Add `'camera'` to the array `DOMAINS_WITH_CARD` in the file [/util/hass-util.html](https://github.com/home-assistant/home-assistant-polymer/blob/master/src/util/hass-util.html#L11). - 2. Create the files `state-card-camera.html` in the folder [/state-summary/](https://github.com/home-assistant/home-assistant-polymer/tree/master/src/state-summary). - 4. Add `` to [state-card-content.html](https://github.com/home-assistant/home-assistant-polymer/blob/master/src/state-summary/state-card-content.html). + \ No newline at end of file diff --git a/source/developers/frontend_add_more_info.markdown b/source/developers/frontend_add_more_info.markdown index 2364c5b312..5a6993837f 100644 --- a/source/developers/frontend_add_more_info.markdown +++ b/source/developers/frontend_add_more_info.markdown @@ -9,15 +9,6 @@ sharing: true footer: true --- -Whenever the user taps or clicks on one of the cards, a more info dialog will show. The header of this dialog will be the state card, followed by the history of this entity for the last 24 hours. Below this the more info component is rendered for that entity. The more info component can show more information or allow more ways of control. - -

    - - The more info dialog for a light allows the user to control the color and the brightness. -

    - -The instructions to add a more info dialog are very similar to adding a new card type. This example will add a new more info component for the domain `camera`: - - 1. Add `'camera'` to the array `DOMAINS_WITH_MORE_INFO` in the file [util/hass-util.html](https://github.com/home-assistant/home-assistant-polymer/blob/master/src/util/hass-util.html#L24). - 2. Create the files `more-info-camera.html` in the folder [/more-infos](https://github.com/home-assistant/home-assistant-polymer/tree/master/src/more-infos). - 4. Add `` to [more-info-content.html](https://github.com/home-assistant/home-assistant-polymer/blob/master/src/more-infos/more-info-content.html) + \ No newline at end of file diff --git a/source/developers/frontend_creating_custom_panels.markdown b/source/developers/frontend_creating_custom_panels.markdown index 4066e6062a..670a562cfa 100644 --- a/source/developers/frontend_creating_custom_panels.markdown +++ b/source/developers/frontend_creating_custom_panels.markdown @@ -9,83 +9,6 @@ sharing: true footer: true --- -Panels are pages within Home Assistant that show information within Home Assistant and can allow controlling it. Panels are linked from the sidebar and rendered full screen. The have have real-time access to the Home Assistant object via JavaScript. Examples of panels in the app are map, logbook and history. - -Besides components registering panels, users can also register panels using the `panel_custom` component. This allows users to quickly build their own custom interfaces for Home Assistant. - -### {% linkable_title Before you get started %} - -The Home Assistant user interface is currently served to browsers in modern JavaScript and older JavaScript (ES5). The older version has a wider browser support but that comes at a cost of size, performance and more difficult to get started building panels for authors. - -We therefore advice to set up the frontend to serve the modern version of the frontend so that you won't need any build tools while developing. If you realize that your audience requires both, you can add a transpilation step in the future. To set up your frontend to always serve the latest version, add this to your config: - -``` -frontend: - javascript_version: latest -``` - -### {% linkable_title Building your first panel %} - -Create a file called `hello.html` in your /panels/. - -The `hello.html` contains the needed building blocks to create the elements inside the view. - -```html - - - - -``` - -Create an entry for the new panel in your `configuration.yaml` file: - -```yaml -panel_custom: - - name: hello - sidebar_title: Hello World - sidebar_icon: mdi:hand-pointing-right - url_path: hello -``` - -For more possibilities, see the [Custom panel section](/cookbook/#user-interface) on our Examples page. +window.location = 'https://developers.home-assistant.io/docs/en/frontend_creating_custom_panels.html'; + \ No newline at end of file diff --git a/source/developers/frontend_creating_custom_ui.markdown b/source/developers/frontend_creating_custom_ui.markdown index c9da0cf1e2..f70c3ce3c1 100644 --- a/source/developers/frontend_creating_custom_ui.markdown +++ b/source/developers/frontend_creating_custom_ui.markdown @@ -10,72 +10,6 @@ footer: true ha_release: 0.38 --- -If you would like to use your own [State card](/developers/frontend_add_card/) without merging your code into [home-assistant-polymer](https://github.com/home-assistant/home-assistant-polymer/) you can create your own implementation. - -Put the element source file and its dependencies in `www/custom_ui/` directory under your Home Assistant [configuration](/docs/configuration/) directory. - -For example if creating a state card for the `light` domain named `state-card-my-custom-light` put `state-card-my-custom-light.html` in `www/custom_ui/`. - -That file should implement `` tag with Polymer. - -In `state-card-my-custom-light.html` you should use `` to import all the dependencies **not** used by Home Assistant's UI. -Do not import any dependencies used by the Home Assistant UI. -Importing those will work in `development: 1` mode, but will fail in production mode. - -1. In the `customize:` section of the `configuration.yaml` file put `custom_ui_state_card: state-card-my-custom-light`. -2. In the `frontend` section use `extra_html_url` to specify the URL to load. - -Example: - -`configuration.yaml`: - -```yaml -homeassistant: - customize: - light.bedroom: - custom_ui_state_card: state-card-my-custom-light - -frontend: - extra_html_url: - - /local/custom_ui/state-card-my-custom-light.html -``` - -`www/custom_ui/state-card-my-custom-light.html`: - -```javascript - - - - -``` - -For more possibilities, see the [Custom UI section](/cookbook/#user-interface) on our Examples page. +window.location = 'https://developers.home-assistant.io/docs/en/frontend_creating_custom_ui.html'; + \ No newline at end of file diff --git a/source/developers/hassio/addon_communication.markdown b/source/developers/hassio/addon_communication.markdown index 775008162a..2ade126855 100644 --- a/source/developers/hassio/addon_communication.markdown +++ b/source/developers/hassio/addon_communication.markdown @@ -10,32 +10,6 @@ footer: true redirect_from: /hassio/addon_config/ --- -There are different ways for communication between add-ons inside Hass.io. - -## {% linkable_title Network %} - -We use an internal network that allows to communicate with every add-on, even to/from Home Assistant, by using his name or alias. Only the add-ons which run on the host network are a bit limited. These can talk with all internal add-ons by their name but all other add-on can't address these add-on by name - using an alias works for both! - -Name/alias are used for communication inside Hass.io. -The name is generated using the following format: `{REPO}_{SLUG}`, e.g. `local_xy` or `3283fh_myaddon`. In this example, `{SLUG}` is defined in an add-ons `config.json`. If an add-on is installed locally, `{REPO}` will be `local`. If the add-on is installed from a Github repository, `{REPO}` is a hashed identifier generated from the GitHub repository's URL (ex: https://github.com/xy/my_hassio_addons). See [here](https://github.com/home-assistant/hassio/blob/587047f9d648b8491dc8eef17dc6777f81938bfd/hassio/addons/utils.py#L17) to understand how this identifier is generated. Note that this identifier is required in certain service calls that use the [Hass.io add-on API](hassio-addon-api). You can view the repository identifiers for all currently installed add-ons via a GET request to the hassio API `addons` endpoint. - -Use `hassio` for communication with the internal API. - -## {% linkable_title Home Assistant %} - -An add-on can talk to the [Home Assistant API][hass-api] using the internal proxy. That makes it very easy to communicate with the API without knowing the password, port or any other information of the Home Assistant instance. Use this URL: `http://hassio/homeassistant/api` and internal communication is redirected to the right place. The next stept is to add `homeassistant_api: true` to `config.json` and read the environment variable `HASSIO_TOKEN` and use this as Home-Assistant password. - -There is also a proxy for the [Home Assistant Websocket API][hass-websocket]. It works like the API proxy above and requires `HASSIO_TOKEN` as password. Use this URL: `http://hassio/homeassistant/websocket`. - -It is also possible to talk direct to the Home Assistant instance which is named `homeassistant` over the internal network. But you need to know the configuration that is used by the running instance. - -We have severals services for Hass.io inside Home Assistant to run tasks. To send data over STDIN to an add-on use the `hassio.addon_stdin` service. - -## {% linkable_title Hass.io API %} - -To enables calls to the [Hass.io API][hassio-api], add `hassio_api: true` to `config.json` and read the environment variable `HASSIO_TOKEN`. Now you can use the API over the URL: `http://hassio/`. Use the `HASSIO_TOKEN` with header `X-HASSIO-KEY`. - -[hass-api]: https://home-assistant.io/developers/rest_api/ -[hass-websocket]: https://home-assistant.io/developers/websocket_api/ -[hassio-api]: https://github.com/home-assistant/hassio/blob/master/API.md -[hassio-addon-api]: https://github.com/home-assistant/hassio/blob/dev/API.md#restful-for-api-addons + \ No newline at end of file diff --git a/source/developers/hassio/addon_config.markdown b/source/developers/hassio/addon_config.markdown index cf91e022b4..a13c1e7c71 100644 --- a/source/developers/hassio/addon_config.markdown +++ b/source/developers/hassio/addon_config.markdown @@ -10,196 +10,6 @@ footer: true redirect_from: /hassio/addon_config/ --- -Each add-on is stored in a folder. The file structure looks like this: - -```text -addon_name/ - build.json - CHANGELOG.md - config.json - Dockerfile - icon.png - logo.png - README.md - run.sh -``` - -## {% linkable_title Add-on script %} - -As with every Docker container, you will need a script to run when the container is started. A user might run many add-ons, so it is encouraged to try to stick to Bash scripts if you're doing simple things. - -When developing your script: - - - `/data` is a volume for persistent storage. - - `/data/options.json` contains the user configuration. You can use `jq` inside your shell script to parse this data. However, you might have to install `jq` as a separate package in your container (see `Dockerfile` below). - -```bash -CONFIG_PATH=/data/options.json - -TARGET="$(jq --raw-output '.target' $CONFIG_PATH)" -``` - -So if your `options` contain -```json -{ "target": "beer" } -``` -then there will be a variable `TARGET` containing `beer` in the environment of your bash file afterwards. - -## {% linkable_title Add-on Docker file %} - -All add-ons are based on Alpine Linux 3.6. Hass.io will automatically substitute the right base image based on the machine architecture. Add `tzdata` if you need run in a different timezone. `tzdata` Is is already added to our base images. - -``` -ARG BUILD_FROM -FROM $BUILD_FROM - -ENV LANG C.UTF-8 - -# Install requirements for add-on -RUN apk add --no-cache jq - -# Copy data for add-on -COPY run.sh / -RUN chmod a+x /run.sh - -CMD [ "/run.sh" ] -``` - -If you don't use local build on device or our build script, make sure that the Dockerfile have also a set of labels include: -``` -LABEL io.hass.version="VERSION" io.hass.type="addon" io.hass.arch="armhf|aarch64|i386|amd64" -``` - -It is possible to use own base image with `build.json` or if you do not need support for automatic multi-arch building you can also use a simple docker `FROM`. - -### {% linkable_title Build Args %} - -We support the following build arguments by default: - -| ARG | Description | -|-----|-------------| -| BUILD_FROM | Hold image for dynamic builds or buildings over our systems. -| BUILD_VERSION | Add-on version (read from `config.json`). -| BUILD_ARCH | Hold current build arch inside. - -## {% linkable_title Add-on config %} - -The config for an add-on is stored in `config.json`. - -```json -{ - "name": "xy", - "version": "1.2", - "slug": "folder", - "description": "long description", - "arch": ["amd64"], - "url": "website with more information about add-on (ie a forum thread for support)", - "startup": "application", - "boot": "auto", - "ports": { - "123/tcp": 123 - }, - "map": ["config:rw", "ssl"], - "options": {}, - "schema": {}, - "image": "repo/{arch}-my-custom-addon" -} -``` - -| Key | Required | Description | -| --- | -------- | ----------- | -| name | yes | Name of the add-on -| version | yes | Version of the add-on -| slug | yes | Slug of the add-on -| description | yes | Description of the add-on -| arch | no | List of supported arch: `armhf`, `aarch64`, `amd64`, `i386`. Default all. -| url | no | Homepage of the addon. Here you can explain the add-ons and options. -| startup | yes | `initialize` will start addon on setup of Hass.io. `system` is for things like databases and not dependent on other things. `services` will start before Home Assistant, while `application` is started afterwards. Finally `once` is for applications that don't run as a daemon. -| webui | no | A URL for web interface of this add-on. Like `http://[HOST]:[PORT:2839]/dashboard`, the port needs the internal port, which will be replaced with the effective port. It is also possible to bind the proto part to a config options with: `[PROTO:option_name]://[HOST]:[PORT:2839]/dashboard` and he lookup if they is True and going to `https`. -| boot | yes | `auto` by system and manual or only `manual` -| ports | no | Network ports to expose from the container. Format is `"container-port/type": host-port`. -| host_network | no | If that is True, the add-on run on host network. -| host_ipc | no | Default False. Allow to share the IPC namespace with others. -| host_dbus | no | Default False. Map Host dbus service into add-on. -| devices | no | Device list to map into the add-on. Format is: `::`. i.e. `/dev/ttyAMA0:/dev/ttyAMA0:rwm` -| auto_uart | no | Default False. Auto mapping all UART/Serial device from host into add-on. -| hassio_api | no | This add-on can access to Hass.io REST API. It set the host alias `hassio`. -| homeassistant_api | no | This add-on can access to Hass.io Home-Assistant REST API proxy. Use `http://hassio/homeassistant/api`. -| privileged | no | Privilege for access to hardware/system. Available access: `NET_ADMIN`, `SYS_ADMIN`, `SYS_RAWIO`, `SYS_TIME`, `SYS_NICE` -| map | no | List of maps for additional Hass.io folders. Possible values: `config`, `ssl`, `addons`, `backup`, `share`. Defaults to `ro`, which you can change by adding `:rw` to the end of the name. -| environment | no | A dict of environment variable to run add-on. -| audio | no | Boolean. Mark this add-on to use internal an audio system. The available environment variables are `ALSA_INPUT` and `ALSA_OUTPUT` which provide internal information to access alsa. -| gpio | no | Boolean. If this is set to True, `/sys/class/gpio` will map into add-on for access to GPIO interface from kernel. Some library need also `/dev/mem` and `SYS_RAWIO` for read/write access to this device. -| stdin | no | Boolean. If that is enable, you can use the STDIN with Hass.io API. -| legacy | no | Boolean. If the docker image have no hass.io labels, you can enable the legacy mode to use the config data. -| options | yes | Default options value of the add-on -| schema | yes | Schema for options value of the add-on. It can be `False` to disable schema validation and use custom options. -| image | no | For use with Docker Hub. -| timeout | no | Default 10 (second). The timeout to wait until the docker is done or will be killed. -| tmpfs | no | Mount a tmpfs file system in `/tmpfs`. Valide format for this option is : `size=XXXu,uid=N,rw`. Size is mandatory, valid units (`u`) are `k`, `m` and `g` and `XXX` has to be replaced by a number. `uid=N` (with `N` the uid number) and `rw` are optional. - -### {% linkable_title Options / Schema %} - -The `options` dictionary contains all available options and their default value. Set the default value to `null` if the value is required to be given by the user before the add-on can start, and it show it inside default values. Only nested arrays and dictionaries are supported with a deep of two size. If you want make an option optional, put `?` to the end of data type, otherwise it will be a required value. - -```json -{ - "message": "custom things", - "logins": [ - { "username": "beer", "password": "123456" }, - { "username": "cheep", "password": "654321" } - ], - "random": ["haha", "hihi", "huhu", "hghg"], - "link": "http://example.com/", - "size": 15, - "count": 1.2 -} -``` - -The `schema` looks like `options` but describes how we should validate the user input. For example: - -```json -{ - "message": "str", - "logins": [ - { "username": "str", "password": "str" } - ], - "random": ["match(^\w*$)"], - "link": "url", - "size": "int(5,20)", - "count": "float", - "not_need": "str?" -} -``` - -We support: -- str -- bool -- int / int(min,) / int(,max) / int(min,max) -- float / float(min,) / float(,max) / float(min,max) -- email -- url -- port -- match(REGEX) - -## {% linkable_title Add-on extended build %} - -Additional build options for an add-on is stored in `build.json`. This file will be read from our build systems. - -```json -{ - "build_from": { - "armhf": "homeassistant/armhf-base:latest" - }, - "squash": false, - "args": { - "my_build_arg": "xy" - } -} -``` - -| Key | Required | Description | -| --- | -------- | ----------- | -| build_from | no | A dictionary with the hardware architecture as the key and the base Docker image as value. -| squash | no | Default `False`. Be carfully with this option, you can not use the image for caching stuff after that! -| args | no | Allow to set additional Docker build arguments as a dictionary. + \ No newline at end of file diff --git a/source/developers/hassio/addon_development.markdown b/source/developers/hassio/addon_development.markdown index ec1f3f9674..1a99e8f384 100644 --- a/source/developers/hassio/addon_development.markdown +++ b/source/developers/hassio/addon_development.markdown @@ -10,14 +10,6 @@ footer: true redirect_from: /hassio/addon_development/ --- -Add-ons for Hass.io allow the user to extend the functionality around Home Assistant. This can be running an application that Home Assistant can integrate with (like an MQTT broker) or to share the configuration via Samba for easy editing from other computers. Add-ons can be configured via the Hass.io panel in Home Assistant. - -Under the hood, add-ons are Docker images published in [Docker Hub](https://hub.docker.com/). Developers can create [GitHub](https://github.com) repositories that contain multiple references to add-ons for easy sharing with the community. - -1. [Tutorial: Making your first add-on](/developers/hassio/addon_tutorial/) -1. [Configuration](/developers/hassio/addon_config/) -1. [Communication](/developers/hassio/addon_communication/) -1. [Local Testing](/developers/hassio/addon_testing/) -1. [Publishing](/developers/hassio/addon_publishing/) -1. [Presentation](/developers/hassio/addon_presentation/) -1. [Repositories](/developers/hassio/addon_repository/) + \ No newline at end of file diff --git a/source/developers/hassio/addon_presentation.markdown b/source/developers/hassio/addon_presentation.markdown index 413dd0489d..26ee4f20d2 100644 --- a/source/developers/hassio/addon_presentation.markdown +++ b/source/developers/hassio/addon_presentation.markdown @@ -9,41 +9,6 @@ sharing: true footer: true --- -If you decide to share your add-on to the public, paying attention to details is recommended. Of course, your add-on should have a proper name and description, but Hass.io also gives you some other tools to present your add-on even nicer. - -## {% linkable_title Adding documentation %} - -Good documentation helps the consumer of your add-on to understand its usage, explains configuration options, points users in the right direction in the case they have questions or issues, and contains the license under which the add-on was published. - -This file containing the documentation is usually referred to as the "README", which is generally published as the `README.md` file. - -Take a look at other projects for inspiration. For example, see the `README.md` of the [Community Hass.io Add-ons: Homebridge](https://github.com/hassio-addons/addon-homebridge/blob/master/README.md) add-on. - -In future versions of Hass.io, the `README.md` file will be displayed in the Home Assistant frontend. - -## {% linkable_title Add-on icon & logo %} - -A picture is worth a thousand words. Therefore, your add-on can be improved by adding a proper image icon and logo. Those images are used when showing your add-on in the Home Assistant Hass.io panel and which will significantly improve the visual representation of your add-on. - -Requirements for the logo of your add-on: - -- The logo must be in the Portable Network Graphics format (`.png`). -- The filename must be `logo.png`. -- It is recommended to keep the logo size around 250x100px. You may choose to use a different size or aspect ratio as you seem fit for your add-on. - -Requirements for the icon of your add-on: - -- The icon must be in the Portable Network Graphics format (`.png`). -- The filename must be `icon.png`. -- The aspect ratio of the icon must be 1x1 (square). -- It is recommended to use an icon size of 128x128px. - -## {% linkable_title Keeping a changelog %} - -It is likely you are going to release newer versions of your add-on in the future. In case that happens, the users of your add-on would see an upgrade notice and probably want to know what changes were made in the latest version. - -A changelog is a file which contains a curated, chronologically ordered list of notable changes for each version of your add-on and is generally published as the `CHANGELOG.md` file. - -If you are in need of a guide on keeping a changelog, we would recommend checking the [keep a changelog](http://keepachangelog.com) website. They have developed a standard that is used by many opensource projects around the world. - -In future versions of Hass.io, the `CHANGELOG.md` file will be displayed in the Home Assistant frontend. + \ No newline at end of file diff --git a/source/developers/hassio/addon_publishing.markdown b/source/developers/hassio/addon_publishing.markdown index 26020a6616..735dbe7093 100644 --- a/source/developers/hassio/addon_publishing.markdown +++ b/source/developers/hassio/addon_publishing.markdown @@ -10,56 +10,6 @@ footer: true redirect_from: /hassio/addon_publishing/ --- -There are two different ways of publishing add-ons. One is to publish pre-build containers to Docker Hub and the other option is to have users build the containers locally on their Hass.io instance. - -#### {% linkable_title Pre-build containers %} - -With pre-build containers, the developer is responsible for building the images for each architecture on their machine and push the results out to Docker Hub. This has a lot of advantages for the user. As a user it will only have to download the final container and be up and running once the download finishes. This makes the installation process fast and almost no chance of failure. This is the preferred method. - -We have automated the process of building and publishing add-ons. See below for the instructions. - -#### {% linkable_title Locally build containers %} - -Starting Hass.io 0.26, it is possible to distribute add-ons that will be built on the users machine. The advantage is that as a developer it is easy to test an idea and see if people are interested in your add-ons. This method includes installing and potentially compiling code. This means that installing such an add-on is slow and adds more wear and tear to users SD card/hard drive than the above mentioned pre-build solution. It also has a higher chance of failure if one of the dependencies of the container has changed or is no longer available. - -Use this option when you are playing with add-ons and seeing if someone is interested in your work. Once you're an established repository, please migrate to pushing builds to Docker Hub as it greatly improves the user experience. In the future we will mark locally built add-ons in the add-on store to warn users. - -## {% linkable_title Build scripts to publish add-ons to Docker Hub %} - -All add-ons are simple docker containers. Inside your add-on `config.json` you specify the Docker image that will be installed for your add-on: - -```json -{ - ... - - "image": "myhub/image-{arch}-addon-name", - - ... -} -``` - -You can use `{arch}` inside the image name to support multiple architectures with 1 configuration file. It will be replaced with the architecture of the user when we load the image. If you use `Buildargs` you can use the `build.json` to overwrite our default args. - -Hass.io assumes that the `master` branch of your add-on repository matches the latest tag on Docker Hub. When you're building a new version, it's suggested that you use another branch, ie `build` or do it with a PR on GitHub. After you push the add-on to [Docker Hub](https://hub.docker.com/), you can merge this branch to master. - -## {% linkable_title Custom Add-ons %} - -You need a Docker Hub account to make your own add-ons. You can build your docker images with docker `build` command or use our script that make it simple. Pull our [builder docker engine][builder] and run one of the following commands. - -For a git repository: - -```bash -$ docker run --rm --privileged -v ~/.docker:/root/.docker homeassistant/amd64-builder --all -t addon-folder -r https://github.com/xy/addons -b branchname -``` - -For a local repository: - -```bash -$ docker run --rm --privileged -v ~/.docker:/root/.docker -v /my_addon:/data homeassistant/amd64-builder --all -t /data -``` - -

    -If you are developing on macOS and using Docker for Mac, you may encounter an error message similar to the following: error creating aufs mount to /var/lib/docker/aufs/mnt/-init: invalid argument. A proposed workaround is to add the following to the Advanced Daemon JSON configuration via Docker > Preferences > Daemon > Advanced: "storage-driver" : "aufs". -

    - -[builder]: https://github.com/home-assistant/hassio-build/tree/master/builder + \ No newline at end of file diff --git a/source/developers/hassio/addon_repository.markdown b/source/developers/hassio/addon_repository.markdown index 9a8373fa51..5e5797ff9f 100644 --- a/source/developers/hassio/addon_repository.markdown +++ b/source/developers/hassio/addon_repository.markdown @@ -10,28 +10,6 @@ footer: true redirect_from: /hassio/addon_repository/ --- -An add-on repository can contain one or more add-ons. Each add-on is stored in its own unique folder. To be indentified as a repository, the repository must contain a configuration file. - -Check the [Example add-on repository](https://github.com/home-assistant/hassio-addons-example) for further details. - -## {% linkable_title Installing a repository %} - -A user can add a repository by going to the Hass.io panel in Home Assistant, clicking on the store icon in the top right, copy/paste the URL of your repostory into the repository textarea and click on **Save**. - -## {% linkable_title Repository configuration %} - -Each repository is required to contain `repository.json` at the root in the git repository. - -```json -{ - "name": "Name of repository", - "url": "http://www.example/addons", - "maintainer": "HomeAssistant Team " -} -``` - -| Key | Required | Description | -| --- | -------- | ----------- | -| name | yes | Name of the repository -| url | no | Homepage of the repository. Here you can explain the various add-ons. -| maintainer | no | Contact info of the maintainer. + \ No newline at end of file diff --git a/source/developers/hassio/addon_testing.markdown b/source/developers/hassio/addon_testing.markdown index f2f562f443..8c8eaa50cc 100644 --- a/source/developers/hassio/addon_testing.markdown +++ b/source/developers/hassio/addon_testing.markdown @@ -10,28 +10,6 @@ footer: true redirect_from: /hassio/addon_testing/ --- -The fastest way to develop add-ons is by adding them to your local add-on repository. To access your local add-on repository, install either the [Samba add-on] or [SSH add-on]. - -Right now add-ons will work with images that are stored on Docker Hub (using `image` from add-on config). Without `image` inside local add-ons repository it to be built on the device. - -## {% linkable_title Local build %} - -You can build and try the addon on your developer machine also. Move all addon stuff into a temp folder. If you use `FROM $BUILD_FROM` you need set a base image with build args. Normally you can use follow base images: - -- armhf: `homeassistant/armhf-base:latest` -- aarch64: `homeassistant/aarch64-base:latest` -- amd64: `homeassistant/amd64-base:latest` -- i386: `homeassistant/i386-base:latest` - -Use `docker` to build the test addon: `docker build --build-arg BUILD_FROM="homeassistant/amd64-base:latest" -t local/my-test-addon .` - -## {% linkable_title Local run %} - -Create a new folder for data and add a test _options.json_ file. After that you can run your add-on with: `docker run --rm -v /tmp/my_test_data:/data -p PORT_STUFF_IF_NEEDED local/my-test-addon` - -## {% linkable_title Logs %} - -All stdout and stderr are redirected to the Docker logs. The logs can be fetched from the add-on page inside the Hass.io panel in Home Assistant. - -[Samba add-on]: /addons/samba/ -[SSH add-on]: /addons/ssh/ + \ No newline at end of file diff --git a/source/developers/hassio/addon_tutorial.markdown b/source/developers/hassio/addon_tutorial.markdown index ebd8dd646b..cca2f3a2f7 100644 --- a/source/developers/hassio/addon_tutorial.markdown +++ b/source/developers/hassio/addon_tutorial.markdown @@ -10,199 +10,6 @@ footer: true redirect_from: /hassio/addon_tutorial/ --- -So you've got Home Assistant going and you've been enjoying the built-in add-ons but you're missing this one application. Time to make your own add-on! In Hass.io 0.24 we introduced the option to have local add-ons be build on your device. This is great for developing new add-ons locally. - -To get started with developing add-ons, we first need access to where Hass.io looks for local add-ons. For this you can use the Samba add-on or the SSH add-on. - -For Samba, once you have enabled and started it, your Hass.io instance will show up in your local network tab and share a folder called "addons". This is the folder to store your custom add-ons. - -If you are on macOS and the folder is not showing up automatically, go to Finder and press CMD+K then enter 'smb://hassio.local' - -

    - -With Samba add-on enabled, you can browse to your Hass.io server over the local network. It will contain an addons folder to store your local add-ons. -

    - -For SSH, you will have to install it. Before you can start it, you will have to have a private/public key pair and store your public key in the add-on config ([see docs for more info][ssh]). Once started, you can SSH to Hass.io and store your custom add-ons in "/addons". - -

    - -Once you SSH into your Hass.io box, you have access to your add-ons in "/addons". -

    - -Once you have located your add-on directory, it's time to get started! - -[ssh]: /addons/ssh/ - -## {% linkable_title Step 1: The basics %} - - - Create a new directory called `hello_world` - - Inside that directory create three files. - -`Dockerfile`: -``` -ARG BUILD_FROM -FROM $BUILD_FROM - -ENV LANG C.UTF-8 - -# Copy data for add-on -COPY run.sh / -RUN chmod a+x /run.sh - -CMD [ "/run.sh" ] -``` - -`config.json`: -```json -{ - "name": "Hello world", - "version": "1", - "slug": "hello_world", - "description": "My first real add-on!", - "startup": "before", - "boot": "auto", - "options": {}, - "schema": {} -} -``` - -`run.sh`: -```bash -echo Hello world! -``` - -## {% linkable_title Step 2: Installing and testing your add-on %} - -Now comes the fun part, time to open the Hass.io UI and install and run your add-on. - - - Open the Home Assistant frontend - - Go to the Hass.io panel - - On the top right click the shopping basket to go to the add-on store. - -

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

    - - - On the top right click the refresh button - - You should now see a new card called "Local" that lists your add-on! - -

    - -The Hass.io add-on store will list all available local add-ons. -

    - - - Click on your add-on to go to the add-on details page. - - Install your add-on - - Start your add-on - - Refresh the logs of your add-on, you should now see "Hello world!" in your logs. - -

    - -The add-on will print Hello world to the logs and then quit. -

    - -### {% linkable_title I don't see my add-on?! %} - -Oops! You clicked refresh in the store and your add-on didn't show up. Or maybe you just updated an option, clicked refresh and saw your add-on disappear. - -When this happens, it means that your `config.json` is invalid. It's either invalid JSON or one of the specified options is incorrect. To see what went wrong, go to the Hass.io panel and in the supervisor card click on "View logs". This should bring you to a page with the logs of the supervisor. Scroll to the bottom and you should be able to find the validation error. - -Once you fixed the error, go to the add-on store and click refresh again. - -## {% linkable_title Step 3: Hosting a server %} - -Until now we've been able to do some basic stuff, but it's not very useful yet. So let's take it one step further and host a server that we expose on a port. For this we're going to use the built-in HTTP server that comes with Python 3. - -To do this, we will need to update our files as follows: - - - `Dockerfile`: Install Python 3 - - `config.json`: Make the port from the container available on the host - - `run.sh`: Run the Python 3 command to start the HTTP server - -Add to your `Dockerfile` before `RUN`: - -``` -# Install requirements for add-on -RUN apk add --no-cache python3 - -# Python 3 HTTP Server serves the current working dir -# So let's set it to our add-on persistent data directory. -WORKDIR /data -``` - -Add "ports" to `config.json`. This will make TCP on port 8000 inside the container available on the host on port 8000. - -```json -{ - "name": "Hello world", - "version": "0.2", - "slug": "hello_world", - "description": "My first real add-on!", - "startup": "before", - "boot": "auto", - "options": {}, - "schema": {}, - "ports": { - "8000/tcp": 8000 - } -} -``` - -Update `run.sh` to start the Python 3 server: - -``` -python3 -m http.server -``` - -## {% linkable_title Step 4: Installing the update %} - -Since we updated the version number in our `config.json`, Home Assistant will show an update button when looking at the add-on details. You might have to refresh your browser or click the refresh button in the add-on store for it to show up. If you did not update the version number, you can also uninstall and install the add-on again. After installing the add-on again, make sure you start it. - -Now navigate to [http://hassio.local:8000](http://hassio.local:8000) to see our server in action! - -

    - -The Python 3 server will allow you to browse the /data folder. -

    - -## {% linkable_title Bonus: Working with add-on options %} - -In the screenshot you've probably seen that our server only served up 1 file: `options.json`. This file contains the user configuration for this add-on. Because we specified an empty "config" and "schema" in our `config.json`, the file is currently empty. - -Let's see if we can get some data into that file! - -To do this, we need to specify the default options and a schema for the user to change the options. - -Change the options and schema entries in your `config.json` with the following: - -```json -{ - … - - "options": { - "beer": true, - "wine": true, - "liquor": false, - "name": "world", - "year": 2017 - }, - "schema": { - "beer": "bool", - "wine": "bool", - "liquor": "bool", - "name": "str", - "year": "int" - }, - - … -} -``` - -Refresh the add-on store and re-install your add-on. You will now see the options available in the add-on config screen. When you now go back to our Python 3 server and download `options.json`, you'll see the options you set. - - - [Learn more about the available schema options.](/hassio/addon_config/#options--schema) - - [See how options.json can be used inside `run.sh`](https://github.com/home-assistant/hassio-addons/blob/master/mosquitto/run.sh#L4-L6) - -### [Next step: Add-on config reference »](/developers/hassio/addon_config/) + \ No newline at end of file diff --git a/source/developers/hassio/architecture.markdown b/source/developers/hassio/architecture.markdown index 173e3657ae..5b3a12f53c 100644 --- a/source/developers/hassio/architecture.markdown +++ b/source/developers/hassio/architecture.markdown @@ -10,30 +10,6 @@ footer: true redirect_from: /hassio/architecture/ --- -

    - Architecture overview of Hass.io - Architecture overview of Hass.io -

    - -### {% linkable_title Host Control (HC) %} - -This is a daemon running on the host machine that allows the supervisor to control certain aspects of the host OS: - - - Power cycle (restart, turn off) - - Manage network settings - - Local updates - -### {% linkable_title Host %} - -Our pre-build images are based on [ResinOS]. Any Linux machine can be turned into a Hass.io host by running [the installer][linux]. - -### {% linkable_title Supervisor %} - -The supervisor offers an API to manage the host and running the Docker containers. - -### {% linkable_title Configuration panel %} - -The configuration panel lives inside the supervisor but is accessible via the Home Assistant user interface. The configuration panel allows the user to manage the installation. - -[ResinOS]: https://resinos.io/ -[linux]: /hassio/installation/#alternative-install-on-generic-linux-server + \ No newline at end of file diff --git a/source/developers/hassio/debugging.markdown b/source/developers/hassio/debugging.markdown index d9030069a8..be66c18e37 100644 --- a/source/developers/hassio/debugging.markdown +++ b/source/developers/hassio/debugging.markdown @@ -10,46 +10,6 @@ footer: true redirect_from: /hassio/debugging/ --- -

    -This section is not for users. Use the [SSH add-on] to SSH into Hass.io. This is for developers of Hass.io. Do not ask for support if you are using these options. -

    - -[SSH add-on]: /addons/ssh/ - -The following debug tips and tricks are for people who are running the Hass.io image and are working on the base image. If you use the generic Linux installer script, you should be able to access your host and logs as per your host. - -## {% linkable_title SSH access to the host %} - -Create an `authorized_keys` file containing your public key, and place it in the root of the boot partition of your SD card. Once the device is booted, you can access your device as root over SSH on port 22222. - -Windows instructions how to generate and use private/public keys with Putty are [here][windows-keys]. Instead of the droplet instructions, add the public key as per above instructions. - -Alternative instructions, for Mac, Windows and Linux can be found [here](https://help.github.com/articles/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent/#platform-mac). - -Follow steps 1-4 under 'Generating a new SSH key' (The other sections are not applicable to Hass.io and can be ignored.) - -Step 3 in the link above, shows the path to the private key file `id_rsa` for your chosen operating system. Your public key, `id_rsa.pub`, is saved in the same folder. Next, select all text from text box "Public key for pasting into OpenSSH authorized_keys file" and save it to the root of your SD card as `authorized_keys`. - -

    -Make sure when you are copying the public key to the root of the /resin-boot partition of the SD card that you rename the file correctly to `authorized_keys` with no `.pub` file extension. -

    - -You should then be able to SSH into your Hass.io device. On mac/linux, use: -``` -ssh root@hassio.local -p 22222 -``` - -## {% linkable_title Checking the logs %} - -```bash -# Logs from the supervisor service on the Host OS -journalctl -f -u resin-supervisor.service - -# Hass.io supervisor logs -docker logs hassio_supervisor - -# Home Assistant logs -docker logs homeassistant -``` - -[windows-keys]: https://www.digitalocean.com/community/tutorials/how-to-use-ssh-keys-with-putty-on-digitalocean-droplets-windows-users + \ No newline at end of file diff --git a/source/developers/helpers.markdown b/source/developers/helpers.markdown index 4b9e7f59b9..8916b56c68 100644 --- a/source/developers/helpers.markdown +++ b/source/developers/helpers.markdown @@ -9,18 +9,6 @@ sharing: true footer: true --- -There are a bunch of online services which can help you if you are developing for Home Assistant or maintaining components. Some of these are directly connected to Pull Requests and the repositories, while others publish details and updates on our [Discord chat server][discord-devs]. - -- [Coveralls][coveralls] -- [Travis CI][travis-ci] -- [gemnasium][gemnasium] -- [Requires.io][requires-io] -- [Pivotal Tracker][pivotal] - -[coveralls]: https://coveralls.io/github/home-assistant/home-assistant -[travis-ci]: https://travis-ci.org/home-assistant/home-assistant -[gemnasium]: https://gemnasium.com/github.com/home-assistant/home-assistant -[requires-io]: https://requires.io/github/home-assistant/home-assistant/requirements/?branch=dev -[pivotal]: https://www.pivotaltracker.com/n/projects/1250084 - -[discord-devs]: https://discord.gg/8X8DTH4 + \ No newline at end of file diff --git a/source/developers/index.markdown b/source/developers/index.markdown index c801866e6a..3248e7192b 100644 --- a/source/developers/index.markdown +++ b/source/developers/index.markdown @@ -10,17 +10,6 @@ footer: true og_image: /images/architecture/component_interaction.png --- -Welcome to the Home Assistant development documentation. This is the place to learn all about how Home Assistant works and how you can extend it with support for your devices and services! - -

    -Diagram showing interaction between components and the Home Assistant core. -Diagram showing interaction between components and the Home Assistant core. -

    - -The best way to familiarize yourself with Home Assistant is to watch the PyCon 2016 talk about Home Assistant and read through the [Python API docs]. - -
    - -
    - -[Python API docs]: https://dev-docs.home-assistant.io + \ No newline at end of file diff --git a/source/developers/intent/conversation.markdown b/source/developers/intent/conversation.markdown index 38d02fe337..ea4cad2a45 100644 --- a/source/developers/intent/conversation.markdown +++ b/source/developers/intent/conversation.markdown @@ -9,19 +9,6 @@ sharing: true footer: true --- -The conversation component handles incoming commands from the frontend and converts them to intents. It does this based on registered sentences. - -As a component, you can register sentences with the conversation component to allow it to be remote controlled. Refer to named slots by putting the slot name between curly braces: `{item}`. - -Example code: - -```python -@asyncio.coroutine -def async_setup(hass, config): - hass.components.conversation.async_register('MyCoolIntent', [ - 'I think that {object} is very cool', - 'Nothing is cooler than {object}' - ]) -``` - -If a sentence like "I think that beer is very cool" comes in, the conversation component will generate an intent of type `MyCoolIntent` and with 1 slot, named `object` and value `beer`. + \ No newline at end of file diff --git a/source/developers/intent/firing.markdown b/source/developers/intent/firing.markdown index 17e80678b4..b8e10eff20 100644 --- a/source/developers/intent/firing.markdown +++ b/source/developers/intent/firing.markdown @@ -9,51 +9,6 @@ sharing: true footer: true --- -When you fire an intent, you will get a response back or an error will be raised. It is up to the component to return the result to the user. - -Example code to handle an intent in Home Assistant. - -```python -from homeassistant.helpers import intent - -intent_type = 'TurnLightOn' -slots = { - 'entity': { 'value': 'Kitchen' } -} - -try: - intent_response = yield from intent.async_handle( - hass, 'example_component', intent_type, slots - ) - -except intent.UnknownIntent as err: - _LOGGER.warning('Received unknown intent %s', intent_type) - -except intent.InvalidSlotInfo as err: - _LOGGER.error('Received invalid slot data: %s', err) - -except intent.IntentError: - _LOGGER.exception('Error handling request for %s', intent_type) -``` - -The intent response is an instance of `homeassistant.helpers.intent.IntentResponse`. - -| Name | Type | Description | -| ---- | ---- | ----------- | -| `intent` | Intent | Instance of intent that triggered response. | -| `speech` | Dictionary | Speech responses. Each key is a type. Allowed types are `plain` and `ssml`. | -| `card` | Dictionary | Card responses. Each key is a type. | - -Speech dictionary values: - -| Name | Type | Description | -| ---- | ---- | ----------- | -| `speech` | String | The text to say -| `extra_data` | Any | Extra information related to this speech. - -Card dictionary values: - -| Name | Type | Description | -| ---- | ---- | ----------- | -| `title` | String | The title of the card -| `content` | Any | The content of the card + \ No newline at end of file diff --git a/source/developers/intent/handling.markdown b/source/developers/intent/handling.markdown index c341f6ef17..040d2d01dc 100644 --- a/source/developers/intent/handling.markdown +++ b/source/developers/intent/handling.markdown @@ -9,41 +9,6 @@ sharing: true footer: true --- -Any component can register to handle intents. This allows a single component to handle intents fired from multiple voice assistants. - -A component has to register an intent handler for each type that it wants to handle. Intent handlers have to extend `homeassistant.helpers.intent.IntentHandler` - -```python -import asyncio -from homeassistant.helpers import intent - -DATA_KEY = 'example_key' - -@asyncio.coroutine -def async_setup(hass, config): - hass.data[DATA_KEY] = 0 - intent.async_register(hass, CountInvocationIntent()) - - -class CountInvocationIntent(intent.IntentHandler): - """Handle CountInvocationIntent intents.""" - - # Type of intent to handle - intent_type = 'CountInvocationIntent' - - # Optional. A validation schema for slots - # slot_schema = { - # 'item': cv.string - # } - - @asyncio.coroutine - def async_handle(self, intent_obj): - """Handle the intent.""" - intent_obj.hass.data[DATA_KEY] += 1 - - response = intent_obj.create_response() - response.async_set_speech( - "This intent has been invoked {} times".format( - intent_obj.hass.data[DATA_KEY])) - return response -``` + \ No newline at end of file diff --git a/source/developers/intent/index.markdown b/source/developers/intent/index.markdown index a454deecbc..a00395d8a8 100644 --- a/source/developers/intent/index.markdown +++ b/source/developers/intent/index.markdown @@ -9,29 +9,6 @@ sharing: true footer: true --- -An intent is a description of a user's intention. Intents are generated by user actions, like asking Amazon Echo to turn on a light. - -

    - -Architectural overview of intents in Home Assistant -

    - -Intents are fired by components that receive them from external sources/services. Conversation, Alexa, API.ai and Snips are currently sourcing intents. - -Any component can handle intents. This makes it very easy for developers to integrate with all voice assistants at once. - -Intents are implemented using the `homeassistant.helpers.intent.Intent` class. It contains the following properties: - -| Name | Type | Description | -| ---- | ---- | ----------- | -| `hass` | Home Assistant | The Home Assistant instance that fired the intent. -| `platform` | string | The platform that fired the intent -| `intent_type` | string | The type (name) of the intent -| `slots` | dictionary | Contains the slot values keyed by slot name. -| `text_input` | string | Optional. The raw text input that initiated the intent. - -Description of the slots dictionary values. - -| Name | Type | Description | -| ---- | ---- | ----------- | -| Value | anything | Value of the slot. + \ No newline at end of file diff --git a/source/developers/internationalization/backend_localization.markdown b/source/developers/internationalization/backend_localization.markdown index f50d797045..2c2413fc21 100644 --- a/source/developers/internationalization/backend_localization.markdown +++ b/source/developers/internationalization/backend_localization.markdown @@ -10,42 +10,6 @@ footer: true ha_release: 0.64 --- -## {% linkable_title Translation Strings %} -Platform translation strings are stored as JSON in the [home-assistant](https://github.com/home-assistant/home-assistant) repository. These files must be located adjacent to the component/platform they belong to. Components must have their own directory, and the file is simply named `strings.json` in that directory. For platforms, they are named `strings..json` in the platform directory. This file will contain the different strings that will be translatable. - -In order to test changes to translation files, the translation strings must be compiled into Home Assistant’s translation directories by running the following script: - -```bash -$ script/translations_develop -``` - -After the pull request with the strings file is merged into the `dev` branch, the strings will be automatically uploaded to Lokalise, where contributors can submit translations. The translated strings in Lokalise will be periodically pulled in to the home-assistant repository. - -## {% linkable_title States Localization %} -The first step when localizing platform states is to ensure that the states defined in the actual platform code are defined in `snake_case`. The states should not contain capital letters or spaces. Next, the strings file needs to be created. The states should exist under the `state` key, and map the backend state keys to their English translations. [The season sensor localization](https://github.com/home-assistant/home-assistant/pull/12453/commits/bb2f328ce10c3867990e34a88da64e2f8dc7a5c4) is a good example. - -## {% linkable_title Configuration Flow Localization %} -The translation strings for the configuration flow handler are defined under the `config` key. An example strings file below describes the different supported keys: - -```json -{ - "config": { - "title": "This title is shown in the integrations list", - "step": { - "init": { - "title": "The user visible title of the `init` step.", - "description": "Markdown that is shown with the step.", - "data": { - "api_key": "The label for the `api_key` input field" - } - } - }, - "error": { - "invalid_api_key": "This message will be displayed if `invalid_api_key` is returned as a flow error." - }, - "abort": { - "stale_api_key": "This message will be displayed if `stale_api_key` is returned as the abort reason." - } - } -} -``` + \ No newline at end of file diff --git a/source/developers/internationalization/custom_component_localization.markdown b/source/developers/internationalization/custom_component_localization.markdown index b7d12664d4..d0c6ecdc2f 100644 --- a/source/developers/internationalization/custom_component_localization.markdown +++ b/source/developers/internationalization/custom_component_localization.markdown @@ -10,11 +10,6 @@ footer: true ha_release: 0.64 --- -## {% linkable_title Translation Strings %} -Unlike localized strings merged in the home-assistant repository, custom components cannot take advantage of Lokalise for user submitted translations. However, custom component authors can still include translation with their components. These will be read from the `.translations` directory, adjacent to the component source file. They are named `..json`, unless the custom component exists in its own directory, in which case the file is simply named `.json` in the `.translations` directory. - -These files follow the same formatting as [backend translation string files](/developers/internationalization/backend_localization/), but a copy will exist for each translated language. - -The language codes follow the [BCP47](https://tools.ietf.org/html/bcp47) format. The [frontend translation files](https://github.com/home-assistant/home-assistant-polymer/tree/master/translations) can also be referred to if you are unsure of the correct language code to use. - -The frontend will serve these files after Home Assistant is restarted. + \ No newline at end of file diff --git a/source/developers/internationalization/index.markdown b/source/developers/internationalization/index.markdown index 109502fe45..ed93383a94 100644 --- a/source/developers/internationalization/index.markdown +++ b/source/developers/internationalization/index.markdown @@ -10,10 +10,6 @@ footer: true ha_release: 0.64 --- -The Home Assistant internationalization project includes preparing platforms and the frontend for localization, as well as the actual translation of localized strings. - -Some compmonents and platforms will have strings that need to be localized specifically for that platform. These strings are managed in the core [home-assistant](https://github.com/home-assistant/home-assistant) repository. The Home Assistant backend will serve strings to the clients based on the loaded components in the running instance. - -There are also localizable strings that exist only on the frontend. These strings are managed in the [home-assistant-polymer](https://github.com/home-assistant/home-assistant-polymer) repository. These strings are stored with the frontend and don’t depend on the backend configuration. - -Our strings are translated by the community using the online translation tool [Lokalise](https://lokalise.co/). + \ No newline at end of file diff --git a/source/developers/internationalization/translation.markdown b/source/developers/internationalization/translation.markdown index 334a68e6aa..411e5a09cb 100644 --- a/source/developers/internationalization/translation.markdown +++ b/source/developers/internationalization/translation.markdown @@ -11,43 +11,6 @@ ha_release: 0.57 redirect_from: /developers/frontend_translation/ --- -## {% linkable_title How to start %} -Translations for Home Assistant are managed through Lokalise, an online translation management tool. Our translations are split between two projects, a backend project for platform-specific translations, and a frontend project for UI translations. Click the links below to join both projects! Even if your language is completely translated, extra proofreading is a big help! Please feel free to review the existing translations, and vote for alternatives that might be more appropriate. - -- [Join the frontend translation team](https://lokalise.co/signup/3420425759f6d6d241f598.13594006/all/) -- [Join the backend translation team](https://lokalise.co/signup/130246255a974bd3b5e8a1.51616605/all/) - -For more information about the translation workflow, please see the [Lokalise translation workflow documents](https://docs.lokalise.co/category/iOzEuQPS53-for-team-leads-and-translators). - -

    -The translation of the Home Assistant frontend is still a work in progress. More phrases will be available for translation soon. -

    - -## {% linkable_title Translation placeholders %} - -Some translation strings will contain special placeholders that will be replaced later. Placeholders shown in square brackets `[]` are [Lokalise key references](https://docs.lokalise.co/article/KO5SZWLLsy-key-referencing). These are primarily used to link translation strings that will be duplicated. Different languages may not have the same duplicates as English, and are welcome to link duplicate translations that are not linked in English. Placeholders shown in curly brackets `{}` are [translation arguments](https://formatjs.io/guides/message-syntax/) that will be replaced with a live value when Home Assistant is running. Any translation argument placeholders present in the original string must be included in the translated string. These may include special syntax for defining plurals or other replacement rules. The linked format.js guide explains the syntax for adding plural definitions and other rules. - -## {% linkable_title Rules %} -1. Only native speakers should submit translations. -2. Stick to [Material Design guidelines](https://material.io/guidelines/style/writing.html). -3. Don't translate or change proper nouns like `Home Assistant`, `Hass.io` or `Hue`. -4. For a region specific translation, keys that will be the same as the base translation should be filled with `[VOID]`. These will be replaced during our translation build process. -5. Translations under the `state_badge` keys will be used for the notification badge display. These translations should be short enough to fit in the badge label without overflowing. This can be tested in the Home Assistant UI either by editing the label text with your browsers development tools, or by using the States developer tool in the Home Assistant UI. In the UI, enter a new entity ID (`device_tracker.test`), and enter the text you want to test in state. -6. If text will be duplicated across different translation keys, make use of the Lokalise key reference feature where possible. The base translation provides examples of this underneath the `states` translations. Please see the [Lokalise key referencing](https://docs.lokalise.co/article/KO5SZWLLsy-key-referencing) documentation for more details. - -## {% linkable_title Adding a new language %} -If your language is not listed you can request it at [GitHub](https://github.com/home-assistant/home-assistant-polymer/issues/new). Please provide both the English name and the native name for your language. For example: -``` -English Name: German -Native Name: Deutsch -``` - -

    -Region specific translations (`en-US`, `fr-CA`) will only be included if translations for that region need to differ from the base language translation. -

    - -### {% linkable_title Maintainer steps to add a new language %} -1. Language tags have to follow [BCP 47](https://tools.ietf.org/html/bcp47). A list of most language tags can be found here: [IANA sutbtag registry](http://www.iana.org/assignments/language-subtag-registry/language-subtag-registry). Examples: `fr`, `fr-CA`, `zh-Hans`. Only include the country code if country specific overrides are being included, and the base language is already translated. -2. Add the language tag and native name in `src/translations/translationMetadata.json`. Examples: "Français", "Français (CA)" -3. Add the new language in Lokalize. -Note: Sometimes you have to change the tag in Lokalise (Language -> Language settings -> custom ISO code). + \ No newline at end of file diff --git a/source/developers/maintenance.markdown b/source/developers/maintenance.markdown index 4995e7de51..d36bb625a0 100644 --- a/source/developers/maintenance.markdown +++ b/source/developers/maintenance.markdown @@ -9,44 +9,6 @@ sharing: true footer: true --- -This page documents a couple of points for maintaining the Home Assistant code. Most of the tasks don't need to be performed on a regular base thus the steps, used tools, or details are preserved here. - -## {% linkable_title Source code %} - -### {% linkable_title Line separator %} - -People are using various operating systems to develop components and platforms for Home Assistant. This could lead to different line endings on file. We prefer `LN`. Especially Microsoft Windows tools tend to use `CRLF`. - -```bash -$ find homeassistant -name "*.py" -exec file {} \; | grep BOM -$ find homeassistant -name "*.py" -exec file {} \; | grep CRLF -``` - -To fix the line separator, use `dos2unix` or `sed`. - -```bash -$ dos2unix homeassistant/components/notify/kodi.py -``` - -### {% linkable_title File permissions %} - -Most files don't need to the be executable. `0644` is fine. - -### {% linkable_title Dependencies %} - -A lot of components and platforms depends on third-party Python modules. The dependencies which are stored in the `requirements_*.txt` files are tracked by [gemnasium](https://gemnasium.com/github.com/home-assistant/home-assistant) and [Requires.io](https://requires.io/github/home-assistant/home-assistant/requirements/?branch=dev). - -If you update the requirements of a component/platform through the `REQUIREMENTS = ['modules-xyz==0.3']` entry, run the provided script to update the `requirements_*.txt` file(s). - -```bash -$ script/gen_requirements_all.py -``` - -Start a test run of Home Assistant. If that was successful, include all files in a Pull Request. Add a short summary of the changes, a sample configuration entry, details about the tests you performed to ensure the update works, and other useful information to the description. - - -## {% linkable_title Documentation %} - -- Merge `current` into `next` on a regular base. -- Optimize the images. - + \ No newline at end of file diff --git a/source/developers/multiple_instances.markdown b/source/developers/multiple_instances.markdown index f366abe19a..6669c7016d 100644 --- a/source/developers/multiple_instances.markdown +++ b/source/developers/multiple_instances.markdown @@ -9,37 +9,6 @@ sharing: true footer: true --- -# {% linkable_title This has been deprecated and is no longer supported. %} - -Home Assistant supports running multiple synchronized instances using a master-slave model. Whenever `events.fire` or `states.set` is called on the slave it will forward it to the master. The master will replicate all events and changed states to its slaves. - -

    - - - - Overview of the Home Assistant architecture for multiple devices. -

    - -A slave instance can be started with the following code and has the same support for components as a master instance. - -```python -import homeassistant.remote as remote -import homeassistant.bootstrap as bootstrap - -# Location of the Master API: host, password, port. -# Password and port are optional. -remote_api = remote.API("127.0.0.1", "password", 8124) - -# Initialize slave -hass = remote.HomeAssistant(remote_api) - -# To add an interface to the slave on localhost:8123 -bootstrap.setup_component(hass, 'frontend') - -hass.start() -hass.block_till_stopped() -``` - -

    -Because each slave maintains its own Service Registry it is possible to have multiple slaves respond to one service call. -

    + \ No newline at end of file diff --git a/source/developers/platform_example_light.markdown b/source/developers/platform_example_light.markdown index 8a11eec73f..2c067aed37 100644 --- a/source/developers/platform_example_light.markdown +++ b/source/developers/platform_example_light.markdown @@ -9,116 +9,6 @@ sharing: true footer: true --- -This example is for adding support for the imaginary Awesome Lights. It shows the different best practices for developing a platform. - -Similar to Example Sensor Platform, copy the code below, and create it as a file in `/custom_components/light/awesomelights.py`. - -Add the following to your configuration.yaml: - -```yaml -light: - - platform: awesomelights - host: HOST_HERE - username: USERNAME_HERE - password: PASSWORD_HERE_OR_secrets.yaml -``` - -Note the `platform` name matches the filename for the source code. - -```python -import logging - -import voluptuous as vol - -# Import the device class from the component that you want to support -from homeassistant.components.light import ATTR_BRIGHTNESS, Light, PLATFORM_SCHEMA -from homeassistant.const import CONF_HOST, CONF_USERNAME, CONF_PASSWORD -import homeassistant.helpers.config_validation as cv - -# Home Assistant depends on 3rd party packages for API specific code. -REQUIREMENTS = ['awesome_lights==1.2.3'] - -_LOGGER = logging.getLogger(__name__) - -# Validation of the user's configuration -PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend({ - vol.Required(CONF_HOST): cv.string, - vol.Optional(CONF_USERNAME, default='admin'): cv.string, - vol.Optional(CONF_PASSWORD): cv.string, -}) - - -def setup_platform(hass, config, add_devices, discovery_info=None): - """Setup the Awesome Light platform.""" - import awesomelights - - # Assign configuration variables. The configuration check takes care they are - # present. - host = config.get(CONF_HOST) - username = config.get(CONF_USERNAME) - password = config.get(CONF_PASSWORD) - - # Setup connection with devices/cloud - hub = awesomelights.Hub(host, username, password) - - # Verify that passed in configuration works - if not hub.is_valid_login(): - _LOGGER.error("Could not connect to AwesomeLight hub") - return False - - # Add devices - add_devices(AwesomeLight(light) for light in hub.lights()) - - - -class AwesomeLight(Light): - """Representation of an Awesome Light.""" - - def __init__(self, light): - """Initialize an AwesomeLight.""" - self._light = light - self._name = light.name - self._state = None - self._brightness = None - - @property - def name(self): - """Return the display name of this light.""" - return self._name - - @property - def brightness(self): - """Return the brightness of the light. - - This method is optional. Removing it indicates to Home Assistant - that brightness is not supported for this light. - """ - return self._brightness - - @property - def is_on(self): - """Return true if light is on.""" - return self._state - - def turn_on(self, **kwargs): - """Instruct the light to turn on. - - You can skip the brightness part if your light does not support - brightness control. - """ - self._light.brightness = kwargs.get(ATTR_BRIGHTNESS, 255) - self._light.turn_on() - - def turn_off(self, **kwargs): - """Instruct the light to turn off.""" - self._light.turn_off() - - def update(self): - """Fetch new state data for this light. - - This is the only method that should fetch new data for Home Assistant. - """ - self._light.update() - self._state = self._light.is_on() - self._brightness = self._light.brightness -``` + \ No newline at end of file diff --git a/source/developers/platform_example_sensor.markdown b/source/developers/platform_example_sensor.markdown index 166b307117..110ab63137 100644 --- a/source/developers/platform_example_sensor.markdown +++ b/source/developers/platform_example_sensor.markdown @@ -9,58 +9,6 @@ sharing: true footer: true --- -This is a minimum implementation of a platform for the sensor component. - -### {% linkable_title Installation %} - -Copy the code below and create it as a file in `/custom_components/sensor/example.py`. - -Add the following to your `configuration.yaml` file: - -```yaml -# Example configuration.yaml entry -sensor: - platform: example -``` - -### {% linkable_title Code %} - -```python -from homeassistant.const import TEMP_CELSIUS -from homeassistant.helpers.entity import Entity - - -def setup_platform(hass, config, add_devices, discovery_info=None): - """Setup the sensor platform.""" - add_devices([ExampleSensor()]) - - -class ExampleSensor(Entity): - """Representation of a Sensor.""" - - def __init__(self): - """Initialize the sensor.""" - self._state = None - - @property - def name(self): - """Return the name of the sensor.""" - return 'Example Temperature' - - @property - def state(self): - """Return the state of the sensor.""" - return self._state - - @property - def unit_of_measurement(self): - """Return the unit of measurement.""" - return TEMP_CELSIUS - - def update(self): - """Fetch new state data for the sensor. - - This is the only method that should fetch new data for Home Assistant. - """ - self._state = 23 -``` + \ No newline at end of file diff --git a/source/developers/python_api.markdown b/source/developers/python_api.markdown index 818bb8d077..2e3ed1ba29 100644 --- a/source/developers/python_api.markdown +++ b/source/developers/python_api.markdown @@ -9,228 +9,6 @@ sharing: true footer: true --- -See the [developer documentation][devdocs] for a full overview of the documentation. The rest of this page will contain examples on how to use it. - -[devdocs]: https://dev-docs.home-assistant.io/en/master/api/homeassistant.html#module-homeassistant.remote - -In the package [`homeassistant.remote`](https://github.com/home-assistant/home-assistant/blob/master/homeassistant/remote.py) a Python API on top of the [HTTP API](/developers/api/) can be found. If you are not using the [`frontend`](/components/frontend/) in your setup then you need to add the [`api` component](/components/api/) to your `configuration.yaml` file to use the Python Remote API. - -A simple way to get all current entities is to visit the "Set State" page in the "Developer Tools". For the examples below just choose one from the available entries. Here the sensor `sensor.office_temperature` and the switch `switch.livingroom_pin_2` are used. - -First import the module and setup the basics: - -```python -import homeassistant.remote as remote - -api = remote.API('127.0.0.1', 'password') -print(remote.validate_api(api)) -``` - -### {% linkable_title Get configuration %} - -Get the current configuration of a Home Assistant instance: - -```python -import homeassistant.remote as remote - -api = remote.API('127.0.0.1', 'password') - -print(remote.get_config(api)) -``` - -### {% linkable_title Get details about services, events, and entitites %} - -The output from this is similar to the output you'd find via the frontend, using the [Developer Tools](/docs/tools/dev-tools/). - -```python -import homeassistant.remote as remote - -api = remote.API('127.0.0.1', 'YOUR_PASSWORD') - -print('-- Available services:') -services = remote.get_services(api) -for service in services: - print(service['services']) - -print('\n-- Available events:') -events = remote.get_event_listeners(api) -for event in events: - print(event) - -print('\n-- Available entities:') -entities = remote.get_states(api) -for entity in entities: - print(entity) -``` - -### {% linkable_title Get the state of an entity %} - -To get the details of a single entity, use `get_state`: - -```python -import homeassistant.remote as remote - -api = remote.API('127.0.0.1', 'YOUR_PASSWORD') -office_temp = remote.get_state(api, 'sensor.office_temperature') -print('{} is {} {}.'.format( - office_temp.name, office_temp.state, - office_temp.attributes['unit_of_measurement']) -) -``` - -This outputs the details which are stored for this entity, ie: - -```bash -Office Temperature is 19 °C. -``` - -Switches work the same way. The only difference is that both entities have different attributes. - -```python -import homeassistant.remote as remote - -api = remote.API('127.0.0.1', 'YOUR_PASSWORD') -switch_livingroom = remote.get_state(api, 'switch.livingroom_pin_2') -print('{} is {}.'.format( - switch_livingroom.name, switch_livingroom.state) -) -``` - -### {% linkable_title Set the state of an entity %} - -Of course, it's possible to set the state as well: - -```python -import homeassistant.remote as remote -from homeassistant.const import STATE_ON - -api = remote.API('127.0.0.1', 'YOUR_PASSWORD') -remote.set_state(api, 'sensor.office_temperature', new_state=123) -remote.set_state(api, 'switch.livingroom_pin_2', new_state=STATE_ON) -``` - -The state will be set to the new values until the next update occurs. - -### {% linkable_title Blinking all entities of a domain %} - -If you want to turn on all entities of a domain, retrieve the service via `get_services` and act on that: - - -```python -import time -import homeassistant.remote as remote - -api = remote.API('127.0.0.1', 'YOUR_PASSWORD') -domain = 'switch' - -remote.call_service(api, domain, 'turn_on') -time.sleep(10) -remote.call_service(api, domain, 'turn_off') -``` - -### {% linkable_title Control a single entity %} - -To turn on or off a single switch, pass the ID of the entity: - -```python -import time -import homeassistant.remote as remote - -api = remote.API('127.0.0.1', 'YOUR_PASSWORD') -domain = 'switch' -switch_name = 'switch.livingroom_pin_2' - -remote.call_service(api, domain, 'turn_on', {'entity_id': '{}'.format(switch_name)}) -time.sleep(5) -remote.call_service(api, domain, 'turn_off', {'entity_id': '{}'.format(switch_name)}) -``` - -### {% linkable_title Specify a timeout %} - -The default timeout for an API call with `call_service` is 5 seconds. Services -taking longer than this to return will raise -`homeassistant.exceptions.HomeAssistantError: Timeout`, unless provided with a -longer timeout. - -```python -import homeassistant.remote as remote - -api = remote.API('host', 'password') -domain = 'switch' - -# Assuming switch.timeout_switch takes 10 seconds to return -switch_name = 'switch.timeout_switch' - -# Raises homeassistant.exceptions.HomeAssistantError: Timeout when talking to -remote.call_service(api, domain, 'turn_on', {'entity_id': switch_name}) - -# Runs withous exception -remote.call_service(api, domain, 'turn_on', {'entity_id': switch_name}, - timeout=11) -``` - -### {% linkable_title Send a notification %} - -The example uses the Jabber notification platform to send a single message to the given recipient in the `configuration.yaml` file: - -```python -import homeassistant.remote as remote - -api = remote.API('127.0.0.1', 'YOUR_PASSWORD') -domain = 'notify' -data = {"title":"Test", "message":"A simple test message from HA."} - -remote.call_service(api, domain, 'jabber', data) -``` - -## {% linkable_title Examples %} - -This section contains a couple of sample scripts. - -### {% linkable_title List all sensors and their value %} - -If you want to see, export or list all sensor states then an easy way to do it, is to get all entities and filter for the one you are looking for. - -```python -import homeassistant.remote as remote - -api = remote.API('127.0.0.1', 'YOUR_PASSWORD') -entities = remote.get_states(api) -for entity in entities: - if entity.entity_id.startswith('sensor'): - data = remote.get_state(api, entity.entity_id) - print('{}: {}'.format(data.attributes['friendly_name'], data.state)) -``` - -### {% linkable_title Show difference between `last_changed` and `last_updated` %} - -The documentation about the [State Objects](/docs/configuration/state_object/) describes the -`last_changed` and `last_updated` fields. This example shows how it works in practice. - -```python -import time - -from prettytable import PrettyTable -import homeassistant.remote as remote - -api = remote.API('127.0.0.1', 'YOUR_PASSWORD') - -ACTIONS = { - 'Create sensor': [21, 'Test'], - 'No new sensor value': [21, 'Test'], - 'New sensor value': [22, 'Test'], - 'Update attribute': [22, 'Test1'], -} - -output = PrettyTable(['Action', 'Last changed', 'Last updated']) - -for key, value in ACTIONS.items(): - remote.set_state(api, 'sensor.test', new_state=value[0], - attributes={'friendly_name': value[1]}) - data = remote.get_state(api, 'sensor.test') - output.add_row([key, data.last_changed, data.last_updated]) - time.sleep(2) - -print(output) -``` - + \ No newline at end of file diff --git a/source/developers/releasing.markdown b/source/developers/releasing.markdown index 5ddce85418..741aa147d6 100644 --- a/source/developers/releasing.markdown +++ b/source/developers/releasing.markdown @@ -9,66 +9,6 @@ sharing: true footer: true --- -This page describes the steps for publishing a new Home Assistant release. Those steps requires that you don't use forks but work with the repositories themself. The [hass-release](https://github.com/home-assistant/hass-release) script is a helper to do a release. - -### {% linkable_title Release preparation (3 days before release) %} - -### {% linkable_title GitHub %} - -1. Merge `master` into `dev` to make the PR mergeable. -1. Cut a release branch from `dev`. Example name `release-0-57`. -1. Create a pull request from the release branch to `master` with the upcoming release number as the title. -1. Update `homeassistant/const.py` with the correct version number (remove the `dev` tag) and push that commit to release branch. - -### {% linkable_title Website %} - -1. Merge `current` into `next` -1. Cut release branch of `next`. For example `release-0-57`. -1. Open a PR from release branch to `current` with the upcoming release number as the title. - -## {% linkable_title Release day %} - -From creating the release branch till it has been merged, we tag bugfixes with the milestone for the release (create if doesn't exist). - -### {% linkable_title GitHub %} - -1. Cherry-pick the milestoned PRs that need to get into the release `python3 -m hassrelease milestone_cherry_pick 0.57` -1. Run `python3 -m hassrelease release_notes 0.56` for the release notes. -1. Once the release notes has been generated, issue `python3 -m hassrelease milestone_close 0.56` -1. Merge pull request (DO NOT SQUASH!). Use `Merge pull request`. -1. Go to [releases](https://github.com/home-assistant/home-assistant/releases), click `Draft a new release` and tag a new release on the `master` branch. "Tag version" and "Release title" are the version number (`O.x` for major version, `0.x.y` for minor and bug fix releases). Release description is the text from PR. Press "Publish release" to finish the process. -1. Merge `master` into `dev`. -1. Update `homeassistant/const.py` with the upcoming version number (including the `dev` tag) and push that commit to the `dev` branch. - -### {% linkable_title Website %} - -1. Create a blog post in the release branch and base it on the text of the PR in the main repository. Add images, additional text, links, etc. if it adds value. Tag each platform/component in a message to documentation. -1. Create missing documentation as stubs. -1. Run `credits_generator`. -1. Update `_config.yml` with a link to the new release blog post and version number (at the bottom of the file). -1. Merge `current` into release branch (`$ git checkout release-0-40 && git merge current`) to make the PR mergeable. -1. Merge pull request (blog post, updated frontpage, and all new documentation) to `current`. DO NOT SQUASH! -1. Merge `current` into `next`. - -### {% linkable_title Docker Hub %} - -Tags on Docker hub are automatically created when a release has been created on GitHub. - -### {% linkable_title Python Package Index %} - -Checkout the `master` branch and run `script/release` to publish the new release on [Python Package Index](https://pypi.python.org). - -### {% linkable_title Social media %} - -1. Use [hootsuite](https://hootsuite.com/dashboard) to publish a link to the release post on social media. - -## {% linkable_title Bugfix Release %} - -1. Checkout `master` and update it. `git checkout master && git pull --rebase` -1. Create a new release branch from `master`. `git checkout -b release-0-56-2` -1. Cherry-pick the PRs which were milestoned. -1. Update `homeassistant/const.py` with the correct version number (increment `PATCH_VERSION`) and push that commit to release branch. -1. Create a pull request from the release branch to `master` with the upcoming release number as the title. -1. Merge pull request (DO NOT SQUASH!). Use `Merge pull request`. -1. Go to [releases](https://github.com/home-assistant/home-assistant/releases), click `Draft a new release` and tag a new release on the `master` branch. "Tag version" and "Release title" are the version number (`O.x` for major version, `0.x.y` for minor and bug fix releases). Release description is the text from PR. Press "Publish release" to finish the process. -1. [Publish](/developers/releasing/#python-package-index) the new release on PyPI. + \ No newline at end of file diff --git a/source/developers/rest_api.markdown b/source/developers/rest_api.markdown index ec232cac97..83ac65d3b4 100644 --- a/source/developers/rest_api.markdown +++ b/source/developers/rest_api.markdown @@ -9,522 +9,6 @@ sharing: true footer: true --- -Home Assistant runs a web server accessible on port 8123. - -* http://IP_ADDRESS:8123/ is an interface to control Home Assistant. -* http://IP_ADDRESS:8123/api/ is a Rest API. - -The API accepts and returns only JSON encoded objects. All API calls have to be accompanied by the header `X-HA-Access: YOUR_PASSWORD` (YOUR_PASSWORD as specified in your `configuration.yaml` file in the [`http:` section](/components/http/)). - -If you are not using the [`frontend`](/components/frontend/) in your setup then you need to add the [`api` component](/components/api/) to your `configuration.yaml` file. - -There are multiple ways to consume the Home Assistant Rest API. One is with `curl`: - -```bash -curl -X GET \ - -H "x-ha-access: YOUR_PASSWORD" \ - -H "Content-Type: application/json" \ - http://IP_ADDRESS:8123/ENDPOINT -``` - -Another option is to use Python and the [Requests](http://docs.python-requests.org/en/latest/) module. = - -```python -from requests import get - -url = 'http://localhost:8123/ENDPOINT' -headers = {'x-ha-access': 'YOUR_PASSWORD', - 'content-type': 'application/json'} - -response = get(url, headers=headers) -print(response.text) -``` - -

    -You can append `?api_password=YOUR_PASSWORD` to any URL to log in automatically. -

    - -Successful calls will return status code 200 or 201. Other status codes that can return are: - -- 400 (Bad Request) -- 401 (Unauthorized) -- 404 (Not Found) -- 405 (Method not allowed) - -### {% linkable_title Actions %} - -The API supports the following actions: - -#### {% linkable_title GET /api/ %} - -Returns a message if the API is up and running. - -```json -{ - "message": "API running." -} -``` - -Sample `curl` command: - -```bash -$ curl -X GET -H "x-ha-access: YOUR_PASSWORD" \ - -H "Content-Type: application/json" http://localhost:8123/api/ -``` - -#### {% linkable_title GET /api/config %} - -Returns the current configuration as JSON. - -```json -{ - "components":[ - "sensor.cpuspeed", - "frontend", - "config.core", - "http", - "map", - "api", - "sun", - "config", - "discovery", - "conversation", - "recorder", - "group", - "sensor", - "websocket_api", - "automation", - "config.automation", - "config.customize" - ], - "config_dir":"/home/ha/.homeassistant", - "elevation":510, - "latitude":45.8781529, - "location_name":"Home", - "longitude":8.458853651, - "time_zone":"Europe/Zurich", - "unit_system":{ - "length":"km", - "mass":"g", - "temperature":"\u00b0C", - "volume":"L" - }, - "version":"0.56.2", - "whitelist_external_dirs":[ - "/home/ha/.homeassistant/www", - "/home/ha/.homeassistant/" - ] -} -``` - -Sample `curl` command: - -```bash -$ curl -X GET -H "x-ha-access: YOUR_PASSWORD" \ - -H "Content-Type: application/json" http://localhost:8123/api/config -``` - -#### {% linkable_title GET /api/discovery_info %} - -Returns basic information about the Home Assistant instance as JSON. - -```json -{ - "base_url": "http://192.168.0.2:8123", - "location_name": "Home", - "requires_api_password": true, - "version": "0.56.2" -} -``` - -Sample `curl` command: - -```bash -$ curl -X GET -H "x-ha-access: YOUR_PASSWORD" \ - -H "Content-Type: application/json" http://localhost:8123/api/discovery_info -``` - -#### {% linkable_title GET /api/events %} - -Returns an array of event objects. Each event object contains event name and listener count. - -```json -[ - { - "event": "state_changed", - "listener_count": 5 - }, - { - "event": "time_changed", - "listener_count": 2 - } -] -``` - -Sample `curl` command: - -```bash -$ curl -X GET -H "x-ha-access: YOUR_PASSWORD" \ - -H "Content-Type: application/json" http://localhost:8123/api/events -``` - -#### {% linkable_title GET /api/services %} - -Returns an array of service objects. Each object contains the domain and which services it contains. - -```json -[ - { - "domain": "browser", - "services": [ - "browse_url" - ] - }, - { - "domain": "keyboard", - "services": [ - "volume_up", - "volume_down" - ] - } -] -``` - -Sample `curl` command: - -```bash -$ curl -X GET -H "x-ha-access: YOUR_PASSWORD" \ - -H "Content-Type: application/json" http://localhost:8123/api/services -``` - -#### {% linkable_title GET /api/history/period/<timestamp> %} - -Returns an array of state changes in the past. Each object contains further details for the entities. - -The `` (`YYYY-MM-DDThh:mm:ssTZD`) is optional and defaults to 1 day before the time of the request. It determines the beginning of the period. - -You can pass the following optional GET parameters: - -- `filter_entity_id=` to filter on a single entity -- `end_time=` to choose the end of the period in URL encoded format (defaults to 1 day). - -```json -[ - [ - { - "attributes": { - "friendly_name": "Weather Temperature", - "unit_of_measurement": "\u00b0C" - }, - "entity_id": "sensor.weather_temperature", - "last_changed": "2016-02-06T22:15:00+00:00", - "last_updated": "2016-02-06T22:15:00+00:00", - "state": "-3.9" - }, - { - "attributes": { - "friendly_name": "Weather Temperature", - "unit_of_measurement": "\u00b0C" - }, - "entity_id": "sensor.weather_temperature", - "last_changed": "2016-02-06T22:15:00+00:00", - "last_updated": "2016-02-06T22:15:00+00:00", - "state": "-1.9" - }, - ] -] -``` - -Sample `curl` commands: - -```bash -$ curl -X GET -H "x-ha-access: YOUR_PASSWORD" \ - -H "Content-Type: application/json" \ - http://localhost:8123/api/history/period/2016-12-29T00:00:00+02:00 -``` - -```bash -$ curl -X GET -H "x-ha-access: YOUR_PASSWORD" \ - -H "Content-Type: application/json" \ - http://localhost:8123/api/history/period/2016-12-29T00:00:00+02:00?filter_entity_id=sensor.temperature -``` - -```bash -$ curl -X GET -H "x-ha-access: YOUR_PASSWORD" \ - -H "Content-Type: application/json" \ - http://localhost:8123/api/history/period/2016-12-29T00:00:00+02:00?end_time=2016-12-31T00%3A00%3A00%2B02%3A00 -``` - -#### {% linkable_title GET /api/states %} - -Returns an array of state objects. Each state has the following attributes: entity_id, state, last_changed and attributes. - -```json -[ - { - "attributes": {}, - "entity_id": "sun.sun", - "last_changed": "2016-05-30T21:43:32.418320+00:00", - "state": "below_horizon" - }, - { - "attributes": {}, - "entity_id": "process.Dropbox", - "last_changed": "22016-05-30T21:43:32.418320+00:00", - "state": "on" - } -] -``` - -Sample `curl` command: - -```bash -$ curl -X GET -H "x-ha-access: YOUR_PASSWORD" \ - -H "Content-Type: application/json" http://localhost:8123/api/states -``` - -#### {% linkable_title GET /api/states/<entity_id> %} - -Returns a state object for specified entity_id. Returns 404 if not found. - -```json -{ - "attributes":{ - "azimuth":336.34, - "elevation":-17.67, - "friendly_name":"Sun", - "next_rising":"2016-05-31T03:39:14+00:00", - "next_setting":"2016-05-31T19:16:42+00:00" - }, - "entity_id":"sun.sun", - "last_changed":"2016-05-30T21:43:29.204838+00:00", - "last_updated":"2016-05-30T21:50:30.529465+00:00", - "state":"below_horizon" -} -``` - -Sample `curl` command: - -```bash -$ curl -X GET -H "x-ha-access: YOUR_PASSWORD" \ - -H "Content-Type: application/json" \ - http://localhost:8123/api/states/sensor.kitchen_temperature -``` - -#### {% linkable_title GET /api/error_log %} - -Retrieve all errors logged during the current session of Home Assistant as a plaintext response. - -```text -15-12-20 11:02:50 homeassistant.components.recorder: Found unfinished sessions -15-12-20 11:03:03 netdisco.ssdp: Error fetching description at http://192.168.1.1:8200/rootDesc.xml -15-12-20 11:04:36 homeassistant.components.alexa: Received unknown intent HelpIntent -``` - -Sample `curl` command: - -```bash -$ curl -X GET -H "x-ha-access: YOUR_PASSWORD" \ - -H "Content-Type: application/json" \ - http://localhost:8123/api/error_log -``` - -#### {% linkable_title GET /api/camera_proxy/camera.<entity_id> %} - -Returns the data (image) from the specified camera entity_id. - -Sample `curl` command: - -```bash -$ curl -X GET -H "x-ha-access: YOUR_PASSWORD" \ - -H "Content-Type: application/json" \ - http://localhost:8123/api/camera_proxy/camera.my_sample_camera?time=1462653861261 -o image.jpg -``` - -#### {% linkable_title POST /api/states/<entity_id> %} - -Updates or creates the current state of an entity. - -Expects a JSON object that has at least a state attribute: - -```json -{ - "state": "below_horizon", - "attributes": { - "next_rising":"2016-05-31T03:39:14+00:00", - "next_setting":"2016-05-31T19:16:42+00:00" - } -} -``` - -The return code is 200 if the entity existed, 201 if the state of a new entity was set. A location header will be returned with the URL of the new resource. The response body will contain a JSON encoded State object. - -```json -{ - "attributes": { - "next_rising":"2016-05-31T03:39:14+00:00", - "next_setting":"2016-05-31T19:16:42+00:00" - }, - "entity_id": "sun.sun", - "last_changed": "2016-05-30T21:43:29.204838+00:00", - "last_updated": "2016-05-30T21:47:30.533530+00:00", - "state": "below_horizon" -} -``` - -Sample `curl` command: - -```bash -$ curl -X POST -H "x-ha-access: YOUR_PASSWORD" \ - -H "Content-Type: application/json" \ - -d '{"state": "25", "attributes": {"unit_of_measurement": "°C"}}' \ - http://localhost:8123/api/states/sensor.kitchen_temperature -``` - -#### {% linkable_title POST /api/events/<event_type> %} - -Fires an event with event_type - -You can pass an optional JSON object to be used as `event_data`. - -```json -{ - "next_rising":"2016-05-31T03:39:14+00:00", -} -``` - -Returns a message if successful. - -```json -{ - "message": "Event download_file fired." -} -``` - -#### {% linkable_title POST /api/services/<domain>/<service> %} - -Calls a service within a specific domain. Will return when the service has been executed or after 10 seconds, whichever comes first. - -You can pass an optional JSON object to be used as `service_data`. - -```json -{ - "entity_id": "light.Ceiling" -} -``` - -Returns a list of states that have changed while the service was being executed. - -```json -[ - { - "attributes": {}, - "entity_id": "sun.sun", - "last_changed": "2016-05-30T21:43:32.418320+00:00", - "state": "below_horizon" - }, - { - "attributes": {}, - "entity_id": "process.Dropbox", - "last_changed": "22016-05-30T21:43:32.418320+00:00", - "state": "on" - } -] -``` - -Sample `curl` commands: - -Turn the light on: - -```bash -$ curl -X POST -H "x-ha-access: YOUR_PASSWORD" \ - -H "Content-Type: application/json" \ - -d '{"entity_id": "switch.christmas_lights"}' \ - http://localhost:8123/api/services/switch/turn_on -``` - -Send a MQTT message: - -```bash -$ curl -X POST \ - -H "Content-Type: application/json" \ - -H "x-ha-access:YOUR_PASSWORD" \ - -d '{"payload": "OFF", "topic": "home/fridge", "retain": "True"}' \ - http://localhost:8123/api/services/mqtt/publish -``` - -

    -The result will include any states that changed while the service was being executed, even if their change was the result of something else happening in the system. -

    - -#### {% linkable_title POST /api/template %} - -Render a Home Assistant template. [See template docs for more information.](/topics/templating/) - -```json -{ - "template": "Paulus is at {% raw %}{{ states('device_tracker.paulus') }}{% endraw %}!" -} -``` - -Returns the rendered template in plain text. - -```text -Paulus is at work! -``` - -Sample `curl` command: - -```bash -$ curl -X POST -H "x-ha-access: YOUR_PASSWORD" \ - -H "Content-Type: application/json" \ - -d '{"template": "It is {{ now }}!"}' http://localhost:8123/api/template -``` - -#### {% linkable_title POST /api/event_forwarding %} - -Set up event forwarding to another Home Assistant instance. - -Requires a JSON object that represents the API to forward to. - -```javascript -{ - "host": "machine", - "api_password": "my_super_secret_password", - "port": 8880 // optional -} -``` - -It will return a message if event forwarding was set up successfully. - -```json -{ - "message": "Event forwarding setup." -} -``` - -#### {% linkable_title DELETE /api/event_forwarding %} - -Cancel event forwarding to another Home Assistant instance.
    - -Requires a JSON object that represents the API to cancel forwarding to. - -```javascript -{ - "host": "machine", - "api_password": "my_super_secret_password", - "port": 8880 // optional -} -``` - -It will return a message if event forwarding was canceled successfully. - -```json -{ - "message": "Event forwarding cancelled." -} -``` - -

    -If your client does not support DELETE HTTP requests you can add an optional attribute _METHOD and set its value to DELETE. -

    + \ No newline at end of file diff --git a/source/developers/server_sent_events.markdown b/source/developers/server_sent_events.markdown index fc54b168da..62c1d956e6 100644 --- a/source/developers/server_sent_events.markdown +++ b/source/developers/server_sent_events.markdown @@ -9,65 +9,6 @@ sharing: true footer: true --- -The [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events) feature is a one-way channel from your Home Assistant server to a client which is acting as a consumer. For bi-directional communication check the [RESTful API](/developers/rest_api/) and [Python API](/developers/python_api/). - -The URI that is generating the data is `/api/stream`. - -A requirement on the client-side is existing support for the [EventSource](https://developer.mozilla.org/en-US/docs/Web/API/EventSource) interface. - -There are various ways to access the stream. If you have not set an `api_password` in the [`http`](/components/http/) section of your `configuration.yaml` file then you use your modern browser to read the messages. A command-line option is `curl`: - -```bash -$ curl -X GET -H "x-ha-access: YOUR_PASSWORD" \ - -H "Content-Type: application/json" http://localhost:8123/api/stream -``` - -You can create a convenient view for this by creating an HTML file (`sse.html`) in the `www` folder of your Home Assistant configuration directory (`.homeassistant`). Paste this snippet into the file: - -```html - - - -

    Getting Home Assistant server events

    -
    - - - -``` - -Visit [http://localhost:8123/local/sse.html](http://localhost:8123/local/sse.html) to see the stream of events. - -## {% linkable_title Examples %} - -A simple way to consume server-sent events is to use a command-line http client like [httpie](https://httpie.org/). Installation info is on the site (if you use Homebrew, it's `brew install httpie`). Once installed, run this snippet from your terminal: - -```bash -$ http --stream http://localhost:8123/api/stream x-ha-access:YOUR_PASSWORD content-type:application/json -``` - -### {% linkable_title Website %} - -The [home-assistant-sse](https://github.com/fabaff/home-assistant-sse) repository contains a more advanced example. - -### {% linkable_title Python %} - -If you want to test the server-sent events without creating a website, the Python module [`sseclient` ](https://pypi.python.org/pypi/sseclient/) can help. To install (assuming Python and pip3 are already installed): - -```bash -$ pip3 install sseclient -``` - -A simple script to consume SSE in Python looks like this: - -```python -from sseclient import SSEClient - -messages = SSEClient('http://localhost:8123/api/stream?api_password=YOUR_PASSWORD') -for msg in messages: - print(msg) -``` + \ No newline at end of file diff --git a/source/developers/websocket_api.markdown b/source/developers/websocket_api.markdown index 76f7f0b0c7..7e8bf2f9ed 100644 --- a/source/developers/websocket_api.markdown +++ b/source/developers/websocket_api.markdown @@ -9,350 +9,6 @@ sharing: true footer: true --- -Home Assistant contains a WebSocket API. This API can be used to stream information from a Home Assistant instance to any client that implements WebSocket. Implementations in different languages: - -- [JavaScript](https://github.com/home-assistant/home-assistant-js-websocket) - powers the frontend -- [Python](https://raw.githubusercontent.com/home-assistant/home-assistant-dev-helper/master/ha-websocket-client.py) - CLI client using [`asyncws`](https://async-websockets.readthedocs.io/en/latest/) -- [JavaScript/HTML](https://raw.githubusercontent.com/home-assistant/home-assistant-dev-helper/master/ha-websocket.html) - WebSocket connection in your browser - -Connect your websocket implementation to `ws://localhost:8123/api/websocket`. - -If you are not using the [`frontend`](/components/frontend/) in your setup then you need to add the [`websocket_api` component](/components/websocket_api/) to your `configuration.yaml` file to use the WebSocket API. - -## {% linkable_title Server states %} - -1. Client connects. -1. Authentication phase starts. - - If no further authentication necessary for the user: go to 3. - - Server sends `auth_required` message. - - Client sends `auth` message. - - If `auth` message correct: go to 3. - - Server sends `auth_invalid`. Go to 6. -1. Send `auth_ok` message -1. Authentication phase ends. -1. Command phase starts. - 1. Client can send commands. - 1. Server can send results of previous commands. -1. Client or server disconnects session. - -During the command phase, the client attaches a unique identifier to each message. The server will add this identifier to each message so that the client can link each message to its origin. - -## {% linkable_title Message format %} - -Each API message is a JSON serialized object containing a `type` key. After the authentication phase messages also must contain an `id`, an integer that contains the number of interactions. - -Example of an auth message: - -```json -{ - "type": "auth", - "api_password": "supersecret" -} -``` - -```json -{ - "id" 5, - "type":"event", - "event":{ - "data":{}, - "event_type":"test_event", - "time_fired":"2016-11-26T01:37:24.265429+00:00", - "origin":"LOCAL" - } -} -``` - -## {% linkable_title Authentication phase %} - -When a client connects to the server, the server will test if the client is authenticated. Authentication will not be necessary if no api_password is set or if the user fulfills one of the other criteria for authentication (trusted network, password in url/header). - -If no authentication is needed, the authentication phase will complete and the server will send an `auth_ok` message. - -```json -{ - "type": "auth_ok" -} -``` - -If authentication is necessary, the server sends out `auth_required`. - -```json -{ - "type": "auth_required" -} -``` - -This means that the next message from the client should be an auth message: - -```json -{ - "type": "auth", - "api_password": "supersecret" -} -``` - -If the client supplies valid authentication, the authentication phase will complete by the server sending the `auth_ok` message: - -```json -{ - "type": "auth_ok" -} -``` - -If the data is incorrect, the server will reply with `auth_invalid` message and disconnect the session. - -```json -{ - "type": "auth_invalid", - "message": "Invalid password" -} -``` - -## {% linkable_title Command phase %} - -During this phase the client can give commands to the server. The server will respond to each command with a `result` message indicating when the command is done and if it was successful. - -```json -{ - "id": 6. - "type": "result", - "success": true, - // Can contain extra result info - "result": null -} -``` - -## {% linkable_title Subscribe to events %} - -The command `subscribe_events` will subscribe your client to the event bus. You can either listen to all events or to a specific event type. If you want to listen to multiple event types, you will have to send multiple `subscribe_events` commands. - -```json -{ - "id": 18, - "type": "subscribe_events", - // Optional - "event_type": "state_changed" -} -``` - -The server will respond with a result message to indicate that the subscription is active. - -```json -{ - "id": 18, - "type": "result", - "success": true, - "result": null -} -``` - -For each event that matches, the server will send a message of type `event`. The `id` in the message will point at the original `id` of the `listen_event` command. - -```json -{ - "id": 18, - "type":"event", - "event":{ - "data":{ - "entity_id":"light.bed_light", - "new_state":{ - "entity_id":"light.bed_light", - "last_changed":"2016-11-26T01:37:24.265390+00:00", - "state":"on", - "attributes":{ - "rgb_color":[ - 254, - 208, - 0 - ], - "color_temp":380, - "supported_features":147, - "xy_color":[ - 0.5, - 0.5 - ], - "brightness":180, - "white_value":200, - "friendly_name":"Bed Light" - }, - "last_updated":"2016-11-26T01:37:24.265390+00:00" - }, - "old_state":{ - "entity_id":"light.bed_light", - "last_changed":"2016-11-26T01:37:10.466994+00:00", - "state":"off", - "attributes":{ - "supported_features":147, - "friendly_name":"Bed Light" - }, - "last_updated":"2016-11-26T01:37:10.466994+00:00" - } - }, - "event_type":"state_changed", - "time_fired":"2016-11-26T01:37:24.265429+00:00", - "origin":"LOCAL" - } -} -``` - -### {% linkable_title Unsubscribing from events %} - -You can unsubscribe from previously created subscription events. Pass the id of the original subscription command as value to the subscription field. - -```json -{ - "id": 19, - "type": "unsubscribe_events", - "subscription": 18 -} -``` - -The server will respond with a result message to indicate that unsubscribing was successful. - -```json -{ - "id": 19, - "type": "result", - "success": true, - "result": null -} -``` - -### {% linkable_title Calling a service %} - -This will call a service in Home Assistant. Right now there is no return value. The client can listen to `state_changed` events if it is interested in changed entities as a result of a service call. - -```json -{ - "id": 24, - "type": "call_service", - "domain": "light", - "service": "turn_on", - // Optional - "service_data": { - "entity_id": "light.kitchen" - } -} -``` - -The server will indicate with a message indicating that the service is done executing. - -```json -{ - "id": 24, - "type": "result", - "success": true, - "result": null -} -``` - -### {% linkable_title Fetching states %} - -This will get a dump of all the current states in Home Assistant. - -```json -{ - "id": 19, - "type": "get_states" -} -``` - -The server will respond with a result message containing the states. - -```json -{ - "id": 19, - "type": "result", - "success": true, - "result": [ ... ] -} -``` - -### {% linkable_title Fetching config %} - -This will get a dump of the current config in Home Assistant. - -```json -{ - "id": 19, - "type": "get_config" -} -``` - -The server will respond with a result message containing the config. - -```json -{ - "id": 19, - "type": "result", - "success": true, - "result": { ... } -} -``` - -### {% linkable_title Fetching services %} - -This will get a dump of the current services in Home Assistant. - -```json -{ - "id": 19, - "type": "get_services" -} -``` - -The server will respond with a result message containing the services. - -```json -{ - "id": 19, - "type": "result", - "success": true, - "result": { ... } -} -``` - -### {% linkable_title Fetching panels %} - -This will get a dump of the current registered panels in Home Assistant. - -```json -{ - "id": 19, - "type": "get_panels" -} -``` - -The server will respond with a result message containing the current registered panels. - -```json -{ - "id": 19, - "type": "result", - "success": true, - "result": [ ... ] -} -``` - -## {% linkable_title Error handling %} - -If an error occurs, the `success` key in the `result` message will be set to `false`. It will contain an `error` key containing an object with two keys: `code` and `message`. - -| Code | Description | -| ----- | ------------ | -| 1 | A non-increasing identifier has been supplied. -| 2 | Received message is not in expected format (voluptuous validation error). -| 3 | Requested item cannot be found - -```json -{ - "id": 12, - "type":"result", - "success": false, - "error": { - "code": 2, - "message": "Message incorrectly formatted: expected str for dictionary value @ data['event_type']. Got 100" - } -} -``` + \ No newline at end of file diff --git a/source/getting-started/index.markdown b/source/getting-started/index.markdown index 429c6b4cb8..41382d7f35 100644 --- a/source/getting-started/index.markdown +++ b/source/getting-started/index.markdown @@ -18,10 +18,16 @@ Follow this guide if you want to easily get started with Home Assistant, or if y We will need a few things to get started with installing Home Assistant. Links below are linking to Amazon US. If you're not in the US, you should be able to find these items in web stores in your country. - [Raspberry Pi 3 model B](http://a.co/gEfMqL4) + [Power Supply](https://www.raspberrypi.org/help/faqs/#powerReqs) (at least 2.5A) -- [Micro SD Card](http://a.co/gslOydD). Get one that is Class 10 as they are more reliable. Size 32GB or bigger recommended. +- [Micro SD Card](http://a.co/gslOydD). Get one that is Class 10 as they are more reliable. Size 32 GB or bigger recommended. - SD Card reader. Part of most laptops, and also available as [standalone USB sticks](http://a.co/5FCyb0N) (the brand doesn't matter, just pick the cheapest) - Ethernet cable (optional, Hass.io can work with WiFi too) +

    + Support for the Raspberry Pi 3 model B+ is available in the alternative installation method [Hassbian](/docs/hassbian/installation/). + + The recently released Raspberry Pi 3 model B+ is not yet supported by Hass.io. +

    + ### {% linkable_title Software requirements %} - Download [Hass.io image for Raspberry Pi 3][pi3] @@ -29,13 +35,13 @@ We will need a few things to get started with installing Home Assistant. Links b - Text Editor like [Visual Studio Code](https://code.visualstudio.com/) [Etcher]: https://etcher.io/ -[pi3]: https://github.com/home-assistant/hassio-build/releases/download/1.1/resinos-hassio-1.1-raspberrypi3.img.bz2 +[pi3]: https://github.com/home-assistant/hassio-build/releases/download/1.3/resinos-hassio-1.3-raspberrypi3.img.bz2 ### {% linkable_title Installing Hass.io %} 1. Put the SD card in your SD card reader. 1. Open Etcher, select the Hass.io image and flash it to the SD card. -1. WiFi setup only: open the file `system-connections/resin-sample` (from the `resin-boot` volume on the SD card) with a text editor. Change `ssid` to be your network name and `psk` to be your password. Note that the Raspberry Pi 3 is a 2.4GHz WiFi device, so do not try to connect it to a 5GHz network. +1. WiFi setup only: open the file `system-connections/resin-sample` (from the `resin-boot` volume on the SD card) with a text editor. Change `ssid` to be your network name and `psk` to be your password. Note: When connecting to a 5 GHz-only network, make sure your device supports that. If you don't know what that means, then you probably have nothing to worry about. 1. Unmount the SD card and remove it from your SD card reader. 1. Insert the SD card into your Raspberry Pi 3. If you are going to use an Ethernet cable, connect that too. 1. Connect your Raspberry Pi to the power supply so it turns on. diff --git a/source/getting-started/presence-detection.markdown b/source/getting-started/presence-detection.markdown index 6861f89e30..35943263a9 100644 --- a/source/getting-started/presence-detection.markdown +++ b/source/getting-started/presence-detection.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Setting up presence detection" -description: "Instructions how to setup presence detection within Home Assistant." +description: "Instructions on how to setup presence detection within Home Assistant." date: 2015-10-04 12:08 sidebar: true comments: false @@ -25,31 +25,40 @@ Screenshot of Home Assistant showing a school, work and home zone and two people ### {% linkable_title Setting it up %} -The device tracker component offers presence detection for Home Assistant. It supports two different methods for presence detection: scan for connected devices on the local network and connect to third party service. +The device tracker component offers presence detection for Home Assistant. It supports three different methods for presence detection: scan for connected devices on the local network, scan for Bluetooth devices within range, and connect to third-party service. -Scanning for connected devices is easy to setup. See the instructions for our [supported routers][routers] or [scan the network using nmap][nmap]. This approach does have its limitations, however: it will only be able to detect if a device is at home, and iPhones may show as not home inaccurately (as iPhones disconnect from WiFi if idle). +Scanning for connected devices is easy to setup; options include [supported routers][routers] and [scanning the network using nmap][nmap]. This approach does have its limitations, however: it will only be able to detect if a device is at home, and modern smartphones may show as not home inaccurately (as they disconnect from WiFi if idle). -Home Assistant currently supports multiple third-party services for presence detection: [OwnTracks][ha-owntracks], [GPSLogger][ha-gpslogger] and [Locative][ha-locative]. OwnTracks is an app that you install on your iPhone or Android phone that allows you to push the location of your device to Home Assistant using an MQTT broker. An MQTT broker is an Internet of Things communication platform that you can [freely host yourself][mqtt-self] or get [a private instance for free in the cloud](/components/mqtt/#run-your-own). +You can scan for [Bluetooth][ha-bluetooth] and [Bluetooth LE][ha-bluetooth-le] devices. Unlike with WiFi, modern smartphones don't turn off Bluetooth automatically, though the range is lower. -

    -OwnTracks communicates directly with your MQTT broker; no data will pass through their servers. -

    +Home Assistant currently supports multiple third-party services for presence detection, such as [OwnTracks over MQTT][ha-owntracks-mqtt], [OwnTracks over HTTP][ha-owntracks-http] [GPSLogger][ha-gpslogger] and [Locative][ha-locative]. + +There are a wide [range of options][ha-presence] available, both for scanning your local network and third-party services. ### {% linkable_title Zones %} -Home Assistant will know the location of your device if you are using OwnTracks. By [setting up zones][zone] you will be able to add names to the locations of your devices. This way you can easily spot on the state page where the people in your house are and use it as [triggers][trigger] and [conditions][condition] for automation. +Home Assistant will know the location of your device if you are using a device tracker that reports a GPS location (such as OwnTracks, GPS Logger, the iOS app, and others). By [setting up zones][zone] you will be able to add names to the locations of your devices. This way you can easily spot on the state page where the people in your house are and use it as [triggers][trigger] and [conditions][condition] for automation. + +

    +If you're looking at the [map view][ha-map] then any devices in your Home zone won't be visible, this is by design. +

    [routers]: /components/#presence-detection [nmap]: /components/device_tracker.nmap_tracker/ -[ha-owntracks]: /components/device_tracker.owntracks/ +[ha-bluetooth]: /components/device_tracker.bluetooth_tracker/ +[ha-bluetooth-le]: /components/device_tracker.bluetooth_le_tracker/ +[ha-owntracks-mqtt]: /components/device_tracker.owntracks/ +[ha-owntracks-http]: /components/device_tracker.owntracks_http/ [ha-locative]: /components/device_tracker.locative/ [ha-gpslogger]: /components/device_tracker.gpslogger/ +[ha-presence]: /components/#presence-detection [mqtt-self]: /components/mqtt/#run-your-own [mqtt-cloud]: /components/mqtt/#cloudmqtt [zone]: /components/zone/ [trigger]: /getting-started/automation-trigger/#zone-trigger [condition]: /getting-started/automation-condition/#zone-condition +[ha-map]: /components/map/ ### [Next step: Use Home Assistant »](/getting-started/use/) diff --git a/source/hassio/index.markdown b/source/hassio/index.markdown index d53336e89c..a5f4798c8d 100644 --- a/source/hassio/index.markdown +++ b/source/hassio/index.markdown @@ -59,22 +59,62 @@ Hass.io upgrade process from the SSH command line On the SSH command line you can use the `hassio` command to retrieve logs, check the details of connected hardware, and more. -HomeAssistant: -``` $ hassio homeassistant logs - $ hassio homeassistant restart - $ hassio homeassistant stop - $ hassio homeassistant start - $ hassio homeassistant update - $ hassio homeassistant check``` +Home Assistant: + +```bash +$ hassio homeassistant logs +$ hassio homeassistant restart +$ hassio homeassistant stop +$ hassio homeassistant start +$ hassio homeassistant update +$ hassio homeassistant check +``` Host: -``` $ hassio host hardware - $ hassio host reboot - $ hassio host shutdown - $ hassio host update``` + +```bash +$ hassio host hardware +$ hassio host reboot +$ hassio host shutdown +$ hassio host update +``` Supervisor -``` $ hassio supervisor logs - $ hassio supervisor info - $ hassio supervisor reload - $ hassio supervisor update``` + +```bash +$ hassio supervisor logs +$ hassio supervisor info +$ hassio supervisor reload +$ hassio supervisor update +``` + +You can get a better description of the CLI capabilities by typing `hassio help`: + +```bash +NAME: + hassio - Commandline tool to allow interation with hass.io + +USAGE: + hassio [global options] command [command options] [arguments...] + +VERSION: + 1.2.1 + +AUTHOR: + Home-Assistant + +COMMANDS: + homeassistant, ha info, logs, check, restart, start, stop, update + supervisor, su info, logs, reload, update + host, ho hardware, reboot, shutdown, update + network, ne info, options + snapshots, sn list, info, reload, new, restore, remove + addons, ad list, info, logo, changelog, logs, stats, + reload, start, stop, install, uninstall, update + help, h Shows a list of commands or help for one command + +GLOBAL OPTIONS: + --debug, -d Prints Debug information + --help, -h show help + --version, -v print the version +``` diff --git a/source/hassio/installation.markdown b/source/hassio/installation.markdown index 2a26994493..08a2744aed 100644 --- a/source/hassio/installation.markdown +++ b/source/hassio/installation.markdown @@ -11,6 +11,10 @@ footer: true Hass.io images are available for all available Raspberry Pi and Intel NUC platforms. +

    + The recently released Raspberry Pi 3 model B+ is not yet supported. +

    + - Download the appropriate image for your Raspberry Pi / Intel NUC: - [Raspberry Pi / Zero][pi1] - [Raspberry Pi 2][pi2] @@ -26,6 +30,10 @@ Hass.io images are available for all available Raspberry Pi and Intel NUC platfo - You will be able to reach your installation at [http://hassio.local:8123][local]. - Enable either the [Samba add-on][samba] or the [SSH add-on][ssh] to manage your configuration in `/config/` (From the UI choose **Hass.io** which is located in the sidebar). +

    +If your router doesn't support mDNS then you'll have to use the IP address of your Pi, instead of `hassio.local`, for example `http://192.168.0.9:8123`. You should be able to find the IP address of your Pi from the admin interface of your router. +

    +

    Please remember to ensure you're using an [appropriate power supply](https://www.raspberrypi.org/help/faqs/#powerReqs) with your Pi. Mobile chargers may not be suitable since some are designed to only provide the full power with that manufacturer's handsets.

    diff --git a/source/hassio/installing_third_party_addons.markdown b/source/hassio/installing_third_party_addons.markdown index 828ed90e59..0840aa4a69 100644 --- a/source/hassio/installing_third_party_addons.markdown +++ b/source/hassio/installing_third_party_addons.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Installing third-party add-ons" -description: "Instructions how to get started using third-party add-ons." +description: "Instructions on how to get started using third-party add-ons." date: 2017-05-14 13:28 sidebar: true comments: false diff --git a/source/help/index.markdown b/source/help/index.markdown index 12e1dfde02..881204f047 100644 --- a/source/help/index.markdown +++ b/source/help/index.markdown @@ -3,7 +3,7 @@ layout: page title: "Help" description: "If you need help or have a question..." date: 2015-06-25 12:30 -sidebar: false +sidebar: true comments: false sharing: true footer: true @@ -17,18 +17,21 @@ There are various ways to get in touch with the Home Assistant community. It doe - [Discord Chat Server][discord] for general Home Assistant discussions and questions. - Follow us on [Twitter][twitter], use [@home_assistant][twitter] - Join the [Google+ community][google-plus] -- Join the [Reddit subreddit][reddit] in [/r/homeassistant][reddit] +- Join the Reddit in [/r/homeassistant][reddit] ### {% linkable_title Bugs, Feature requests, and alike %} -Have you found an issue in your Home Assistant installation? Please report it. Reporting it makes it easy to track and ensures that it gets fixed. +Have you found an issue in your Home Assistant installation? Please report it. Reporting it makes it easy to track and ensures that it gets fixed. For more details please refer to [Reporting issues](/help/reporting_issues/) page. - [Issue tracker Home Assistant](https://github.com/home-assistant/home-assistant/issues) - [Issue tracker home-assistant.io](https://github.com/home-assistant/home-assistant.io/issues) (Website and documentation) -- [Feature requests Home Assistant](https://community.home-assistant.io/c/feature-requests) +- [Issue tracker Frontend](https://github.com/home-assistant/home-assistant-polymer/issues) (Frontend) +- [Issue tracker Hass.io](https://github.com/home-assistant/hassio/issues) +- [Feature requests Home Assistant](https://community.home-assistant.io/c/feature-requests) (Don't post feature requests in the issue trackers. Thanks.) ### {% linkable_title Videos, talks, workshops and alike %} +- [Automate your home with Home Assistant](https://www.youtube.com/watch?v=SSrgi4iHGbs) at [foss-north 2018](http://foss-north.se/2018/speakers-and-talks.html#jparadies) - March 2018 - [Home Assistant](https://github.com/home-assistant/home-assistant-assets/tree/master/english/2017-qecampX) at QECampX 2017 - October 2017 - [Open Source Heimautomation mit Home Assistant](https://github.com/home-assistant/home-assistant-assets/tree/master/german/2017-maker-faire-zurich) at [Mini Maker Faire Zurich 2017](https://www.makerfairezurich.ch/en/) - September 2017 - [Why we can't have the Internet of Nice Things: A home automation primer](https://www.openwest.org/custom/description.php?id=92) at [OpenWest 2017](https://www.openwest.org) - July 2017 @@ -48,6 +51,7 @@ Looking for [talking points](/help/talking-points/) or [trivia](/help/trivia)? Don't miss the regular [Home Assistant podcasts](https://hasspodcast.io/). +- [HackSpace magazine #6](https://s3-eu-west-1.amazonaws.com/rpi-magazines/issues/full_pdfs/000/000/013/original/HS_6_Digital_Optimised.pdf?1524495009) - May 2018 - [The winners of the Thomas-Krenn-Awards 2018](https://www.thomas-krenn.com/de/tkmag/allgemein/die-gewinner-des-thomas-krenn-awards-2018-stehen-fest/) - March 2018 - [Hausautomations-Schaltzentrale Home Assistant auf Python-Basis](https://www.heise.de/ct/ausgabe/2017-26-Hausautomations-Schaltzentrale-Home-Assistant-3909532.html) - December 2017 - [Using Home Assistant the ARTIK Cloud](https://developer.artik.io/documentation/developer-guide/wireless-iot/hass.html) - September 2017 @@ -75,10 +79,6 @@ Don't miss the regular [Home Assistant podcasts](https://hasspodcast.io/). - [5 open source home automation tools](https://opensource.com/life/16/3/5-open-source-home-automation-tools) by [opensource.com](https://opensource.com) - March 2016 - [Home Assistant – Open Source Python Home Automation Platform](http://www.automatedhome.co.uk/new-products/home-assistant-open-source-python-home-automation-platform.html) - January 2015 -### {% linkable_title Roadmap %} - -There is no explicit roadmap available, but the public [tracker](https://www.pivotaltracker.com/n/projects/1250084) can give you some insight into what is going on. - [forum]: https://community.home-assistant.io/ [twitter]: https://twitter.com/home_assistant [google-plus]: https://plus.google.com/u/0/b/110560654828510104551/communities/106562234893511202708 diff --git a/source/help/reporting_issues.markdown b/source/help/reporting_issues.markdown new file mode 100644 index 0000000000..d2290788c5 --- /dev/null +++ b/source/help/reporting_issues.markdown @@ -0,0 +1,72 @@ +--- +layout: page +title: "Reporting issues" +description: "Reporting issues about Home Assistant" +date: 2018-03-26 09:00 +sidebar: false +comments: false +sharing: true +footer: true +--- + +If you have an installation, a setup or a configuration issue please use our [Forum](https://community.home-assistant.io/) to get help. We have a big community which will help you if they can. + +If you found a bug then please report it in one of our [trackers](/help/#bugs-feature-requests-and-alike). To help you and our developers to identify the issue quickly, please fill out the provided template. The "weird" content you will see is there to render your entry in a nice format after submitting. It's just [markddown](https://guides.github.com/features/mastering-markdown/). + +Use the command below to get the Home Assistant release you are running from a command-line. + +```bash +$ hass --version +``` + +Otherwise check the **About** page which is accessible in the **Developer tools** of the Home Assistant frontend. + +### {% linkable_title First Home Assistant release with the issue %} + +Please provide the release which contains the issue. + +### {% linkable_title Last working Home Assistant release (if known) %} + +If possible, provide the latest release of which you know that the component or platform was working. Home Assistant is evolving very fast and issues may already be addressed or be introduced by a recent change. + +### {% linkable_title Operating environment (Hass.io/Docker/Windows/etc.) %} + +There are many different ways to run Home Assistant. In this section please mention which you are using, e.g. manual installation, [Hass.io](/hassio/), Hasbian or as container (Docker). It can help if you mention which operating system you are using because not all are supported on the same level. + +### {% linkable_title Component/platform %} + +Please add the link to the documention of the component/platform in question. E.g., + +- issue with the `random` sensor: [https://www.home-assistant.io/components/sensor.random/](/components/sensor.random/) +- issue with the `hue` component: [https://www.home-assistant.io/components/hue/](/components/hue/) + +### {% linkable_title Description of problem %} + +Provide a summary of your issue and tell us what's wrong. + +There are components and platform which require additional steps (installing third-party tools, compilers, etc.) to get your setup working. Please describe the steps you took and the ones to reproduce the issue if needed. + +### {% linkable_title Problem-relevant `configuration.yaml` entries %} + +To exclude configuration issues and allow the developers to quickly test, and perhaps reproduce, your issue, add the relevant part of your `configuration.yaml` file. This file is located in your [configuration folder](/docs/configuration/). + +```yaml +sensor: + - platform: random +``` + +Make sure that you don't post your username, password, API key, access token or other [secrets](/docs/configuration/secrets/). + +### {% linkable_title Traceback (if applicable) %} + +If things go wrong there will be a so-called traceback or an error message in other words in your log. Please include this. It starts with **Traceback** and can contain informations where the error was triggered in the code. + +```bash +Traceback (most recent call last): +... +``` + +### {% linkable_title Additional information %} + +This section can contain additional details or other observation. Often the little things can help as well. + diff --git a/source/help/trivia.markdown b/source/help/trivia.markdown index 6d033a243d..f4a91f4a66 100644 --- a/source/help/trivia.markdown +++ b/source/help/trivia.markdown @@ -17,7 +17,7 @@ Isn't it obvious? Home Assistant is the good soul that is assisting you in your ### {% linkable_title Website %} -The website [https://home-assistant.io](https://home-assistant.io) was launched on December 18, 2014 and contains documentation about the setup process, the platforms and components, and for the developers. +The website [https://www.home-assistant.io](/) was launched on December 18, 2014 and contains documentation about the setup process, the platforms and components, and for the developers. ### {% linkable_title Logo %} @@ -38,7 +38,7 @@ This sections just contains some random numbers of the Home Assistant eco-system | [Forum members](https://community.home-assistant.io/) | 92 | 3931 | 16663 | | [Github stars](https://github.com/home-assistant/home-assistant/stargazers) | 2519 | 5239 | 12074 | | [Github forks](https://github.com/home-assistant/home-assistant/network) | 374 | 1424 | 3474 | -| Page views [ha.io](https://home-assistant.io) | 600,372 | 6,614,343 | 23,727,481 | +| Page views [ha.io](/) | 600,372 | 6,614,343 | 23,727,481 | ### {% linkable_title Commit per year %} diff --git a/source/images/blog/2018-03-0.66/components.png b/source/images/blog/2018-03-0.66/components.png new file mode 100644 index 0000000000..890a4b8512 Binary files /dev/null and b/source/images/blog/2018-03-0.66/components.png differ diff --git a/source/images/blog/2018-03-fedora-atomic/social.png b/source/images/blog/2018-03-fedora-atomic/social.png new file mode 100644 index 0000000000..c6bf2a202b Binary files /dev/null and b/source/images/blog/2018-03-fedora-atomic/social.png differ diff --git a/source/images/blog/2018-03-release-schedule/release-schedule-diagram.png b/source/images/blog/2018-03-release-schedule/release-schedule-diagram.png new file mode 100644 index 0000000000..a55075f53e Binary files /dev/null and b/source/images/blog/2018-03-release-schedule/release-schedule-diagram.png differ diff --git a/source/images/blog/2018-03-release-schedule/social.png b/source/images/blog/2018-03-release-schedule/social.png new file mode 100644 index 0000000000..7444977694 Binary files /dev/null and b/source/images/blog/2018-03-release-schedule/social.png differ diff --git a/source/images/blog/2018-04-0.67/components.png b/source/images/blog/2018-04-0.67/components.png new file mode 100644 index 0000000000..798602b5c1 Binary files /dev/null and b/source/images/blog/2018-04-0.67/components.png differ diff --git a/source/images/blog/2018-04-0.68/components.png b/source/images/blog/2018-04-0.68/components.png new file mode 100644 index 0000000000..57d9fc40b3 Binary files /dev/null and b/source/images/blog/2018-04-0.68/components.png differ diff --git a/source/images/blog/2018-04-developer-website/screenshot.png b/source/images/blog/2018-04-developer-website/screenshot.png new file mode 100644 index 0000000000..faccecea64 Binary files /dev/null and b/source/images/blog/2018-04-developer-website/screenshot.png differ diff --git a/source/images/blog/2018-04-google-assistant/google-assistant-home-assistant.png b/source/images/blog/2018-04-google-assistant/google-assistant-home-assistant.png new file mode 100644 index 0000000000..a7ec721fbc Binary files /dev/null and b/source/images/blog/2018-04-google-assistant/google-assistant-home-assistant.png differ diff --git a/source/images/blog/2018-04-hassio-2018/blogpost.png b/source/images/blog/2018-04-hassio-2018/blogpost.png new file mode 100644 index 0000000000..443fb8a540 Binary files /dev/null and b/source/images/blog/2018-04-hassio-2018/blogpost.png differ diff --git a/source/images/blog/2018-04-ubiquiti-and-home-assistant/paulus.jpg b/source/images/blog/2018-04-ubiquiti-and-home-assistant/paulus.jpg new file mode 100644 index 0000000000..2a4e3d885f Binary files /dev/null and b/source/images/blog/2018-04-ubiquiti-and-home-assistant/paulus.jpg differ diff --git a/source/images/screenshots/binary_sensor_classes_icons.png b/source/images/screenshots/binary_sensor_classes_icons.png new file mode 100644 index 0000000000..53363bcb99 Binary files /dev/null and b/source/images/screenshots/binary_sensor_classes_icons.png differ diff --git a/source/images/screenshots/get_trafikverket_weather_station_example.png b/source/images/screenshots/get_trafikverket_weather_station_example.png new file mode 100644 index 0000000000..fd0d7535fe Binary files /dev/null and b/source/images/screenshots/get_trafikverket_weather_station_example.png differ diff --git a/source/images/screenshots/hello-world-state-card.png b/source/images/screenshots/hello-world-state-card.png new file mode 100644 index 0000000000..9b1f5cbc0a Binary files /dev/null and b/source/images/screenshots/hello-world-state-card.png differ diff --git a/source/images/screenshots/sensor_device_classes_icons.png b/source/images/screenshots/sensor_device_classes_icons.png new file mode 100644 index 0000000000..58e115250c Binary files /dev/null and b/source/images/screenshots/sensor_device_classes_icons.png differ diff --git a/source/images/supported_brands/asterisk.png b/source/images/supported_brands/asterisk.png new file mode 100644 index 0000000000..b8d8a1a123 Binary files /dev/null and b/source/images/supported_brands/asterisk.png differ diff --git a/source/images/supported_brands/eufy.png b/source/images/supported_brands/eufy.png new file mode 100644 index 0000000000..98d647b056 Binary files /dev/null and b/source/images/supported_brands/eufy.png differ diff --git a/source/images/supported_brands/foobot.png b/source/images/supported_brands/foobot.png new file mode 100644 index 0000000000..2d502c2cda Binary files /dev/null and b/source/images/supported_brands/foobot.png differ diff --git a/source/images/supported_brands/gogogate2.png b/source/images/supported_brands/gogogate2.png new file mode 100644 index 0000000000..551043f64a Binary files /dev/null and b/source/images/supported_brands/gogogate2.png differ diff --git a/source/images/supported_brands/mastodon.png b/source/images/supported_brands/mastodon.png new file mode 100644 index 0000000000..7a156e5b81 Binary files /dev/null and b/source/images/supported_brands/mastodon.png differ diff --git a/source/images/supported_brands/nanoleaf_aurora_light.png b/source/images/supported_brands/nanoleaf_aurora_light.png new file mode 100644 index 0000000000..fb14d4752f Binary files /dev/null and b/source/images/supported_brands/nanoleaf_aurora_light.png differ diff --git a/source/images/supported_brands/postnl.png b/source/images/supported_brands/postnl.png new file mode 100644 index 0000000000..93d54db18c Binary files /dev/null and b/source/images/supported_brands/postnl.png differ diff --git a/source/images/supported_brands/qwikswitch.png b/source/images/supported_brands/qwikswitch.png index ada6158b54..0109f03a35 100644 Binary files a/source/images/supported_brands/qwikswitch.png and b/source/images/supported_brands/qwikswitch.png differ diff --git a/source/images/supported_brands/sensirion.png b/source/images/supported_brands/sensirion.png new file mode 100644 index 0000000000..4c0576cacd Binary files /dev/null and b/source/images/supported_brands/sensirion.png differ diff --git a/source/images/supported_brands/sigfox.png b/source/images/supported_brands/sigfox.png new file mode 100644 index 0000000000..fdc7200ec8 Binary files /dev/null and b/source/images/supported_brands/sigfox.png differ diff --git a/source/images/supported_brands/socialblade.png b/source/images/supported_brands/socialblade.png new file mode 100644 index 0000000000..3e2de38de2 Binary files /dev/null and b/source/images/supported_brands/socialblade.png differ diff --git a/source/images/supported_brands/stride.png b/source/images/supported_brands/stride.png new file mode 100644 index 0000000000..ec9825c808 Binary files /dev/null and b/source/images/supported_brands/stride.png differ diff --git a/source/images/supported_brands/trafikverket.png b/source/images/supported_brands/trafikverket.png new file mode 100644 index 0000000000..d39df442c8 Binary files /dev/null and b/source/images/supported_brands/trafikverket.png differ diff --git a/source/images/supported_brands/uscis.png b/source/images/supported_brands/uscis.png new file mode 100644 index 0000000000..2268fb48b1 Binary files /dev/null and b/source/images/supported_brands/uscis.png differ diff --git a/source/images/supported_brands/vesync.png b/source/images/supported_brands/vesync.png new file mode 100644 index 0000000000..72aba90413 Binary files /dev/null and b/source/images/supported_brands/vesync.png differ diff --git a/source/images/supported_brands/waze.png b/source/images/supported_brands/waze.png new file mode 100755 index 0000000000..927614e0c8 Binary files /dev/null and b/source/images/supported_brands/waze.png differ diff --git a/source/images/supported_brands/zillow.png b/source/images/supported_brands/zillow.png new file mode 100644 index 0000000000..49a3147b78 Binary files /dev/null and b/source/images/supported_brands/zillow.png differ diff --git a/source/index.html b/source/index.html index 11729ac796..234bf17108 100644 --- a/source/index.html +++ b/source/index.html @@ -41,6 +41,14 @@ description: Open-source home automation platform running on Python 3. Track and LEARN MORE +
    +

    Ok Google, turn on the AC

    + Use Google Assistant to control Home Assistant. + +
    + LEARN MORE +
    +
    Read our founder's vision for the perfect home automation