diff --git a/Gemfile b/Gemfile index 497d6782b05..a4def8f3734 100644 --- a/Gemfile +++ b/Gemfile @@ -15,7 +15,7 @@ end group :jekyll_plugins do gem 'jekyll-paginate', '1.1.0' gem 'jekyll-sitemap', '1.4.0' - gem 'jekyll-commonmark', '1.3.1' + gem 'jekyll-commonmark', '1.4.0' gem 'jekyll-toc', '0.17.1' end diff --git a/Gemfile.lock b/Gemfile.lock index bd0d7ed1574..6dfce616665 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -5,8 +5,7 @@ GEM public_suffix (>= 2.0.2, < 5.0) chunky_png (1.4.0) colorator (1.1.0) - commonmarker (0.21.2) - ruby-enum (~> 0.5) + commonmarker (0.23.2) compass (1.0.3) chunky_png (~> 1.2) compass-core (~> 1.0.2) @@ -29,7 +28,7 @@ GEM ffi (1.15.5-x64-mingw32) forwardable-extended (2.6.0) http_parser.rb (0.8.0) - i18n (1.8.11) + i18n (1.9.1) concurrent-ruby (~> 1.0) jekyll (4.2.1) addressable (~> 2.4) @@ -46,16 +45,13 @@ GEM rouge (~> 3.0) safe_yaml (~> 1.0) terminal-table (~> 2.0) - jekyll-commonmark (1.3.1) - commonmarker (~> 0.14) - jekyll (>= 3.7, < 5.0) + jekyll-commonmark (1.4.0) + commonmarker (~> 0.22) jekyll-paginate (1.1.0) jekyll-sass-converter (2.1.0) sassc (> 2.0.1, < 3.0) jekyll-sitemap (1.4.0) jekyll (>= 3.7, < 5.0) - jekyll-time-to-read (0.1.2) - jekyll jekyll-toc (0.17.1) jekyll (>= 3.9) nokogiri (~> 1.11) @@ -92,8 +88,6 @@ GEM ffi (~> 1.0) rexml (3.2.5) rouge (3.27.0) - ruby-enum (0.9.0) - i18n ruby2_keywords (0.0.5) safe_yaml (1.0.5) sass (3.4.25) @@ -125,10 +119,9 @@ PLATFORMS DEPENDENCIES compass (= 1.0.3) jekyll (= 4.2.1) - jekyll-commonmark (= 1.3.1) + jekyll-commonmark (= 1.4.0) jekyll-paginate (= 1.1.0) jekyll-sitemap (= 1.4.0) - jekyll-time-to-read (= 0.1.2) jekyll-toc (= 0.17.1) nokogiri (= 1.13.1) rake (= 13.0.6) diff --git a/source/_docs/automation/templating.markdown b/source/_docs/automation/templating.markdown index 087f62be019..86c3cdac8af 100644 --- a/source/_docs/automation/templating.markdown +++ b/source/_docs/automation/templating.markdown @@ -112,7 +112,7 @@ The following describes trigger data associated with all platforms. | ---- | ---- | | `trigger.platform` | Hardcoded: `webhook` | `trigger.webhook_id` | The webhook ID that was triggered. -| `trigger.json` | The JSON data of the request (if it had a JSON content type). +| `trigger.json` | The JSON data of the request (if it had a JSON content type) as a mapping. | `trigger.data` | The form data of the request (if it had a form data content type). | `trigger.query` | The URL query parameters of the request (if provided). diff --git a/source/_docs/configuration/customizing-devices.markdown b/source/_docs/configuration/customizing-devices.markdown index 53c452358f2..b6cb236fa66 100644 --- a/source/_docs/configuration/customizing-devices.markdown +++ b/source/_docs/configuration/customizing-devices.markdown @@ -9,8 +9,10 @@ You can use the UI to change the entity ID and friendly name of supported entiti 1. Select the entity, either from the frontend or by clicking the info button next to the entity in the Developer Tools "States" tab. 2. Click on the cog icon in the right corner of the entity's dialog +![Entity dialog box.](/images/docs/configuration/customizing-entity-dialog.png) 3. Enter the new name or the new entity ID (remember not to change the domain of the entity - the part before the `.`) -4. Select *Save* +![Settings for entity.](/images/docs/configuration/customizing-entity.png) +4. Select *Update* If your entity is not supported, or you cannot customize what you need via this method, please see below for more options. diff --git a/source/_integrations/fitbit.markdown b/source/_integrations/fitbit.markdown index cde394404a6..d9ed0307daf 100644 --- a/source/_integrations/fitbit.markdown +++ b/source/_integrations/fitbit.markdown @@ -12,6 +12,8 @@ ha_platforms: The Fitbit sensor allows you to expose data from [Fitbit](https://fitbit.com/) to Home Assistant. +Prior to enabling the sensor, your Home Assistant instance must be enabled with SSL, using services such as [Home Assistant cloud](/cloud/) or [Duck DNS](/integrations/duckdns/) integrating Let's Encrypt. Fitbit will not allow insecure integrations. Your Fitbit account must also be registered as an Developer account at the [Fitbit Developer Portal](https://dev.fitbit.com), and have a verified email address. + Enable the sensor by adding the following to your `configuration.yaml` file: ```yaml @@ -23,7 +25,7 @@ sensor: - "body/weight" ``` -Restart Home Assistant once this is complete. Go to the frontend. You will see a new entry for configuring Fitbit. Follow the instructions there to complete the setup process. +Restart Home Assistant once this is complete. Go to the frontend. You will see a new notification for configuring Fitbit. Follow the instructions there to complete the setup process. You will need to visit this notification multiple times to set your API keys and authorize your custom app with your Fitbit account. Please be aware that Fitbit has very low rate limits, 150 per user per hour. The clock resets at the _top_ of the hour (meaning it is not a rolling 60 minutes). There is no way around the limits. Due to the rate limits, the sensor only updates every 30 minutes. You can manually trigger an update by restarting Home Assistant. Keep in mind that 1 request is used for every entry in `monitored_resources`. diff --git a/source/_integrations/motion_blinds.markdown b/source/_integrations/motion_blinds.markdown index a79e894cc2f..95e76aad985 100644 --- a/source/_integrations/motion_blinds.markdown +++ b/source/_integrations/motion_blinds.markdown @@ -14,11 +14,11 @@ ha_platforms: - sensor --- -The integration allows you to control [Motion Blinds](https://motion-blinds.com) from [Coulisse B.V.](https://coulisse.com/products/motion). +The integration allows you to control [Motion Blinds](https://motionblinds.com/) from [Coulisse B.V.](https://coulisse.com/). Additionally the following brands have been reported to also work with this integration: -- [Motion Blinds](https://motion-blinds.com) +- [Motion Blinds](https://motionblinds.com/) - [Dooya](http://www.dooya.com/) - [Bloc Blinds](https://www.blocblinds.com/) - [Brel Home](https://www.brel-home.nl/) diff --git a/source/_integrations/nanoleaf.markdown b/source/_integrations/nanoleaf.markdown index 24344ae1f02..9621ee05500 100644 --- a/source/_integrations/nanoleaf.markdown +++ b/source/_integrations/nanoleaf.markdown @@ -23,3 +23,7 @@ The Nanoleaf integration allows you to control and monitor Nanoleaf Light Panels This integration does not support the Nanoleaf Remote and Essentials lights. {% include integrations/config_flow.md %} + +# Transition and brightness + +When using a transition in service calls (such as `light.turn_on`), the transition is only applied to brightness and does not apply to color. When a service call has a transition set but no brightness is included, the light will automatically transition to 100% brightness. diff --git a/source/_integrations/ness_alarm.markdown b/source/_integrations/ness_alarm.markdown index f85de8060b0..1ff866339f7 100644 --- a/source/_integrations/ness_alarm.markdown +++ b/source/_integrations/ness_alarm.markdown @@ -21,7 +21,7 @@ There is currently support for the following device types within Home Assistant: - Binary Sensor: Reports on zone statuses - Alarm Control Panel: Reports on alarm status, and can be used to arm/disarm the system -The module communicates via the [Ness D8x/D16x ASCII protocol](http://www.nesscorporation.com/Software/Ness_D8-D16_ASCII_protocol.pdf). +The module communicates via the [Ness D8x/D16x ASCII protocol](https://ia601401.us.archive.org/34/items/ness-d-8x-d-16x-serial-interface.-ascii-protocol/Ness%20D8x%20D16x%20Serial%20Interface.%20ASCII%20Protocol.pdf). ## Configuration diff --git a/source/_integrations/rest.markdown b/source/_integrations/rest.markdown index 7e1dde07cd4..085d1d3601c 100644 --- a/source/_integrations/rest.markdown +++ b/source/_integrations/rest.markdown @@ -156,6 +156,11 @@ params: description: The query params for the requests. required: false type: [list, template] +scan_interval: + description: Define the refrequency to call the REST endpoint in seconds. + required: false + type: integer + default: 30 sensor: description: A list of [RESTful Sensor](/integrations/sensor.rest) to create from the shared data. All configuration settings that the supported by [RESTful Sensor](/integrations/sensor.rest#configuration-variables) not listed above can be used here. required: false diff --git a/source/_integrations/sonos.markdown b/source/_integrations/sonos.markdown index 2cdea4e003e..b7f846762b3 100644 --- a/source/_integrations/sonos.markdown +++ b/source/_integrations/sonos.markdown @@ -261,6 +261,12 @@ action: {% endraw %} +## Network requirements + +To work optimally, the Sonos devices must be able to connect back to the Home Assistant host on TCP port 1400. This will allow the push-based updates to work properly. If this port is blocked or otherwise unreachable from the Sonos devices, the integration will fall back to a polling mode which is slower to update and much less efficient. The integration will alert the user if this problem is detected. + +See [Advanced use](#advanced-use) below for additional configuration options which may be needed to address this issue in setups with more complex network topologies. + ## Advanced use For advanced uses, there are some manual configuration options available. These are usually only needed if you have a complex network setup where Home Assistant and Sonos are not on the same subnet. @@ -277,7 +283,7 @@ sonos: - 192.0.2.27 ``` -If your Home Assistant instance has multiple IP addresses, you can enable the IP address that should be used for Sonos auto-discovery with the [Network](/integrations/network/) integration. This should only be necessary if the Sonos speakers are on a network segment not reachable from the default interface. +If your Home Assistant instance has multiple IP addresses, you can select the specific IP address that should be used for Sonos auto-discovery with the [Network](/integrations/network/) integration. This should only be necessary if the Sonos speakers are on a network segment not reachable from the default interface. The Sonos speakers will attempt to connect back to Home Assistant to deliver change events. By default, Home Assistant will listen on port 1400 but will try the next 100 ports above 1400 if it is in use. You can change the IP address that Home Assistant advertises to Sonos speakers. This can help in NAT scenarios such as when _not_ using the Docker option `--net=host`: diff --git a/source/_integrations/spotify.markdown b/source/_integrations/spotify.markdown index 99361354f57..9c03cea9f6c 100644 --- a/source/_integrations/spotify.markdown +++ b/source/_integrations/spotify.markdown @@ -20,13 +20,29 @@ The Spotify media player integration allows you to control [Spotify](https://www ## Prerequisites - Spotify account -- Spotify application configured for Home Assistant (see [below](#create-a-spotify-application)) +- (Optional) Spotify developer application configured for Home Assistant (see [below](#create-a-spotify-application))
Spotify integrated media controls (pause, play, next, etc.) require a Premium account. If you do not have a Premium account, the frontend will not show the controls.
+{% include integrations/config_flow.md %} + +Unless configured otherwise, Home Assistant will use account linking provided by +Nabu Casa for authenticating with Spotify. If this is not working or you don't +want to use it, follow the steps for configuring a [developer appliaction](#create-a-spotify-application) +before configuring Spotify. + +
+ + If you receive an `INVALID_CLIENT: Invalid redirect URI` error while trying to + authenticate with your Spotify account, check the Redirect URI in + the address bar after adding the new integration. Compare this value with the + Redirect URI defined in the Spotify Developer Portal. + +
+ ### Create a Spotify application - Login to [Spotify Developer](https://developer.spotify.com) via Dashboard. @@ -67,17 +83,6 @@ client_secret: Restart your Home Assistant instance before continuing with the next step. -{% include integrations/config_flow.md %} - -
- - If you receive an `INVALID_CLIENT: Invalid redirect URI` error while trying to - authenticate with your Spotify account, check the Redirect URI in - the address bar after adding the new integration. Compare this value with the - Redirect URI defined in the Spotify Developer Portal. - -
- ## Using multiple Spotify accounts This integration supports multiple Spotify accounts at once. You don't need to diff --git a/source/_integrations/ted5000.markdown b/source/_integrations/ted5000.markdown index 089812d318d..84b74e0bd9d 100644 --- a/source/_integrations/ted5000.markdown +++ b/source/_integrations/ted5000.markdown @@ -10,7 +10,7 @@ ha_platforms: - sensor --- -The `ted 5000` monitors electricity consumption/production by connecting to the [TED](https://www.theenergydetective.com/home) gateway, itself connected to one or several Measuring Transmitting Units (MTU). The platform creates up to two sensors per MTU, one for Wattage the other for Voltage. +The `ted 5000` monitors electricity consumption/production by connecting to the [TED](https://www.theenergydetective.com/) gateway, itself connected to one or several Measuring Transmitting Units (MTU). The platform creates up to two sensors per MTU, one for Wattage the other for Voltage. If you want to enable the ted5000 sensor, add the following lines to your `configuration.yaml`: diff --git a/source/_integrations/template.markdown b/source/_integrations/template.markdown index b192e36fccc..9c6ff692538 100644 --- a/source/_integrations/template.markdown +++ b/source/_integrations/template.markdown @@ -175,6 +175,7 @@ number: description: Template for the number's current value. required: true type: template + set_value: description: Defines actions to run when the number value changes. The variable `value` will contain the number entered. required: true type: action diff --git a/source/_integrations/tuya.markdown b/source/_integrations/tuya.markdown index 60fba6ba8fc..8bf651a4ab3 100644 --- a/source/_integrations/tuya.markdown +++ b/source/_integrations/tuya.markdown @@ -44,7 +44,7 @@ ha_platforms: ha_dhcp: true --- -The Tuya integration integrates all Powered by Tuya devices you have added to the Tuya Smart and Tuya Smart Life apps. Tuya officially maintains this integration. +The Tuya integration integrates all Powered by Tuya devices you have added to the Tuya Smart and Tuya Smart Life apps. All Home Assistant platforms are supported by the Tuya integration, except the lock and remote platform. @@ -147,6 +147,10 @@ Click the created project to enter the `Project Overview` page and get the `Auth {% endconfiguration_basic %} +## Scenes + +Tuya supports scenes in their app. These allow triggering some of the more complex modes of various devices such as light changing effects. Scenes created in the Tuya app will automatically appear in the Scenes list in Home Assistant the next time the integration updates. + ## Related Documents - [Tuya Integration Documentation Page](https://github.com/tuya/tuya-home-assistant) diff --git a/source/_integrations/zha.markdown b/source/_integrations/zha.markdown index 2139bcae312..1a98a6d0162 100644 --- a/source/_integrations/zha.markdown +++ b/source/_integrations/zha.markdown @@ -253,7 +253,9 @@ zha: channels: [15, 20, 25] # Channel mask ``` -This is a good reference for channel selection [Zigbee and Wifi Coexistance](https://support.metageek.com/hc/en-us/articles/203845040-ZigBee-and-WiFi-Coexistence) +This is a good reference for channel selection [Zigbee and Wifi Coexistance](https://support.metageek.com/hc/en-us/articles/203845040-ZigBee-and-WiFi-Coexistence). + +Note that the recommendation is, however, not to change the Zigbee channel from default as not all Zigbee devices support all channels. If you have issues with overlapping frequencies, then it will generally be a better idea to change Wi-Fi channels on your Wi-Fi-router or Wi-Fi Access Points. ### Modifying the device type diff --git a/source/_integrations/zwave_js.markdown b/source/_integrations/zwave_js.markdown index dfdcdbc532a..57e6a82b0a7 100644 --- a/source/_integrations/zwave_js.markdown +++ b/source/_integrations/zwave_js.markdown @@ -301,6 +301,18 @@ There are two types of events that are fired, notification events and value noti Check the [Z-Wave JS notification event documentation](https://zwave-js.github.io/node-zwave-js/#/api/node?id=quotnotificationquot) for an explanation of the notification event data. These events fire with the `zwave_js_notification` event type. +Notification event data can be used to trigger automations, both in the automation UI and in YAML, using the event platform. Check the details of an event by subscribing to the zwave_js_notification event in the [Developers Tools](/docs/tools/dev-tools/#subscribe-to-an-event). + +```yaml +# Fires whenever the lock is unlocked by the keypad. +trigger: + - platform: event + event_type: zwave_js_notification + event_data: + node_id: 14 + event_label: "Keypad unlock operation" +``` + #### Notification Command Class These are notification events fired by devices using the Notification command class. The `parameters` attribute in the example below is optional, and when it is included, the keys in the attribute will vary depending on the event. diff --git a/source/_posts/2017-06-20-things-you-should-know-about-senic-covi.markdown b/source/_posts/2017-06-20-things-you-should-know-about-senic-covi.markdown index 75a5a0f3802..3f036bd8398 100644 --- a/source/_posts/2017-06-20-things-you-should-know-about-senic-covi.markdown +++ b/source/_posts/2017-06-20-things-you-should-know-about-senic-covi.markdown @@ -49,7 +49,7 @@ Founder, Home Assistant **Robbie Trencheny**
Core Developer, Home Assistant -[Senic]: https://www.senic.com/en/ +[Senic]: https://www.senic.com/ [kickstarter]: https://www.kickstarter.com/projects/802159142/1793705123?token=03dc08b4# [ks-backup]: /images/blog/2017-06-senic-covi/covi-kickstarter-screenshot.png [email-backup]: /images/blog/2017-06-senic-covi/email-senic.png diff --git a/source/images/docs/configuration/customizing-entity-dialog.png b/source/images/docs/configuration/customizing-entity-dialog.png new file mode 100644 index 00000000000..0526735d7c8 Binary files /dev/null and b/source/images/docs/configuration/customizing-entity-dialog.png differ diff --git a/source/images/docs/configuration/customizing-entity.png b/source/images/docs/configuration/customizing-entity.png new file mode 100644 index 00000000000..85244081353 Binary files /dev/null and b/source/images/docs/configuration/customizing-entity.png differ diff --git a/source/images/getting-started/automation-editor.png b/source/images/getting-started/automation-editor.png index fe883fc09c5..db4a4c40f86 100644 Binary files a/source/images/getting-started/automation-editor.png and b/source/images/getting-started/automation-editor.png differ diff --git a/source/images/getting-started/integrations.png b/source/images/getting-started/integrations.png index 2f95b12df6b..bd29741f2cd 100644 Binary files a/source/images/getting-started/integrations.png and b/source/images/getting-started/integrations.png differ diff --git a/source/images/getting-started/new-automation.png b/source/images/getting-started/new-automation.png index 7157a24e0e8..0dc5f8ff2c7 100644 Binary files a/source/images/getting-started/new-automation.png and b/source/images/getting-started/new-automation.png differ diff --git a/source/images/getting-started/username.png b/source/images/getting-started/username.png index 9d242964bef..668500251a9 100644 Binary files a/source/images/getting-started/username.png and b/source/images/getting-started/username.png differ