+The `user` specified in the credentials should be an applicable user listed in `C:/Users`. This may differ from the username used to login to Windows. Depending on your settings and privileges within Windows, changes to the firewall, UAC (User Account Control) and registry settings may be required to allow this add-on to remotely shut down your computer. There are many guides available online on how to adjust these settings. +
diff --git a/source/_addons/snips.markdown b/source/_addons/snips.markdown index 851afd8e7d9..e8377a1b5a7 100644 --- a/source/_addons/snips.markdown +++ b/source/_addons/snips.markdown @@ -13,7 +13,7 @@ footer: true The Snips add-on depends on the Mosquitto add on to bridge to Home Assistant, so make sure that is installed. -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). +Home Assistant comes with certain Intents builtin to handle common tasks. A complete list of Intents can be found in this wiki [Hass Snips Bundle](https://github.com/tschmidty69/hass-snips-bundle-intents/wiki). The Snips 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. @@ -25,7 +25,7 @@ Open garage door What is on my shopping list ``` -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. +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 Home Assistant Skill to your assistant to enable the built-in intents, and add or create your own intents to do more complex tasks. 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. @@ -114,4 +114,3 @@ searchWeatherForecast: 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/_components/abode.markdown b/source/_components/abode.markdown index 5fb39f20964..63789926840 100644 --- a/source/_components/abode.markdown +++ b/source/_components/abode.markdown @@ -13,9 +13,12 @@ ha_release: 0.52 ha_iot_class: "Cloud Push" --- -The `abode` component will allow users to integrate their Abode Home Security systems into Home Assistant and use its alarm system and sensors to automate their homes. +The `abode` component will allow users to integrate their Abode Home Security +systems into Home Assistant and use its alarm system and sensors to automate +their homes. -Please visit the [Abode website](https://goabode.com/) for further information about Abode Security. +Please visit the [Abode website](https://goabode.com/) for further information +about Abode Security. There is currently support for the following device types within Home Assistant: @@ -30,7 +33,8 @@ There is currently support for the following device types within Home Assistant: ## {% linkable_title Configuration %} -To use Abode devices in your installation, add the following `abode` section to your `configuration.yaml` file: +To use Abode devices in your installation, +add the following `abode` section to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry @@ -38,7 +42,7 @@ abode: username: abode_username password: abode_password name: Abode Alarm System - polling: False + polling: false exclude: - 'ZW:0000000034' - 'RF:00000011' @@ -60,23 +64,30 @@ name: required: false type: string polling: - description: Enable polling if cloud push updating is less reliable. Will update the devices once every 30 seconds. + description: > + Enable polling if cloud push updating is less reliable. + Will update the devices once every 30 seconds. required: false type: boolean default: false exclude: - description: A list of devices to exclude from Home Assistant by their Abode `device_id` or `automation_id`, found within the component attributes. + description: > + A list of devices to exclude from Home Assistant by their Abode `device_id` + or `automation_id`, found within the component attributes. required: false type: list lights: - description: A list of switch devices that Home Assistant should treat as lights by the switches Abode `device_id`, found within the component attributes. + description: > + A list of switch devices that Home Assistant should treat as lights by the + switches Abode `device_id`, found within the component attributes. required: false type: list {% endconfiguration %} ## {% linkable_title Events %} -There are a number of events that can be triggered from Abode. They are grouped into the below events: +There are a number of events that can be triggered from Abode. +They are grouped into the below events: - **abode_alarm**: Fired when an alarm event is triggered from Abode. This includes Smoke, CO, Panic, and Burglar alarms. - **abode_alarm_end**: Fired when an alarm end event is triggered from Abode. @@ -99,13 +110,16 @@ Field | Description `date` | The date of the event in the format `MM/DD/YYYY`. `time` | The time of the event in the format `HH:MM AM`. -There is a unique list of known event_codes that can be found [here](https://github.com/MisterWil/abodepy/files/1262019/timeline_events.txt). +There is a unique list of known event_codes that can be found +[here](https://github.com/MisterWil/abodepy/files/1262019/timeline_events.txt). ## {% linkable_title Services %} ### {% linkable_title Service `change_setting` %} -Change settings on your Abode system. For a full list of settings and valid values, consult the [AbodePy settings section](https://github.com/MisterWil/abodepy/blob/master/README.rst#settings). +Change settings on your Abode system. +For a full list of settings and valid values, consult the +[AbodePy settings section](https://github.com/MisterWil/abodepy/blob/master/README.rst#settings). | Service data attribute | Optional | Description | | ---------------------- | -------- | ----------- | diff --git a/source/_components/ads.markdown b/source/_components/ads.markdown index 9e8463add0b..74e9a4d7215 100644 --- a/source/_components/ads.markdown +++ b/source/_components/ads.markdown @@ -32,7 +32,7 @@ ads: port: required: true description: The port that runs the AMS server on the device, typically this would be 801 or 851. - type: int + type: integer ip_address: required: false description: The IP address of the ADS device, if not set the first 4 bytes of the device id will be used. diff --git a/source/_components/alarm_control_panel.alarmdotcom.markdown b/source/_components/alarm_control_panel.alarmdotcom.markdown index 82e1a7774e7..8509f1bb41d 100644 --- a/source/_components/alarm_control_panel.alarmdotcom.markdown +++ b/source/_components/alarm_control_panel.alarmdotcom.markdown @@ -24,9 +24,22 @@ alarm_control_panel: password: YOUR_PASSWORD ``` -Configuration variables: - -- **username** (*Required*): Username for the Alarm.com account. -- **password** (*Required*): Password for Alarm.com account. -- **name** (*Optional*): The name of the alarm. Default is 'Alarm.com'. -- **code** (*Optional*): Specifies a code to enable or disable the alarm in the frontend. +{% configuration %} +username: + description: Username for the Alarm.com account. + required: true + type: string +password: + description: Password for the Alarm.com account. + required: true + type: string +name: + description: The name of the alarm. + required: false + default: Alarm.com + type: string +code: + description: Specifies a code to enable or disable the alarm in the frontend. + required: false + type: int +{% endconfiguration %} diff --git a/source/_components/alarm_control_panel.concord232.markdown b/source/_components/alarm_control_panel.concord232.markdown index 36f897e21e5..d2ce3afca7c 100644 --- a/source/_components/alarm_control_panel.concord232.markdown +++ b/source/_components/alarm_control_panel.concord232.markdown @@ -24,7 +24,15 @@ alarm_control_panel: - platform: concord232 ``` -Configuration variables: - -- **host** (*Optional*): The host where the concord232 server process is running. Defaults to localhost. -- **port** (*Optional*): The port where the Alarm panel is listening. Defaults to 5007. +{% configuration %} +host: + description: The host where the concord232 server process is running. + required: false + default: localhost + type: string +port: + description: The port where the Alarm panel is listening. + required: false + default: 5007 + type: integer +{% endconfiguration %} diff --git a/source/_components/alarm_control_panel.manual.markdown b/source/_components/alarm_control_panel.manual.markdown index feeda4b7684..2db745df1f0 100644 --- a/source/_components/alarm_control_panel.manual.markdown +++ b/source/_components/alarm_control_panel.manual.markdown @@ -10,10 +10,11 @@ footer: true logo: home-assistant.png ha_category: Alarm ha_release: 0.7.6 +ha_qa_scale: internal --- -This platform enables you to set manual alarms in Home Assistant. +The `manual` alarm control panel platform enables you to set manual alarms in Home Assistant. ```yaml # Example configuration.yaml entry diff --git a/source/_components/alarm_control_panel.manual_mqtt.markdown b/source/_components/alarm_control_panel.manual_mqtt.markdown index 5ceaa64e3a0..2e25b97ace3 100644 --- a/source/_components/alarm_control_panel.manual_mqtt.markdown +++ b/source/_components/alarm_control_panel.manual_mqtt.markdown @@ -94,7 +94,7 @@ alarm_control_panel: ## {% linkable_title Examples %} -Refer to the [Manual Alarm Control page](/components/alarm_control_panel.manual/#examples) for some real life examples of how to use this panel. +Refer to the [Manual Alarm Control page](/components/alarm_control_panel.manual/#examples) for some real-life examples of how to use this panel. ## {% linkable_title MQTT Control %} diff --git a/source/_components/alarm_control_panel.simplisafe.markdown b/source/_components/alarm_control_panel.simplisafe.markdown index ac5c14183a2..1dcad35d05e 100644 --- a/source/_components/alarm_control_panel.simplisafe.markdown +++ b/source/_components/alarm_control_panel.simplisafe.markdown @@ -12,7 +12,7 @@ ha_release: 0.24 ha_category: Alarm --- -The `simplisafe` platform enables the ability to control a SimpliSafe control panel. [simplisafe.com](http://simplisafe.com/). +The `simplisafe` platform enables the ability to control a [SimpliSafe](http://simplisafe.com/) control panel. To enable this, add the following lines to your `configuration.yaml`: @@ -24,10 +24,21 @@ alarm_control_panel: password: YOUR_PASSWORD ``` -Configuration variables: - -- **username** (*Required*): Username for the SimpliSafe account. -- **password** (*Required*): Password for SimpliSafe account. -- **name** (*Optional*): The name of the alarm. Default is the SimpliSafe alarm id. -- **code** (*Optional*): Specifies a code to enable or disable the alarm in the frontend. - +{% configuration %} +username: + description: Username for the SimpliSafe account. + required: true + type: string +password: + description: Password for SimpliSafe account. + required: true + type: string +name: + description: The name of the alarm. Default is the SimpliSafe alarm id. + required: false + type: string +code: + description: Specifies a code to enable or disable the alarm in the frontend. + required: false + type: string +{% endconfiguration %} diff --git a/source/_components/alert.markdown b/source/_components/alert.markdown index e1af527f5f2..bbb2e6b7289 100644 --- a/source/_components/alert.markdown +++ b/source/_components/alert.markdown @@ -10,19 +10,28 @@ footer: true logo: home-assistant.png ha_category: Automation ha_release: 0.38 +ha_qa_scale: internal --- -The `alert` component is designed to notify you when problematic issues arise. For example, if the garage door is left open, the `alert` component can be used remind you of this by sending you repeating notifications at customizable intervals. This is also used for low battery sensors, water leak sensors, or any condition that may need your attention. +The `alert` component is designed to notify you when problematic issues arise. +For example, if the garage door is left open, the `alert` component can be used +remind you of this by sending you repeating notifications at customizable +intervals. This is also used for low battery sensors, +water leak sensors, or any condition that may need your attention. -Alerts will add an entity to the front end only when they are firing. This entity allows you to silence an alert until it is resolved. +Alerts will add an entity to the front end only when they are firing. +This entity allows you to silence an alert until it is resolved.-When using the `alert` component, it is important that the time zone used for Home Assistant and the underlying operating system match. Failing to do so may result in multiple alerts being sent at the same time (such as when Home Assistant is set to the `America/Detroit` time zone but the operating system uses `UTC`). +When using the `alert` component, it is important that the time zone used for Home Assistant and the underlying operating system match. +Failing to do so may result in multiple alerts being sent at the same time (such as when Home Assistant is set to the `America/Detroit` time zone but the operating system uses `UTC`).
### {% linkable_title Basic Example %} -The `alert` component makes use of any of the `notifications` components. To setup the `alert` component, first, you must setup a `notification` component. Then, add the following to your configuration file: +The `alert` component makes use of any of the `notifications` components. To +setup the `alert` component, first, you must setup a `notification` component. +Then, add the following to your configuration file: ```yaml # Example configuration.yaml entry @@ -39,20 +48,65 @@ alert: - ryans_phone - kristens_phone ``` -Configuration variables: -- **name** (*Required*): The friendly name of the alert. -- **done_message** (*Optional*): A message sent after an alert transitions from `on` to `off`. Is only sent if an alert notification was sent for transitioning from `off` to `on`. -- **entity_id** (*Required*): The ID of the entity to watch. -- **state** (*Optional*): The problem condition for the entity. Defaults to `on`. -- **repeat** (*Required*): Number of minutes before the notification should be repeated. Can be either a number or a list of numbers. -- **can_acknowledge** (*Optional*): Allows the alert to be unacknowledgeable. Defaults to `true`. -- **skip_first** (*Optional*): Controls whether the notification should be sent immediately or after the first delay. Defaults to `false`. -- **notifiers** (*Required*): List of `notification` components to use for alerts. +{% configuration %} +name: + description: The friendly name of the alert. + required: true + type: string +done_message: + description: > + A message sent after an alert transitions from `on` to `off`. Is only sent + if an alert notification was sent for transitioning from `off` to `on`. + required: false + type: string +entity_id: + description: The ID of the entity to watch. + required: true + type: string +state: + description: The problem condition for the entity. + required: false + type: string + default: on +repeat: + description: > + Number of minutes before the notification should be repeated. + Can be either a number or a list of numbers. + required: true + type: [int, list] +can_acknowledge: + description: Allows the alert to be unacknowledgeable. + required: false + type: boolean + default: true +skip_first: + description: > + Controls whether the notification should be + sent immediately or after the first delay. + required: false + type: boolean + default: false +notifiers: + description: "List of `notification` components to use for alerts." + required: true + type: list +{% endconfiguration %} -In this example, the garage door status (`input_boolean.garage_door`) is watched and this alert will be triggered when its status is equal to `on`. This indicates that the door has been opened. Because the `skip_first` option was set to `True`, the first notification will not be delivered immediately. However, every 30 minutes, a notification will be delivered until either `input_boolean.garage_door` no longer has a state of `on` or until the alert is acknowledged using the Home Assistant frontend. +In this example, the garage door status (`input_boolean.garage_door`) is watched +and this alert will be triggered when its status is equal to `on`. +This indicates that the door has been opened. Because the `skip_first` option +was set to `True`, the first notification will not be delivered immediately. +However, every 30 minutes, a notification will be delivered until either +`input_boolean.garage_door` no longer has a state of `on` or until the alert is +acknowledged using the Home Assistant frontend. -For notifiers that require other parameters (such as `twilio_sms` which requires you specify a `target` parameter when sending the notification), you can use the `group` notification to wrap them for an alert. Simply create a `group` notification type with a single notification member (such as `twilio_sms`) specifying the required parameters other than `message` provided by the `alert` component: +For notifiers that require other parameters (such as `twilio_sms` which requires +you specify a `target` parameter when sending the notification), you can use the +`group` notification to wrap them for an alert. +Simply create a `group` notification type with a single notification member +(such as `twilio_sms`) specifying the required parameters other than `message` +provided by the `alert` component: ```yaml - platform: group @@ -77,7 +131,13 @@ freshwater_temp_alert: ### {% linkable_title Complex Alert Criteria %} -By design, the `alert` component only handles very simple criteria for firing. That is, it only checks if a single entity's state is equal to a value. At some point, it may be desirable to have an alert with a more complex criteria. Possibly, when a battery percentage falls below a threshold. Maybe you want to disable the alert on certain days. Maybe the alert firing should depend on more than one input. For all of these situations, it is best to use the alert in conjunction with a `Template Binary Sensor`. The following example does that. +By design, the `alert` component only handles very simple criteria for firing. +That is, it only checks if a single entity's state is equal to a value. At some +point, it may be desirable to have an alert with a more complex criteria. +Possibly, when a battery percentage falls below a threshold. Maybe you want to +disable the alert on certain days. Maybe the alert firing should depend on more +than one input. For all of these situations, it is best to use the alert in +conjunction with a `Template Binary Sensor`. The following example does that. ```yaml binary_sensor: @@ -97,11 +157,16 @@ alert: - kristens_phone ``` -This example will begin firing as soon as the entity `sensor.motion`'s `battery` attribute falls below 15. It will continue to fire until the battery attribute raises above 15 or the alert is acknowledged on the frontend. +This example will begin firing as soon as the entity `sensor.motion`'s `battery` +attribute falls below 15. It will continue to fire until the battery attribute +raises above 15 or the alert is acknowledged on the frontend. ### {% linkable_title Dynamic Notification Delay Times %} -It may be desirable to have the delays between alert notifications dynamically change as the alert continues to fire. This can be done by setting the `repeat` configuration key to a list of numbers rather than a single number. Altering the first example would look like the following. +It may be desirable to have the delays between alert notifications dynamically +change as the alert continues to fire. This can be done by setting the `repeat` +configuration key to a list of numbers rather than a single number. +Altering the first example would look like the following. ```yaml # Example configuration.yaml entry @@ -121,4 +186,8 @@ alert: - kristens_phone ``` -Now the first message will be sent after a 15 minute delay, the second will be sent 30 minutes after that, and a 60 minute delay will fall between every following notification. For example, if the garage door opens at 2:00, a notification will be sent at 2:15, 2:45, 3:45, 4:45, etc., continuing every 60 minutes. +Now the first message will be sent after a 15 minute delay, the second will be +sent 30 minutes after that, and a 60 minute delay will fall between every +following notification. +For example, if the garage door opens at 2:00, a notification will be +sent at 2:15, 2:45, 3:45, 4:45, etc., continuing every 60 minutes. diff --git a/source/_components/amcrest.markdown b/source/_components/amcrest.markdown index 220ab96d17f..baa4081a986 100644 --- a/source/_components/amcrest.markdown +++ b/source/_components/amcrest.markdown @@ -13,11 +13,13 @@ ha_iot_class: "Local Polling" ha_release: 0.49 --- -The `amcrest` camera 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: +To enable your camera in your installation, +add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry @@ -41,31 +43,114 @@ amcrest: - ptz_preset ``` -Configuration variables: +{% configuration %} +host: + description: > + The IP address or hostname of your camera. + If using a hostname, make sure the DNS works as expected. + required: true + type: string +username: + description: The username for accessing your camera. + required: true + type: string +password: + description: The password for accessing your camera. + required: true + type: string +name: + description: > + This parameter allows you to override the name of your camera. In the case of multi-camera setups, + this is highly recommended as camera id number will be randomly changed at each reboot if a name is not allocated. + required: false + type: string + default: Amcrest Camera +port: + description: The port that the camera is running on. + required: false + type: integer + default: 80 +resolution: + description: > + 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`. + required: false + type: string + default: high +stream_source: + description: > + 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. + required: false + type: string + default: snapshot +ffmpeg_arguments: + description: > + Extra options to pass to ffmpeg, e.g., + image quality or video filter options. + required: false + type: string +authentication: + description: > + Defines which authentication method to use only when **stream_source** + is **mjpeg**. Currently, *aiohttp* only support *basic*. + required: false + type: string + default: basic +scan_interval: + description: Defines the update interval of the sensor in seconds. + required: false + type: integer + default: 10 +sensors: + description: > + Conditions to display in the frontend. + The following conditions can be monitored: + required: false + type: list + default: None + keys: + motion_detector: + description: "Return `true`/`false` when a motion is detected." + sdcard: + description: Return the SD card usage by reporting the total and used space. + ptz_preset: + description: > + Return the number of PTZ preset positions + configured for the given camera. +switches: + description: > + Switches to display in the frontend. + The following switches can be monitored: + required: false + type: list + default: None + keys: + motion_detection: + description: Enable/disable motion detection setting. + motion_recording: + description: Enable/disable recording on motion detection setting. +{% endconfiguration %} -- **host** (*Required*): The IP address or hostname of your camera. If using a hostname, make sure the DNS works as expected. -- **username** (*Required*): The username for accessing your camera. -- **password** (*Required*): The password for accessing your camera. -- **name** (*Optional*): This parameter allows you to override the name of your camera. The default is "Amcrest Camera". In the case of multi-camera setups, this is highly recommended as camera id number will be randomly changed at each reboot if a name is not allocated. -- **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. -- **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:** 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](/components/ffmpeg/) +documentation to install the `ffmpeg`. -**Note:** If you set the `stream_source` option to `rtsp`, make sure to follow the steps mentioned at -[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/). -Finish its configuration by visiting the [Amcrest sensor page](/components/sensor.amcrest/) or [Amcrest camera page](/components/camera.amcrest/). - -To check if your Amcrest camera is supported/tested, visit the [supportability matrix](https://github.com/tchellomello/python-amcrest#supportability-matrix) link from the `python-amcrest` project. +To check if your Amcrest camera is supported/tested, visit the +[supportability matrix](https://github.com/tchellomello/python-amcrest#supportability-matrix) +link from the `python-amcrest` project. diff --git a/source/_components/apcupsd.markdown b/source/_components/apcupsd.markdown index 44265218d24..c66a0f324a8 100644 --- a/source/_components/apcupsd.markdown +++ b/source/_components/apcupsd.markdown @@ -32,7 +32,7 @@ host: port: description: The port on which the APCUPSd NIS is listening. required: false - type: int + type: integer default: 3551 {% endconfiguration %} diff --git a/source/_components/api.markdown b/source/_components/api.markdown index ba1097738e9..4ff36762cbf 100644 --- a/source/_components/api.markdown +++ b/source/_components/api.markdown @@ -9,6 +9,7 @@ sharing: true footer: true logo: home-assistant.png ha_category: "Other" +ha_qa_scale: internal --- The `api` component exposes a RESTful API and allows one to interact with a Home Assistant instance that is running headless. This component depends on the [`http` component](/components/http/). diff --git a/source/_components/arlo.markdown b/source/_components/arlo.markdown index a95acd4999e..ab5839c3022 100644 --- a/source/_components/arlo.markdown +++ b/source/_components/arlo.markdown @@ -38,7 +38,7 @@ password: scan_interval: description: How frequently to query for new data. Defaults to 60 seconds. required: false - type: int + type: integer {% 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/august.markdown b/source/_components/august.markdown index 9231f7d2f13..2eb0216834b 100644 --- a/source/_components/august.markdown +++ b/source/_components/august.markdown @@ -49,7 +49,7 @@ password: timeout: description: Timeout to wait for connections. required: false - type: int + type: integer default: 10 {% endconfiguration %} diff --git a/source/_components/auth.markdown b/source/_components/auth.markdown index cc7ec923920..ac1d6278d4e 100644 --- a/source/_components/auth.markdown +++ b/source/_components/auth.markdown @@ -10,6 +10,7 @@ footer: true logo: home-assistant.png ha_category: Other ha_release: 0.73 +ha_qa_scale: internal --- This component creates the endpoints for the [authentication system](/docs/authentication/) that is built into Home Assistant. There are no configuration options for this component directly as it relies on the auth system in the core. diff --git a/source/_components/automation.markdown b/source/_components/automation.markdown index a998ca88f87..4aaee44eec1 100644 --- a/source/_components/automation.markdown +++ b/source/_components/automation.markdown @@ -12,7 +12,8 @@ ha_category: Automation ha_qa_scale: internal --- -Please see the [docs section](/docs/automation/) for in-depth documentation on how to use the automation component. +Please see the [docs section](/docs/automation/) for in-depth +documentation on how to use the automation component. Starting with 0.28 your automation rules can be controlled with the frontend. @@ -20,12 +21,16 @@ 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:
- alias: Door alarm
- hide_entity: True
+ hide_entity: true
initial_state: 'off'
trigger:
- platform: state
diff --git a/source/_components/axis.markdown b/source/_components/axis.markdown
index 6662b55300a..9b2faadd988 100644
--- a/source/_components/axis.markdown
+++ b/source/_components/axis.markdown
@@ -90,3 +90,7 @@ Send a command using [Vapix](https://www.axis.com/support/developer-support/vapi
| `action` | yes | What type of call. Default is `update`. |
Response to call can be subscribed to on event `vapix_call_response`
+
+## {% linkable_title Troubleshooting discovery %}
+
+If a `169.x.x.x` address is discovered. On your camera, go to **System Options** -> **Advanced** -> **Plain Config**. Change the drop-down box to `network` and click `Select Group`. If `Network Interface I0 ZeroConf` contains the `169.x.x.x` IP address, unchecked the box next to `Enabled` for this section and click `Save`.
diff --git a/source/_components/binary_sensor.arest.markdown b/source/_components/binary_sensor.arest.markdown
index 1cf17934b7f..4465d6ed938 100644
--- a/source/_components/binary_sensor.arest.markdown
+++ b/source/_components/binary_sensor.arest.markdown
@@ -28,11 +28,20 @@ binary_sensor:
pin: 8
```
-Configuration variables:
-
-- **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.
+{% configuration %}
+resource:
+ description: IP address and schema of the device that is exposing an aREST API, e.g., http://192.168.1.10.
+ required: true
+ type: string
+pin:
+ description: Number of the pin to monitor.
+ required: true
+ type: integer
+name:
+ description: Let you overwrite the name of the device. By default *name* from the device is used.
+ required: false
+ type: string
+{% endconfiguration %}
Accessing the URL http://IP_ADDRESS/digital/PIN_NUMBER should give you the state of the pin inside a JSON response as `return_value`.
diff --git a/source/_components/binary_sensor.bayesian.markdown b/source/_components/binary_sensor.bayesian.markdown
index 228e8ac15bf..a5b1779ce58 100644
--- a/source/_components/binary_sensor.bayesian.markdown
+++ b/source/_components/binary_sensor.bayesian.markdown
@@ -11,6 +11,7 @@ logo: home-assistant.png
ha_category: Utility
ha_iot_class: "Local Polling"
ha_release: 0.53
+ha_qa_scale: internal
---
diff --git a/source/_components/binary_sensor.command_line.markdown b/source/_components/binary_sensor.command_line.markdown
index f3f8af7f3e3..c206c3cb927 100644
--- a/source/_components/binary_sensor.command_line.markdown
+++ b/source/_components/binary_sensor.command_line.markdown
@@ -40,7 +40,7 @@ Configuration variables:
## {% linkable_title Examples %}
-In this section you find some real life examples of how to use this sensor.
+In this section you find some real-life examples of how to use this sensor.
### {% linkable_title SickRage %}
diff --git a/source/_components/binary_sensor.deconz.markdown b/source/_components/binary_sensor.deconz.markdown
index 3e41d4b1614..609eff3157a 100644
--- a/source/_components/binary_sensor.deconz.markdown
+++ b/source/_components/binary_sensor.deconz.markdown
@@ -24,7 +24,7 @@ The following sensor types are supported:
The `entity_id` name will be `binary_sensor.device_name`, where `device_name` is defined in deCONZ.
-#### {% linkable_title Verified to be supported binary sensors %}
+#### {% linkable_title Verified supported binary sensors %}
- Open/Close Detection
- Xiaomi Smart Home Security Door & Window Contact Sensor
diff --git a/source/_components/binary_sensor.flic.markdown b/source/_components/binary_sensor.flic.markdown
index 3767ed7476a..31eacc4d866 100644
--- a/source/_components/binary_sensor.flic.markdown
+++ b/source/_components/binary_sensor.flic.markdown
@@ -13,9 +13,17 @@ ha_iot_class: "Local Push"
ha_release: 0.35
---
-The `flic` platform allows you to connect with multiple [flic](https://flic.io) smart buttons.
+The `flic` platform allows you to receive click events from [flic](https://flic.io) smart buttons.
-The platform does not directly interact with the buttons, but communicates with the flic service that manages the buttons. The service can run on the same instance as Home Assistant or any other reachable machine. For setup instructions visit the GitHub repository of the service for [Linux](https://github.com/50ButtonsEach/fliclib-linux-hci), [OS X](https://github.com/50ButtonsEach/flic-service-osx) or [Windows](https://github.com/50ButtonsEach/fliclib-windows).
+The platform does not directly interact with the buttons, *but communicates with a flic service* that manages the buttons. The service can run on the same instance as Home Assistant or any other reachable machine.
+
+#### {% linkable_title Service setup %}
+
+If you are using Hass.io, you can run the service locally by [installing](https://www.home-assistant.io/hassio/installing_third_party_addons/) the flicd add-on from [pschmitt's repository](https://github.com/pschmitt/hassio-addons). On a Hass.io installation that's not yet based on HassOS, you also need to install the [bluetooth add-on](/addons/bluetooth_bcm43xx/).
+
+For instructions on how to install the service manually, visit the GitHub repository of the service for [Linux](https://github.com/50ButtonsEach/fliclib-linux-hci), [OS X](https://github.com/50ButtonsEach/flic-service-osx) or [Windows](https://github.com/50ButtonsEach/fliclib-windows).
+
+#### {% linkable_title Configuration %}
To use your flic buttons in your installation, add the following to your `configuration.yaml` file:
@@ -25,19 +33,39 @@ binary_sensor:
- platform: flic
```
-Configuration variables:
-
-- **host** (*Optional*): The IP or hostname of the flic service server. Defaults to `localhost`.
-- **port** (*Optional*): The port of the flic service. Defaults to `5551`.
-- **discovery** (*Optional*): If `true` then the component is configured to constantly scan for new buttons. Defaults to `true`.
-- **ignored_click_types**: List of click types whose occurrence should not trigger a `flic_click` event. Click types are `single`, `double`, and `hold`.
-- **timeout** (*Optional*): Maximum time in seconds an event can be queued locally on a button before discarding the event. Defaults to 3.
+{% configuration %}
+host:
+ description: The IP or hostname of the flic service server.
+ required: false
+ type: string
+ default: localhost
+port:
+ description: The port of the flic service.
+ required: false
+ type: integer
+ default: 5551
+discovery:
+ description: If `true` then the component is configured to constantly scan for new buttons.
+ required: false
+ type: boolean
+ default: true
+ignored_click_types:
+ description: List of click types whose occurrence should not trigger a `flic_click` event. Click types are `single`, `double`, and `hold`.
+ required: false
+ type: list
+timeout:
+ description: The maximum time in seconds an event can be queued locally on a button before discarding the event.
+ required: false
+ type: integer
+ default: 3
+{% endconfiguration %}
#### {% linkable_title Discovery %}
If discovery is enabled, you can add a new button by pressing it for at least 7 seconds. The button will be paired with the flic service and added to Home Assistant. Otherwise, you have to manually pair it with the flic service. The Home Assistant platform will not scan for new buttons and will only connect to buttons already paired.
#### {% linkable_title Timeout %}
+
When the flic button is triggered while disconnected from flic service, it will queue all events and try to connect and transmit them as soon as possible. The timeout variable can be used to stop events from triggering if too much time passed between the action and the notification in Home Assistant.
#### {% linkable_title Events %}
@@ -47,7 +75,7 @@ The flic component fires `flic_click` events on the bus. You can capture the eve
```yaml
# Example configuration.yaml automation entry
automation:
- - alias: Turn on lights in living room if flic is pressed once
+ - alias: Turn on lights in the living room when flic is pressed once
trigger:
platform: event
event_type: flic_click
@@ -55,7 +83,7 @@ automation:
button_name: flic_81e4ac74b6d2
click_type: single
action:
- service: homeassistant.turn_off
+ service: homeassistant.turn_on
entity_id: group.lights_livingroom
```
@@ -66,6 +94,22 @@ Event data:
- **click_type**: The type of click. Possible values are `single`, `double` and `hold`.
- **queued_time**: The amount of time this event was queued on the button, in seconds.
+To help detect and debug flic button clicks, you can use this automation that send a notification on very click type of every button. This example uses the [HTML5 push notification platform](/components/notify.html5/). Visit the [notification component page](/components/notify/) for more information on setting up notifications.
+
+```yaml
+automation:
+ - alias: FLIC Html5 notify on every click
+ hide_entity: false
+ trigger:
+ platform: event
+ event_type: flic_click
+ action:
+ - service_template: notify.html5
+ data_template:
+ title: "flic click"
+ message: {% raw %}"flic {{ trigger.event.data.button_name }} was {{ trigger.event.data.click_type }} clicked"{% endraw %}
+```
+
##### {% linkable_title Ignoring Click Types %}
For some purposes it might make sense to exclude a specific click type from triggering click events. For example when ignoring double clicks, pressing the button twice fast results in two `single` instead of a `double` click event. This is very useful for applications where you want to click fast.
diff --git a/source/_components/binary_sensor.hikvision.markdown b/source/_components/binary_sensor.hikvision.markdown
index 97c63757163..b3d892b437a 100644
--- a/source/_components/binary_sensor.hikvision.markdown
+++ b/source/_components/binary_sensor.hikvision.markdown
@@ -13,22 +13,36 @@ ha_release: 0.35
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 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 management section of the web interface. 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: +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 @@ -37,7 +51,8 @@ binary_sensor.home_line_crossing_1 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: +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 @@ -46,7 +61,8 @@ This platform should work with all Hikvision cameras and nvrs, and has been conf - DS-2CD2142FWD-I - DS-2CD2155FWD-IS -To enable this sensor, the following lines are required in your `configuration.yaml` file: +To enable this sensor, +add the following lines are required in your `configuration.yaml` file: ```yaml binary_sensor: @@ -56,17 +72,56 @@ binary_sensor: password: pass ``` -Configuration options for a Hikvision Sensor: - -- **host** (*Required*): The IP address of the camera you would like to connect to. -- **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. +{% configuration %} +host: + description: The IP address of the camera you would like to connect to. + required: true + type: string +username: + description: The username to authenticate with. + required: true + type: string +password: + description: The password to authenticate with. + required: true + type: string +name: + description: > + The name you would like to give the camera in Home Assistant, + defaults to name defined in the camera. + required: false + type: string +port: + description: The port to connect to the camera on. + required: false + type: integer + default: 80 +ssl: + description: "`true` if you want to connect with https. Be sure to set the port also." + required: false + type: boolean +customize: + description: > + This attribute contains sensor-specific override values. + Only sensor name needs defined: + required: false + type: map + keys: + ignored: + description: > + Ignore this sensor completely. It won't be shown in + the Web Interface and no events are generated for it. + required: false + type: boolean + delay: + description: > + Specify the delay to wait after a sensor event ends before notifying + Home Assistant in seconds. This is useful to catch multiple quick trips + in one window without the state toggling on and off. + required: false + type: integer + default: 5 +{% endconfiguration %} Supported sensor/event types are: @@ -87,36 +142,38 @@ 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: +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 + ssl: false username: user password: pass customize: motion: delay: 30 line_crossing: - ignored: True + ignored: true ``` -Example of a configuration in your `configuration.yaml` that utilizes the customize options for a nvr: +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 + ssl: false username: user password: pass customize: motion_1: delay: 30 field_detection_2: - ignored: True + ignored: true ``` diff --git a/source/_components/binary_sensor.http.markdown b/source/_components/binary_sensor.http.markdown index c2442aa881f..779cafb95e2 100644 --- a/source/_components/binary_sensor.http.markdown +++ b/source/_components/binary_sensor.http.markdown @@ -60,7 +60,7 @@ $ curl -X GET -H "x-ha-access: YOUR_PASSWORD" \ ## {% linkable_title Examples %} -In this section you find some real life examples of how to use this sensor. Beside `curl`. +In this section you'll find some real-life examples of how to use this sensor, besides `curl`, which was shown earlier. ### {% linkable_title Using Python request module %} diff --git a/source/_components/binary_sensor.ihc.markdown b/source/_components/binary_sensor.ihc.markdown index da5aac7615e..9340c74aa6b 100644 --- a/source/_components/binary_sensor.ihc.markdown +++ b/source/_components/binary_sensor.ihc.markdown @@ -13,19 +13,22 @@ ha_release: 0.62 ha_iot_class: "Local Push" --- -Before you can use the IHC Binary Sensor platform, you must setup the [IHC Component](/components/ihc/) +Before you can use the IHC Binary Sensor platform, +you must setup the [IHC Component](/components/ihc/). -When auto setup is enabled the following products will be found in the IHC project and setup as binary sensors: +When auto setup is enabled the following products will +be found in the IHC project and setup as binary sensors: -* Dataline magnet contacts -* Dataline Pir sensors -* Dataline Pir sensors with twilight detection -* Dataline Pir alarm sensor -* Dataline smoke detector -* Dataline gas detector -* Dataline light sensor +- Dataline magnet contacts +- Dataline Pir sensors +- Dataline Pir sensors with twilight detection +- Dataline Pir alarm sensor +- Dataline smoke detector +- Dataline gas detector +- Dataline light sensor -To manually configure IHC Binary Sensors insert this section in your configuration: +To manually configure IHC Binary Sensors +insert this section in your configuration: ```yaml binary_sensor: @@ -48,22 +51,24 @@ binary_sensors: id: description: The IHC resource id. required: true - type: int + type: integer inverting: description: If True the sensor will be inverted. required: false - type: bool + type: boolean default: false name: description: The name of the component required: false type: string type: - description: The binary sensor type. See [Home Assistant binary sensor](/components/binary_sensor/) for available types. + description: > + The binary sensor type. + See [Home Assistant binary sensor](/components/binary_sensor/) + for available types. required: false type: string {% endconfiguration %} -The resource id should be an id of a boolean IHC resource. -For more information about IHC resource ids see [Manual Setup](/components/ihc/#manual-setup) - +The resource id should be an id of a boolean IHC resource. For more information +about IHC resource ids see [Manual Setup](/components/ihc/#manual-setup). diff --git a/source/_components/binary_sensor.iss.markdown b/source/_components/binary_sensor.iss.markdown index 0d4e4276b30..f9b0da08de8 100644 --- a/source/_components/binary_sensor.iss.markdown +++ b/source/_components/binary_sensor.iss.markdown @@ -13,11 +13,16 @@ ha_release: 0.36 redirect_from: /components/sensor.iss/ --- -The `iss` platform uses the [Open Notify API](http://open-notify.org/Open-Notify-API/ISS-Location-Now/) to let you know if the station is above your home location. This means that ISS is 10° above the horizon of your home. +The `iss` platform uses the +[Open Notify API](http://open-notify.org/Open-Notify-API/ISS-Location-Now/) +to let you know if the station is above your home location. +This means that ISS is 10° above the horizon of your home. -You can check in the attributes of the sensor to see the timestamp for the next rise of the station, its current coordinates, and the number of people in space. +You can check in the attributes of the sensor to see the timestamp for the next +rise of the station, its current coordinates, and the number of people in space. -To add ISS binary sensor to your installation, add the following to your `configuration.yaml` file: +To add ISS binary sensor to your installation, +add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry @@ -34,13 +39,14 @@ show_on_map: {% endconfiguration %}-If you set `show_on_map` `True` then the location attributes are named `latitude` and `longitude`. The default name of the location attributes is `lat` and `long` to avoid showing them on the map. +If you set `show_on_map: true` then the location attributes are named `latitude` and `longitude`. +The default name of the location attributes is `lat` and `long` to avoid showing them on the map.
- ### {% linkable_title Show position on map with camera platform %} -The [generic camera platform](/components/camera.mjpeg/) offers the possibility to show the location of the ISS on Google Maps. +The [generic camera platform](/components/camera.mjpeg/) offers +the possibility to show the location of the ISS on Google Maps. {% raw %} ```yaml diff --git a/source/_components/binary_sensor.mqtt.markdown b/source/_components/binary_sensor.mqtt.markdown index 8d4b8b38e27..114c974cbbf 100644 --- a/source/_components/binary_sensor.mqtt.markdown +++ b/source/_components/binary_sensor.mqtt.markdown @@ -13,15 +13,32 @@ ha_release: 0.9 ha_iot_class: "depends" --- -The `mqtt` binary sensor platform uses an MQTT message payload to set the binary sensor to one of two states: `on` or `off`. +The `mqtt` binary sensor platform uses an MQTT message payload +to set the binary sensor to one of two states: `on` or `off`. -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`. +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. +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: +To use an MQTT binary sensor in your installation, +add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry @@ -51,7 +68,11 @@ payload_off: type: string 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." + 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 type: string payload_available: @@ -70,32 +91,41 @@ qos: type: integer default: 0 unique_id: - description: "An ID that uniquely identifies this sensor. If two sensors have the same unique ID, Home Assistant will raise an exception." + 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](/components/binary_sensor/) of the sensor to set the icon in the frontend." + description: > + The [type/class](/components/binary_sensor/) of + the sensor to set the icon in the frontend. required: false type: string value_template: - description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract a value from the payload." + description: > + Defines a [template](/docs/configuration/templating/#processing-incoming-data) + to extract a value from the payload. required: false type: string force_update: - description: Sends update events even if the value hasn't changed. Useful if you want to have meaningful value graphs in history. + description: > + Sends update events even if the value has not changed. + Useful if you want to have meaningful value graphs in history. reqired: false type: boolean - default: False + default: false {% endconfiguration %} - ## {% linkable_title Examples %} In this section, you will find some real-life examples of how to use this sensor. ### {% linkable_title Full configuration %} -To test, you can use the command line tool `mosquitto_pub` shipped with `mosquitto` or the `mosquitto-clients` package to send MQTT messages. To set the state of the binary sensor manually: +To test, you can use the command line tool `mosquitto_pub` shipped with +`mosquitto` or the `mosquitto-clients` package to send MQTT messages. +To set the state of the binary sensor manually: ```bash $ mosquitto_pub -h 127.0.0.1 -t home-assistant/window/contact -m "OFF" @@ -123,7 +153,14 @@ binary_sensor: ### {% linkable_title Get the state of a device with ESPEasy %} -Assuming that you have flashed your ESP8266 unit with [ESPEasy](https://github.com/letscontrolit/ESPEasy). Under "Config" is a name ("Unit Name:") set for your device (here it's "bathroom"). A configuration for a "Controller" for MQTT with the protocol "OpenHAB MQTT" is present and the entries ("Controller Subscribe:" and "Controller Publish:") are adjusted to match your needs. In this example, the topics are prefixed with "home". Also, add a "Switch Input" in the "Devices" tap with the name "switch" and "button" as value. +Assuming that you have flashed your ESP8266 unit with +[ESPEasy](https://github.com/letscontrolit/ESPEasy). +Under "Config" is a name ("Unit Name:") set for your device +(here it's "bathroom"). A configuration for a "Controller" for MQTT with the +protocol "OpenHAB MQTT" is present and the entries ("Controller Subscribe:" and +"Controller Publish:") are adjusted to match your needs. +In this example, the topics are prefixed with "home". Also, add a "Switch Input" +in the "Devices" tap with the name "switch" and "button" as value. As soon as the unit is online, you will get the state of the attached button. diff --git a/source/_components/binary_sensor.netatmo.markdown b/source/_components/binary_sensor.netatmo.markdown index da2f8ab1fe1..1d396f6966e 100644 --- a/source/_components/binary_sensor.netatmo.markdown +++ b/source/_components/binary_sensor.netatmo.markdown @@ -14,13 +14,19 @@ ha_release: 0.31 ### {% linkable_title Basic Configuration %} -The `netatmo` binary sensor platform is consuming the information provided by a [Netatmo](https://www.netatmo.com) camera. This component allows you to get the latest event seen by the camera. +The `netatmo` binary sensor platform is consuming the information provided by a +[Netatmo](https://www.netatmo.com) camera. +This component allows you to get the latest event seen by the camera. -To enable the Netatmo binary sensor, you have to set up [netatmo](/components/netatmo/), this will use discovery to add your binary sensor. +To enable the Netatmo binary sensor, you have to set up +[netatmo](/components/netatmo/), +this will use discovery to add your binary sensor. ### {% linkable_title Advanced configuration %} -If you want to select a specific sensor, set discovery to False for [netatmo](/components/netatmo/) and add the following lines to your `configuration.yaml`: +If you want to select a specific sensor, +set discovery to `false` for [netatmo](/components/netatmo/) +and add the following lines to your `configuration.yaml`: ```yaml # Example configuration.yaml entry @@ -41,20 +47,36 @@ binary_sensor: - Outdoor vehicle ``` -Configuration variables: +{% configuration %} +home: + description: Will use the cameras of this home only. + required: false + type: string +timeout: + description: > + The Welcome/Presence binary sensors will + stay on for X seconds after detection. + required: false + type: integer + default: 90 +cameras: + description: List of cameras entity IDs to display. + required: false + type: list +welcome_sensors: + description: > + List of monitored conditions. Possible values are + 'Someone known', 'Someone unknown' and 'Motion'. + required: false + type: list +presence_sensors: + description: > + List of monitored conditions. Possible values are 'Outdoor motion', + 'Outdoor human', 'Outdoor animal' and 'Outdoor vehicle'. + required: false + type: list +{% endconfiguration %} -- **home** (*Optional*): Will use the cameras of this home only. -- **timeout** (*Optional*): The Welcome/Presence binary sensors will stay on for X seconds after detection. (default: 90) -- **cameras** array (*Optional*): Cameras to use. Multiple entities allowed. - - 'camera_name': Name of the camera to display. -- **welcome_sensors** array (*Optional*): List of monitored conditions. - - 'Someone known' - - 'Someone unknown' - - 'Motion' -- **presence_sensors** array (*Optional*): List of monitored conditions. - - 'Outdoor motion' - - 'Outdoor human' - - 'Outdoor animal' - - 'Outdoor vehicle' - -If **home** and **cameras** is not provided, all cameras will be used. If multiple cameras are available then each monitored conditions will create a specific sensor for each camera +If **home** and **cameras** is not provided, all cameras will be used. +If multiple cameras are available then each monitored conditions +will create a specific sensor for each camera diff --git a/source/_components/binary_sensor.pilight.markdown b/source/_components/binary_sensor.pilight.markdown index ef71c754602..85307be3d60 100644 --- a/source/_components/binary_sensor.pilight.markdown +++ b/source/_components/binary_sensor.pilight.markdown @@ -13,11 +13,16 @@ ha_release: 0.44 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). +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). ## {% linkable_title Configuration %} -To enable a Pilight binary sensor in your installation, add the following to your `configuration.yaml` file: +To enable a Pilight binary sensor in your installation, +add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry @@ -26,15 +31,41 @@ binary_sensor: variable: 'state' ``` -Configuration variables: - -- **variable** (*Required*): The variable name in the data stream that defines the sensor value. -- **payload** (*Required*): Message payload identifiers. Only if all identifiers are matched the sensor value is set. -- **name** (*Optional*): Name of the sensor. -- **payload_on** (*Optional*): Variable `on` value. The component will recognize this as logical '1'. -- **payload_off** (*Optional*): Variable `off` value. The component will recognize this as logical '0'. -- **disarm_after_trigger:** (*Optional*): Configure sensor as trigger type. -- **reset_delay_sec** (*Optional*): Seconds before the sensor is disarmed if `disarm_after_trigger` is set to true. Default is 30 seconds. +{% configuration %} +variable: + description: The variable name in the data stream that defines the sensor value. + required: true + type: string +payload: + description: > + Message payload identifiers. + Only if all identifiers are matched the sensor value is set. + required: true + type: string +name: + description: Name of the sensor. + required: false + type: string +payload_on: + description: "Variable `on` value. The component will recognize this as logical '1'." + required: false + type: string +payload_off: + description: "Variable `off` value. The component will recognize this as logical '0'." + required: false + type: string +disarm_after_trigger: + description: Configure sensor as trigger type. + required: false + type: boolean +reset_delay_sec: + description: > + Seconds before the sensor is disarmed if + `disarm_after_trigger` is set to true. + required: false + type: integer + default: 30 +{% endconfiguration %} A full configuration example could look like this: diff --git a/source/_components/binary_sensor.ping.markdown b/source/_components/binary_sensor.ping.markdown index 37121004e44..193297cbd88 100644 --- a/source/_components/binary_sensor.ping.markdown +++ b/source/_components/binary_sensor.ping.markdown @@ -10,6 +10,7 @@ footer: true logo: home-assistant.png ha_category: Network ha_release: 0.43 +ha_qa_scale: internal --- @@ -25,12 +26,22 @@ binary_sensor: - platform: ping host: 192.168.0.1 ``` - -Configuration variables: - -- **host** (*Required*): The IP address or hostname of the system you want to track. -- **count** (*Optional*): Number of packets to send. Defaults to 5. -- **name** (*Optional*): Let you overwrite the name of the device. Defaults to `Ping Binary sensor`. +{% configuration %} +host: + description: The IP address or hostname of the system you want to track. + required: true + type: string +count: + description: Number of packets to send. + required: false + type: integer + default: 5 +name: + description: Let you overwrite the name of the device. + required: false + type: string + default: "`Ping Binary sensor`" +{% endconfiguration %} The sensor exposes the different round trip times values measured by `ping` as attributes: diff --git a/source/_components/binary_sensor.random.markdown b/source/_components/binary_sensor.random.markdown index 3fdc95eb617..b398a2c9a43 100644 --- a/source/_components/binary_sensor.random.markdown +++ b/source/_components/binary_sensor.random.markdown @@ -11,10 +11,10 @@ logo: home-assistant.png ha_category: Utility ha_iot_class: "Local Polling" ha_release: 0.57 +ha_qa_scale: internal --- - -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. +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 %} @@ -33,5 +33,3 @@ name: type: string {% endconfiguration %} -See the [entity component options](/docs/configuration/platform_options/) to control how often the main component polls the random binary sensor. The default is 30 seconds. - diff --git a/source/_components/binary_sensor.rest.markdown b/source/_components/binary_sensor.rest.markdown index d882e5b4064..7c36530f59a 100644 --- a/source/_components/binary_sensor.rest.markdown +++ b/source/_components/binary_sensor.rest.markdown @@ -13,10 +13,15 @@ ha_release: "0.10" ha_iot_class: "Local Polling" --- +The `rest` binary sensor platform is consuming a given endpoint which is exposed +by a +[RESTful API](https://en.wikipedia.org/wiki/Representational_state_transfer) +of a device, an application, or a web service. +The binary sensor has support for GET and POST requests. -The `rest` binary sensor platform is consuming a given endpoint which is exposed by a [RESTful API](https://en.wikipedia.org/wiki/Representational_state_transfer) of a device, an application, or a web service. The binary sensor has support for GET and POST requests. - -The JSON messages can contain different values like `1`, `"1"`, `TRUE`, `true`, `on`, or `open`. If the value is nested then use a [template](/docs/configuration/templating/#processing-incoming-data). +The JSON messages can contain different values like `1`, `"1"`, +`TRUE`, `true`, `on`, or `open`. If the value is nested then use a +[template](/docs/configuration/templating/#processing-incoming-data). ```json { @@ -28,7 +33,8 @@ The JSON messages can contain different values like `1`, `"1"`, `TRUE`, `true`, } ``` -To enable this sensor, add the following lines to your `configuration.yaml` file for a GET request: +To enable this sensor, +add the following lines to your `configuration.yaml` file for a GET request: ```yaml # Example configuration.yaml entry @@ -64,11 +70,15 @@ name: type: string default: REST Binary Sensor device_class: - description: "The [type/class](/components/binary_sensor/) of the sensor to set the icon in the frontend." + description: > + The [type/class](/components/binary_sensor/) of + the sensor to set the icon in the frontend. required: false type: string value_template: - description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract the value." + description: > + Defines a [template](/docs/configuration/templating/#processing-incoming-data) + to extract the value. required: false type: template payload: @@ -79,9 +89,9 @@ verify_ssl: description: Verify the certification of the endpoint. required: false type: boolean - default: True + default: true authentication: - description: Type of the HTTP authentication. `basic` or `digest`. + description: "Type of the HTTP authentication. `basic` or `digest`." required: false type: string username: @@ -104,11 +114,13 @@ Make sure that the URL exactly matches your endpoint or resource. ## {% linkable_title Examples %} -In this section you find some real life examples of how to use this sensor. +In this section you find some real-life examples of how to use this sensor. ### {% linkable_title aREST sensor %} -Instead of using an [aREST](/components/binary_sensor.arest/) binary sensor, you could retrieve the value of a device supporting aREST directly with a REST binary sensor. +Instead of using an [aREST](/components/binary_sensor.arest/) binary sensor, +you could retrieve the value of a device supporting +aREST directly with a REST binary sensor. ```yaml binary_sensor: @@ -136,7 +148,8 @@ binary_sensor: Content-Type: application/json ``` -The headers will contain all relevant details. This will also give you the ability to access endpoints that are protected by tokens. +The headers will contain all relevant details. This will also give +you the ability to access endpoints that are protected by tokens. ```bash Content-Length: 1024 diff --git a/source/_components/binary_sensor.rfxtrx.markdown b/source/_components/binary_sensor.rfxtrx.markdown index 0aaefbad7d6..186d64bfed9 100644 --- a/source/_components/binary_sensor.rfxtrx.markdown +++ b/source/_components/binary_sensor.rfxtrx.markdown @@ -11,23 +11,35 @@ logo: rfxtrx.png ha_category: Binary Sensor --- -The `rfxtrx` platform support binary sensors that communicate in the frequency range of 433.92 MHz. The rfxtrx binary sensor component provides support for them. +The `rfxtrx` platform support binary sensors that +communicate in the frequency range of 433.92 MHz. +The rfxtrx binary sensor component provides support for them. -Many cheap sensors available on the web today are based on a particular RF chip called *PT-2262*. Depending on the running firmware on the RFXcom box, some of them may be recognized under the X10 protocol but most of them are recognized under the *Lighting4* protocol. The rfxtrx binary sensor component provides some special options for them, while other rfxtrx protocols should work too. +Many cheap sensors available on the web today are based on a particular RF chip +called *PT-2262*. Depending on the running firmware on the RFXcom box, some of +them may be recognized under the X10 protocol but most of them are recognized +under the *Lighting4* protocol. The rfxtrx binary sensor component provides +some special options for them, while other rfxtrx protocols should work too. # Setting up your devices -Once you have set up your [rfxtrx hub](/components/rfxtrx/), the easiest way to find your binary sensors is to add this to your `configuration.yaml`: + +Once you have set up your [rfxtrx hub](/components/rfxtrx/), the easiest way +to find your binary sensors is to add this to your `configuration.yaml`: ```yaml # Example configuration.yaml entry binary_sensor: platform: rfxtrx - automatic_add: True + automatic_add: true ``` -Open your local home-assistant web UI and go to the "states" page. Then make sure to trigger your sensor. You should see a new entity appear in the *Current entities* list, starting with "binary_sensor." and some hexadecimal digits. Those hexadecimal digits are your device id. +Open your Home Assistant frontend and go to the "states" page. +Then make sure to trigger your sensor. You should see a new entity +appear in the *Current entities* list, starting with "binary_sensor." +and some hexadecimal digits. Those hexadecimal digits are your device id. -For example: "binary_sensor.0913000022670e013b70". Here your device id is `0913000022670e013b70`. Then you should update your configuration to: +For example: "binary_sensor.0913000022670e013b70". Here your device id +is `0913000022670e013b70`. Then you should update your configuration to: ```yaml # Example configuration.yaml entry @@ -45,20 +57,28 @@ Configuration variables: - **off_delay** (*Optional*): For sensors that only sends 'On' state updates, this variable sets a delay after which the sensor state will be updated back to 'Off'.-This component and the [rfxtrx switch](/components/switch/rfxtrx/) can steal each other's devices when setting the `automatic_add` configuration parameter to `true`. Set `automatic_add` only when you have some devices to add to your installation, otherwise leave it to `False`. +This component and the [rfxtrx switch](/components/switch/rfxtrx/) can steal each other's devices when setting the `automatic_add` configuration parameter to `true`. +Set `automatic_add` only when you have some devices to add to your installation, otherwise leave it to `false`.
-If a device ID consists of only numbers, please make sure to surround it with quotes. +If a device ID consists of only numbers, please make sure to surround it with quotes. This is a known limitation in YAML, because the device ID will be interpreted as a number otherwise.
-Binary sensors have only two states - "on" and "off". Many door or window opening sensors will send a signal each time the door/window is open or closed. However, depending on their hardware or on their purpose, some sensors are only able to signal their "on" state: +Binary sensors have only two states - "on" and "off". Many door or window +opening sensors will send a signal each time the door/window is open or closed. +However, depending on their hardware or on their purpose, +some sensors are only able to signal their "on" state: -- Most motion sensors send a signal each time they detect motion. They stay "on" for a few seconds and go back to sleep, ready to signal other motion events. Usually, they do not send a signal when they go back to sleep. +- Most motion sensors send a signal each time they detect motion. They stay "on" for a few seconds and go back to sleep, ready to signal other motion events. Usually, they do not send a signal when they go back to sleep. - Some doorbells may also only send "on" signals when their toggle switch is pressed, but no "off" signal when the switch is released. -For those devices, use the *off_delay* parameter. It defines a delay after which a device will go back to an "Off" state. That "Off" state will be fired internally by Home Assistant, just as if the device fired it by itself. If a motion sensor can only send signals once every 5 seconds, sets the *off_delay* parameter to *seconds: 5*. +For those devices, use the *off_delay* parameter. +It defines a delay after which a device will go back to an "Off" state. +That "Off" state will be fired internally by Home Assistant, just as if +the device fired it by itself. If a motion sensor can only send signals +once every 5 seconds, sets the *off_delay* parameter to *seconds: 5*. Example configuration: @@ -66,7 +86,7 @@ Example configuration: # Example configuration.yaml entry binary_sensor: platform: rfxtrx - automatic_add: True + automatic_add: true devices: 091300006ca2c6001080: name: motion_hall @@ -77,15 +97,22 @@ binary_sensor: ## Options for PT-2262 devices under the Lighting4 protocol -When a data packet is transmitted by a PT-2262 device using the Lighting4 protocol, there is no way to automatically extract the device identifier and the command from the packet. Each device has its own id/command length combination and the fields lengths are not included in the data. One device that sends 2 different commands will be seen as 2 devices on Home Assistant. For such cases, the following options are available in order to circumvent the problem: +When a data packet is transmitted by a PT-2262 device using the Lighting4 +protocol, there is no way to automatically extract the device identifier and the +command from the packet. Each device has its own id/command length combination +and the fields lengths are not included in the data. One device that sends 2 +different commands will be seen as 2 devices on Home Assistant. For such cases, +the following options are available in order to circumvent the problem: - **data_bits** (*Optional*): Defines how many bits are used for commands inside the data packets sent by the device. - **command_on** (*Optional*): Defines the data bits value that is sent by the device upon an 'On' command. - **command_off** (*Optional*): Defines the data bits value that is sent by the device upon an 'Off' command. -Let's try to add a new PT-2262 sensor using the "automatic_add" option and have a look at Home Assistant system log. +Let's try to add a new PT-2262 sensor using the "automatic_add" +option and have a look at Home Assistant system log. -Have your sensor trigger the "On" state for the first time. Some messages will appear: +Have your sensor trigger the "On" state for the first time. +Some messages will appear: ```text INFO (Thread-6) [homeassistant.components.binary_sensor.rfxtrx] Added binary sensor 0913000022670e013970 (Device_id: 22670e Class: LightingDevice Sub: 0) @@ -93,21 +120,27 @@ INFO (Thread-6) [homeassistant.components.binary_sensor.rfxtrx] Added binary sen Here the sensor has the id *22670e*. -Now have your sensor trigger the "Off" state and look for the following message in the Home Assistant log. You should see that your device has been detected as a *new* device when triggering its "Off" state: +Now have your sensor trigger the "Off" state and look for the following +message in the Home Assistant log. You should see that your device +has been detected as a *new* device when triggering its "Off" state: ```text INFO (Thread-6) [homeassistant.components.binary_sensor.rfxtrx] Added binary sensor 09130000226707013d70 (Device_id: 226707 Class: LightingDevice Sub: 0) ``` -Here the device id is *226707*, which is almost similar to the *22670e* we had on the "On" event a few seconds ago. +Here the device id is *226707*, which is almost similar to +the *22670e* we had on the "On" event a few seconds ago. -From those two values, you can guess that the actual id of your device is *22670*, and that *e* and *7* are commands for "On" and "Off" states respectively. As one hexadecimal digit uses 4 bits, we can conclude that the device is using 4 data bits. +From those two values, you can guess that the actual id of your device is +*22670*, and that *e* and *7* are commands for "On" and "Off" states +respectively. As one hexadecimal digit uses 4 bits, +we can conclude that the device is using 4 data bits. So here is the actual configuration section for the binary sensor: ```yaml platform: rfxtrx -automatic_add: True +automatic_add: true devices: 0913000022670e013b70: name: window_room2 @@ -117,7 +150,8 @@ devices: command_off: 0x7 ``` -The *automatic_add* option makes the rfxtrx binary sensor component calculate and display the configuration options for you in the Home Assistant logs: +The *automatic_add* option makes the rfxtrx binary sensor component calculate +and display the configuration options for you in the Home Assistant logs: ```text INFO (Thread-6) [homeassistant.components.rfxtrx] rfxtrx: found possible device 226707 for 22670e with the following configuration: @@ -127,12 +161,14 @@ command_off=0x7 INFO (Thread-6) [homeassistant.components.binary_sensor.rfxtrx] Found possible matching deviceid 22670e. ``` -This automatic guess should work most of the time but there is no guarantee on that. You should activate it only when you want -to configure your new devices and leave it off otherwise. +This automatic guess should work most of the time but there is +no guarantee on that. You should activate it only when you +want to configure your new devices and leave it off otherwise. ## Known working devices -The following devices are known to work with the rfxtrx binary sensor component. There are too many other to list. +The following devices are known to work with the rfxtrx binary sensor component. +There are too many other to list. - Motion detectors: - Kerui P817 and P829. diff --git a/source/_components/binary_sensor.template.markdown b/source/_components/binary_sensor.template.markdown index 7cc7af6285f..d2365b7638c 100644 --- a/source/_components/binary_sensor.template.markdown +++ b/source/_components/binary_sensor.template.markdown @@ -11,6 +11,7 @@ ha_category: Binary Sensor ha_release: 0.12 ha_iot_class: "Local Push" logo: home-assistant.png +ha_qa_scale: internal --- The `template` platform supports sensors which breaks out the `state` and @@ -93,7 +94,7 @@ result: ## {% linkable_title Examples %} -In this section you find some real life examples of how to use this sensor. +In this section you find some real-life examples of how to use this sensor. ### {% linkable_title Sensor Threshold %} diff --git a/source/_components/binary_sensor.threshold.markdown b/source/_components/binary_sensor.threshold.markdown index a33b404772c..a512fff4d2f 100644 --- a/source/_components/binary_sensor.threshold.markdown +++ b/source/_components/binary_sensor.threshold.markdown @@ -11,6 +11,7 @@ logo: home-assistant.png ha_category: Utility ha_iot_class: "Local Polling" ha_release: 0.34 +ha_qa_scale: internal --- diff --git a/source/_components/binary_sensor.trend.markdown b/source/_components/binary_sensor.trend.markdown index 7530a164e80..f110c9ca04c 100644 --- a/source/_components/binary_sensor.trend.markdown +++ b/source/_components/binary_sensor.trend.markdown @@ -11,13 +11,19 @@ ha_category: Utility logo: home-assistant.png ha_release: 0.28 ha_iot_class: "Local Push" +ha_qa_scale: internal --- -The `trend` platform allows you to create sensors which show the trend of numeric `state` or`state_attributes` from other entities. This sensor requires at least two updates of the underlying sensor to establish a trend. Thus it can take some time to show an accurate state. It can be useful as part of automations, where you want to base an action on a trend. +The `trend` platform allows you to create sensors which show the trend of +numeric `state` or`state_attributes` from other entities. This sensor requires +at least two updates of the underlying sensor to establish a trend. +Thus it can take some time to show an accurate state. It can be useful +as part of automations, where you want to base an action on a trend. ## {% linkable_title Configuration %} -To enable Trend binary sensors in your installation, add the following to your `configuration.yaml` file: +To enable Trend binary sensors in your installation, +add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry @@ -28,31 +34,80 @@ binary_sensor: entity_id: sensor.cpu_speed ``` -Configuration variables: - -- **sensors** array (*Required*): List of your sensors. - - **entity_id** (*Required*): The entity that this sensor tracks. - - **attribute** (*Optional*): The attribute of the entity that this sensor tracks. If no attribute is specified then the sensor will track the state. - - **device_class** (*Optional*): The [type/class](/components/binary_sensor/) of the sensor to set the icon in the frontend. - - **friendly_name** (*Optional*): Name to use in the Frontend. - - **invert** (*Optional*): Invert the result. A `true` value would mean descending rather than ascending. Defaults to `False` - - **max_samples** (*Optional*): Limit the maximum number of stored samples. Defaults to `2`. - - **min_gradient** (*Optional*): The minimum rate at which the observed value must be changing for this sensor to switch on. The gradient is measured in sensor units per second. Defaults to `0.0` - - **sample_duration** (*Optional*): The duration **in seconds** to store samples for. Samples older than this value will be discarded. Defaults to `0` +{% configuration %} +sensors: + description: List of your sensors. + required: true + type: map + keys: + entity_id: + description: The entity that this sensor tracks. + required: true + type: string + attribute: + description: > + The attribute of the entity that this sensor tracks. + If no attribute is specified then the sensor will track the state. + required: false + type: string + device_class: + description: > + The [type/class](/components/binary_sensor/) of + the sensor to set the icon in the frontend. + required: false + type: string + friendly_name: + description: Name to use in the Frontend. + required: false + type: string + invert: + description: > + Invert the result. A `true` value would + mean descending rather than ascending. + required: false + type: boolean + default: false + max_samples: + description: Limit the maximum number of stored samples. + required: false + type: integer + default: 2 + min_gradient: + description: > + The minimum rate at which the observed value + must be changing for this sensor to switch on. + The gradient is measured in sensor units per second. + required: false + type: string + default: 0.0 + sample_duration: + description: > + The duration **in seconds** to store samples for. + Samples older than this value will be discarded. + required: false + type: integer + default: 0 +{% endconfiguration %} ## {% linkable_title Using Multiple Samples %} -If the optional `sample_duration` and `max_samples` parameters are specified then multiple samples can be stored and used to detect long-term trends. +If the optional `sample_duration` and `max_samples` parameters are specified +then multiple samples can be stored and used to detect long-term trends. -Each time the state changes, a new sample is stored along with the sample time. Samples older than `sample_duration` seconds will be discarded. +Each time the state changes, a new sample is stored along with the sample time. +Samples older than `sample_duration` seconds will be discarded. -A trend line is then fitted to the available samples, and the gradient of this line is compared to `min_gradient` to determine the state of the trend sensor. The gradient is measured in sensor units per second - so if you want to know when the temperature is falling by 2 degrees per hour, use a gradient of (-2) / (60 x 60) = -0.00055 +A trend line is then fitted to the available samples, and the gradient of this +line is compared to `min_gradient` to determine the state of the trend sensor. +The gradient is measured in sensor units per second - so if you want to know +when the temperature is falling by 2 degrees per hour, +use a gradient of (-2) / (60 x 60) = -0.00055 The current number of stored samples is displayed on the States page. ## {% linkable_title Examples %} -In this section you find some real life examples of how to use this sensor. +In this section you find some real-life examples of how to use this sensor. This example indicates `true` if the sun is still rising: @@ -65,8 +120,9 @@ binary_sensor: attribute: elevation ``` - -This example creates two sensors to indicate whether the temperature is rising or falling at a rate of at least 3 degrees an hour, and collects samples over a two hour period: +This example creates two sensors to indicate whether the temperature is +rising or falling at a rate of at least 3 degrees an hour, +and collects samples over a two hour period: ```yaml binary_sensor: diff --git a/source/_components/binary_sensor.wirelesstag.markdown b/source/_components/binary_sensor.wirelesstag.markdown index efe3eae81f4..a98a129255b 100644 --- a/source/_components/binary_sensor.wirelesstag.markdown +++ b/source/_components/binary_sensor.wirelesstag.markdown @@ -15,6 +15,8 @@ ha_release: 0.68 To get your [wirelesstag.net](http://wirelesstag.net) binary sensors working within Home Assistant, please follow the instructions for the general [WirelessTag component](/components/wirelesstag). +## {% linkable_title Configuration %} + To enable tags set up with your [wirelesstag.net](http://wirelesstag.net) account, add the following to your `configuration.yaml` file: ```yaml @@ -24,25 +26,34 @@ binary_sensor: monitored_conditions: - presence - door - - low_battery + - battery ``` {% configuration %} - monitored_conditions: - description: The conditions types to monitor; valid values are specified below - required: true - type: list +monitored_conditions: + description: The conditions types to monitor. + required: true + type: list + keys: + presence: + description: On means in range, Off means out of range. + motion: + description: On when a movement was detected, Off when clear. + door: + description: On when a door is open, Off when the door is closed. + cold: + description: On means temperature become too cold, Off means normal. + heat: + description: On means hot, Off means normal. + dry: + description: On means too dry (humidity), Off means normal. + wet: + description: On means too wet (humidity), Off means normal. + light: + description: On means light detected, Off means no light. + moisture: + description: On means moisture detected (wet), Off means no moisture (dry). + battery: + description: On means tag battery is low, Off means normal. {% endconfiguration %} -The following conditions can be monitored: - -* (`presence`): On means in range, Off means out of range. -* (`motion`): On when a movement was detected, Off when clear. -* (`door`): On when a door is open, Off when the door is closed. -* (`cold`): On means temperature become too cold, Off means normal. -* (`heat`): On means hot, Off means normal. -* (`dry`): On means too dry (humidity), Off means normal. -* (`wet`): On means too wet (humidity), Off means normal. -* (`light`): On means light detected, Off means no light. -* (`moisture`): On means moisture detected (wet), Off means no moisture (dry). -* (`low_battery`): On means tag battery is low, Off means normal. diff --git a/source/_components/binary_sensor.workday.markdown b/source/_components/binary_sensor.workday.markdown index 21280a72ba4..c589e08bcfd 100644 --- a/source/_components/binary_sensor.workday.markdown +++ b/source/_components/binary_sensor.workday.markdown @@ -11,15 +11,22 @@ logo: home-assistant.png ha_category: Utility ha_iot_class: "Local Polling" ha_release: 0.41 +ha_qa_scale: internal --- -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. +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. +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: +To enable the `workday` sensor in your installation, +add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry @@ -29,20 +36,50 @@ binary_sensor: workdays: [mon, wed, fri] ``` -Configuration variables: +{% configuration %} +name: + description: A name for this sensor. + required: false + type: string + default: Workday Sensor +country: + description: > + Country code according to + [holidays](https://pypi.python.org/pypi/holidays/0.9.4) notation. + required: true + type: string +province: + description: > + Province code according to + [holidays](https://pypi.python.org/pypi/holidays/0.9.4) notation. + required: false + type: string +workdays: + description: List of workdays. + required: false + type: list + default: "[mon, tue, wed, thu, fri]" +excludes: + description: List of workday excludes. + required: false + type: list + default: "[sat, sun, holiday]" +days_offset: + description: Set days offset. + required: false + type: integer + default: 0 +{% endconfiguration %} -- **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.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`. - -Days are specified as follows: `mon`, `tue`, `wed`, `thu`, `fri`, `sat`, `sun`. The keyword `holiday` is used for public holidays identified by the holidays module. +Days are specified as follows: `mon`, `tue`, `wed`, `thu`, `fri`, `sat`, `sun`. +The keyword `holiday` is used for public +holidays identified by the holidays module.-If you use the sensor for Norway (`NO`) you need to wrap `NO`in quotes or write the name in full. Otherwise the value is evaluated as `False`. -If you use the sensor for Canada (`CA`) with Ontario (`ON`) as `province:` then you need to wrap `ON` in quotes. Otherwise the value is evaluated as `True` (check the YAML documentation for further details) and the sensor will not work. +If you use the sensor for Norway (`NO`) you need to wrap `NO` in quotes or write the name in full. +Otherwise the value is evaluated as `false`. +If you use the sensor for Canada (`CA`) with Ontario (`ON`) as `province:` then you need to wrap `ON` in quotes. +Otherwise the value is evaluated as `true` (check the YAML documentation for further details) and the sensor will not work.
Example usage for automation: diff --git a/source/_components/binary_sensor.zigbee.markdown b/source/_components/binary_sensor.zigbee.markdown index 233ebb2a91a..60f8aac30e1 100644 --- a/source/_components/binary_sensor.zigbee.markdown +++ b/source/_components/binary_sensor.zigbee.markdown @@ -25,10 +25,22 @@ binary_sensor: pin: 0 ``` -Configuration variables: - -- **name** (*Required*): The name you would like to give the binary sensor in Home Assistant. -- **pin** (*Required*): The number identifying which pin to use. -- **address** (*Optional*): The long 64-bit address of the remote ZigBee device whose digital input pin you'd like to sample. Do not include this variable if you want to sample the local ZigBee device's pins. -- **on_state** (*Optional*): Either `high` (default) or `low`, depicting whether the binary sensor is considered `on` when the pin is `high` or `low`. - +{% configuration %} +name: + description: The name you would like to give the binary sensor in Home Assistant. + required: true + type: string +pin: + description: The number identifying which pin to use. + required: true + type: integer +address: + description: The long 64-bit address of the remote ZigBee device whose digital input pin you'd like to sample. Do not include this variable if you want to sample the local ZigBee device's pins. + required: false + type: string +on_state: + description: Either `high` or `low`, depicting whether the binary sensor is considered `on` when the pin is `high` or `low`. + required: false + default: high + type: string +{% endconfiguration %} diff --git a/source/_components/blink.markdown b/source/_components/blink.markdown index 170dcff9e86..a764ec59ab7 100644 --- a/source/_components/blink.markdown +++ b/source/_components/blink.markdown @@ -13,9 +13,11 @@ ha_release: "0.40" ha_iot_class: "Cloud Polling" --- -The `blink` component lets you view camera images and motion events from [Blink](http://blinkforhome.com) camera and security systems. +The `blink` component lets you view camera images and motion events +from [Blink](http://blinkforhome.com) camera and security systems. -You will need your Blink login information (username, usually you email address, and password) to use this module. +You will need your Blink login information (username, which is +usually your email address, and password) to use this module. ## {% linkable_title Configuration %} diff --git a/source/_components/bmw_connected_drive.markdown b/source/_components/bmw_connected_drive.markdown index 56432369dd8..ce7688c9d9d 100644 --- a/source/_components/bmw_connected_drive.markdown +++ b/source/_components/bmw_connected_drive.markdown @@ -12,10 +12,17 @@ ha_category: Car ha_release: 0.64 --- -The `bmw_connected_drive` 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. +The `bmw_connected_drive` component lets you retrieve data of 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/m1n3rva/bimmer_connected) on github. +This component provides the following platforms: + + - Binary Sensors: Doors, windows, condition based services, check control messages, parking lights, door lock state, charging status (electric cars) and connections status (electric cars). + - Device tracker: The location of your car. + - Lock: Control the lock of your car. + - Sensors: Mileage, remaining range, remaining fuel, charging time remaing (electric cars), charging status (electric cars), remaing range electric (electric cars). + To enable this component in your installation, add the following to your `configuration.yaml` file: @@ -25,7 +32,7 @@ bmw_connected_drive: name: username: USERNAME_BMW_CONNECTED_DRIVE password: PASSWORD_BMW_CONNECTED_DRIVE - region: one of "north_america", "china" , "rest_of_world" + region: one of "north_america", "china", "rest_of_world" ``` {% configuration %} @@ -47,7 +54,7 @@ bmw_connected_drive: required: true type: string region: - description: "The region of your Connected Drive account. Please use of these values: `north_america`, `china`, `rest_of_world`" + description: "The region of your Connected Drive account. Please use one of these values: `north_america`, `china`, `rest_of_world`" required: true type: string read_only: @@ -77,15 +84,15 @@ 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`. +The service `bmw_connected_drive.sound_horn` sounds the horn of the vehicle. This option is not available in some countries (among which the UK). 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`. +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. +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. diff --git a/source/_components/browser.markdown b/source/_components/browser.markdown index 6325fef367a..7edd741593f 100644 --- a/source/_components/browser.markdown +++ b/source/_components/browser.markdown @@ -9,6 +9,7 @@ sharing: true footer: true logo: home-assistant.png ha_category: Utility +ha_qa_scale: internal --- diff --git a/source/_components/calendar.caldav.markdown b/source/_components/calendar.caldav.markdown index 8ea6b6ad087..8f27342be6c 100644 --- a/source/_components/calendar.caldav.markdown +++ b/source/_components/calendar.caldav.markdown @@ -12,14 +12,22 @@ ha_iot_class: "Cloud Polling" ha_release: "0.60" --- - -The `caldav` platform allows you to connect to your WebDav calendar and generate binary sensors. A different sensor will be created for each individual calendar, or you can specify custom calendars which match a criteria you define (more on that below). These sensors will be `on` if you have an on going event in that calendar or `off` if the event is later in time, or if there is no event at all. The WebDav calendar get updated roughly every 15 minutes. +The `caldav` platform allows you to connect to your WebDav calendar and generate +binary sensors. A different sensor will be created for each individual calendar, +or you can specify custom calendars which match a criteria you define (more on +that below). These sensors will be `on` if you have an on going event in that +calendar or `off` if the event is later in time, or if there is no event at all. +The WebDav calendar get updated roughly every 15 minutes. ### {% linkable_title Prerequisites %} -You need to have a CalDav server and credentials for it. This component was tested against [Baikal](http://sabre.io/baikal/) but any component complying with the RFC4791 should work. [Nextcloud](https://nextcloud.com/) and [Owncloud](https://owncloud.org/) work fine. +You need to have a CalDav server and credentials for it. This component was +tested against [Baikal](http://sabre.io/baikal/) but any component complying +with the RFC4791 should work. [Nextcloud](https://nextcloud.com/) +and [Owncloud](https://owncloud.org/) work fine. -You might need some additional system packages to compile the Python caldav library. On a Debian based system, install them by: +You might need some additional system packages to compile the +Python caldav library. On a Debian based system, install them by: ```bash $ sudo apt-get install libxml2-dev libxslt1-dev zlib1g-dev @@ -27,7 +35,8 @@ $ sudo apt-get install libxml2-dev libxslt1-dev zlib1g-dev ### {% linkable_title Basic Setup %} -To integrate a WebDav calendar in Home Assistant, add the following section to your `configuration.yaml` file: +To integrate a WebDav calendar in Home Assistant, +add the following section to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry for baikal @@ -47,12 +56,16 @@ calendar: url: https://nextcloud.example.com/remote.php/dav ``` -This example will generate default binary sensors for each calendar you have in your account. Those calendars will be `on` when there is an ongoing event and `off` if not. Events that last a whole day are ignored in those calendars. You have to setup custom calendars in order to take them into account or for advanced event filtering. - +This example will generate default binary sensors for each calendar you have in +your account. Those calendars will be `on` when there is an ongoing event and +`off` if not. Events that last a whole day are ignored in those calendars. +You have to setup custom calendars in order to take them into account or for +advanced event filtering. ### {% linkable_title Custom calendars %} -You have the possibility to create multiple binary sensors for events that match certain conditions. +You have the possibility to create multiple binary +sensors for events that match certain conditions. ```yaml # Example configuration.yaml entry @@ -70,9 +83,13 @@ calendar: search: 'Warmup' ``` -This will create two binary sensors for the calendar name Agenda: "HomeOffice" and "WarmupFlat". Those sensors will be `on` if there is an ongoing event matching the regular expression specified in `search`. In custom calendars, events that last a whole day are taken into account. +This will create two binary sensors for the calendar name Agenda: "HomeOffice" +and "WarmupFlat". Those sensors will be `on` if there is an ongoing event +matching the regular expression specified in `search`. +In custom calendars, events that last a whole day are taken into account. -Please note that when you configure custom calendars, the default ones are not created anymore. +Please note that when you configure custom calendars, +the default ones are not created anymore. {% configuration %} url: @@ -89,7 +106,9 @@ password: type: string calendars: required: false - description: List of the calendars to filter. Empty or absent means no filtering, i.e. all calendars will be added. + description: > + List of the calendars to filter. + Empty or absent means no filtering, i.e. all calendars will be added. type: list custom_calendars: required: false @@ -106,11 +125,12 @@ custom_calendars: type: string search: required: true - description: Regular expression for filtering the events based on the content of their summary, description or location. + description: > + Regular expression for filtering the events based on + the content of their summary, description or location. type: string {% endconfiguration %} - ### {% 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 !!-10 would trigger this attribute to be on 10 minutes before the event starts. @@ -136,9 +156,12 @@ calendar: - holidays ``` -Full example with automation to wake up to music if not holiday. Prerequisite: you have a calendar named "work" where you create calendar entries containing "Holiday". +Full example with automation to wake up to music if not holiday. +Prerequisite: you have a calendar named "work" where +you create calendar entries containing "Holiday". -Custom calendar names are built from the main calendar + name of the custom calendar. +Custom calendar names are built from the +main calendar + name of the custom calendar. ```yaml # configuration.yaml @@ -165,5 +188,4 @@ calendar: - condition: state entity_id: calendar.work_holiday state: 'off' - ``` diff --git a/source/_components/calendar.google.markdown b/source/_components/calendar.google.markdown index d44f7d9ff5e..1c074f5ed81 100644 --- a/source/_components/calendar.google.markdown +++ b/source/_components/calendar.google.markdown @@ -13,12 +13,17 @@ ha_iot_class: "Cloud Polling" ha_release: 0.33 --- - -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. +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 %} -Generate a Client ID and Client Secret on [Google Developers Console](https://console.developers.google.com/start/api?id=calendar). +Generate a Client ID and Client Secret on +[Google Developers Console](https://console.developers.google.com/start/api?id=calendar). 1. Follow the wizard using the following information. 1. When it gets to the point of asking _Which API are you using?_ just click cancel. @@ -32,7 +37,8 @@ Generate a Client ID and Client Secret on [Google Developers Console](https://co ## {% linkable_title Configuration %} -To integrate Google Calendar in Home Assistant, add the following section to your `configuration.yaml` file: +To integrate Google Calendar in Home Assistant, +add the following section to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry @@ -51,7 +57,9 @@ client_secret: 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. + 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 @@ -59,7 +67,10 @@ track_new_calendar: 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. +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 %} @@ -86,23 +97,61 @@ A basic entry for a single calendar looks like: search: "#UnImportant" ``` -Variables: +{% configuration %} +cal_id: + description: The Google *generated* unique id for this calendar. + required: true + type: string + default: "**DO NOT CHANGE THE DEFAULT VALUE**" +entities: + description: Yes, you can have multiple sensors for a calendar! + required: true + type: list + keys: + device_id: + description: > + The name that all your automations/scripts + will use to reference this device. + required: true + type: string + name: + description: What is the name of your sensor that you'll see in the frontend. + required: true + type: string + track: + description: "Should we create a sensor `true` or ignore it `false`?" + required: true + type: boolean + search: + description: If set will only trigger for matched events. + required: false + type: string + offset: + description: > + A set of characters that precede a number in the event title + for designating a pre-trigger state change on the sensor. + required: false + type: string + default: "!!" + ignore_availability: + description: "Should we respect `free`/`busy` flags?" + required: false + type: boolean + default: true +{% endconfiguration %} -- **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_availability**: (*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. -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. +But what if you only wanted it to toggle based on all events? +Just leave out the *search* parameter.-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 %} @@ -114,3 +163,28 @@ If you use a `#` sign for `search` then wrap the whole search term in quotes. Ot - **location**: The event Location. - **start_time**: Start time of event. - **end_time**: End time of event. + +## {% linkable_title Using calendar in automations %} + +A calendar can be used as an external scheduler for special events or reoccurring events instead of hardcoding them in automations. + +Trigger as soon as an event starts: + +```yaml + trigger: + platform: state + entity_id: calendar.calendar_name + to: 'on' +``` + +By using specific text in the event title, you can set conditions to initiate particular automation flows on designated events while other events will be ignored. + +For example, the actions following this condition will only be executed for events named 'vacation': + +{% raw %} +```yaml + condition: + condition: template + value_template: "{{states.calendar.calendar_name.attributes.message == 'vacation' }}" +``` +{% endraw %} diff --git a/source/_components/camera.generic.markdown b/source/_components/camera.generic.markdown index e8c457086f5..99f7e03aa7e 100644 --- a/source/_components/camera.generic.markdown +++ b/source/_components/camera.generic.markdown @@ -48,7 +48,7 @@ Configuration variables: ## {% linkable_title Examples %} -In this section you find some real life examples of how to use this camera platform. +In this section you find some real-life examples of how to use this camera platform. ### {% linkable_title Weather graph from yr.no %} diff --git a/source/_components/camera.local_file.markdown b/source/_components/camera.local_file.markdown index b2b953041dd..cb870409c10 100644 --- a/source/_components/camera.local_file.markdown +++ b/source/_components/camera.local_file.markdown @@ -26,10 +26,16 @@ camera: file_path: /tmp/image.jpg ``` -Configuration variables: - - - **file_path** (*Required*): File to serve as the camera. - - **name** (*Optional*): Name of the camera +{% configuration %} +file_path: + description: File to serve as the camera. + required: true + type: string +name: + description: Name of the camera. + required: false + type: string +{% endconfiguration %} ### {% linkable_title Service `camera.local_file_update_file_path` %} diff --git a/source/_components/camera.mjpeg.markdown b/source/_components/camera.mjpeg.markdown index a3ebf512343..f87595dfc6b 100644 --- a/source/_components/camera.mjpeg.markdown +++ b/source/_components/camera.mjpeg.markdown @@ -13,10 +13,11 @@ ha_release: pre 0.7 ha_iot_class: "depends" --- +The `mjpeg` camera platform allows you to integrate IP cameras which are capable +to stream their video with MJPEG into Home Assistant. -The `mjpeg` camera platform allows you to integrate IP cameras which are capable to stream their video with MJPEG into Home Assistant. - -To enable this camera in your installation, add the following to your `configuration.yaml` file: +To enable this camera in your installation, +add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry @@ -25,14 +26,33 @@ camera: mjpeg_url: http://192.168.1.92/mjpeg ``` -Configuration variables: - -- **mjpeg_url** (*Required*): The URL your camera serves the video on, eg. http://192.168.1.21:2112/ -- **still_image_url** (*Optional*): The URL for thumbnail picture if camera support that. -- **name** (*Optional*): This parameter allows you to override the name of your camera. -- **username** (*Optional*): The username for accessing your camera. -- **password** (*Optional*): The password for accessing your camera. -- **authentication** (*Optional*): `basic` (default) or `digest` auth for requests. +{% configuration %} +mjpeg_url: + description: The URL your camera serves the video on, eg. http://192.168.1.21:2112/ + required: true + type: string +still_image_url: + description: The URL for thumbnail picture if camera support that. + required: false + type: string +name: + description: This parameter allows you to override the name of your camera. + required: false + type: string +username: + description: The username for accessing your camera. + required: false + type: string +password: + description: The password for accessing your camera. + required: false + type: string +authentication: + description: "`basic` or `digest` auth for requests." + required: false + type: string + default: basic +{% endconfiguration %} ## {% linkable_title Examples %} diff --git a/source/_components/camera.mqtt.markdown b/source/_components/camera.mqtt.markdown index 411a37d19de..c7db3ae4ac2 100644 --- a/source/_components/camera.mqtt.markdown +++ b/source/_components/camera.mqtt.markdown @@ -26,9 +26,19 @@ camera: topic: zanzito/shared_locations/my-device ``` -Configuration variables: - - - **topic** (*Required*): MQTT topic to subscribe to. - - **name** (*Optional*): Name of the camera - - **unique_id** (*Optional*): An ID that uniquely identifies this camera. If two cameras have the same unique ID, Home Assistant will raise an exception. - +{% configuration %} + topic: + description: MQTT topic to subscribe to. + required: true + type: string + name: + description: Name of the camera. + required: false + type: string + unique_id: + description: > + An ID that uniquely identifies this camera. If two cameras have the same unique ID + Home Assistant will raise an exception. + required: false + type: string +{% endconfiguration %} diff --git a/source/_components/camera.rpi_camera.markdown b/source/_components/camera.rpi_camera.markdown index b6fc4094c09..0cc4eaa01c0 100644 --- a/source/_components/camera.rpi_camera.markdown +++ b/source/_components/camera.rpi_camera.markdown @@ -31,7 +31,7 @@ image_width: description: Set the image width. required: false default: 640 - type: int + type: integer name: description: Name of the camera. required: false @@ -41,32 +41,32 @@ image_height: description: Set the image height. required: false default: 480 - type: int + type: integer image_quality: description: Set the image quality (from 0 to 100). required: false default: 7 - type: int + type: integer image_rotation: description: Set image rotation (0-359). required: false default: 0 - type: int + type: integer horizontal_flip: description: Set horizontal flip (0 to disable, 1 to enable). required: false default: 0 - type: int + type: integer vertical_flip: description: Set vertical flip (0 to disable, 1 to enable). required: false default: 0 - type: int + type: integer timelapse: description: Takes a picture every this many milliseconds (thousands of a second) - the default means one picture a second. required: false default: 1000 - type: int + type: integer file_path: description: Save the picture in a custom file path. required: false diff --git a/source/_components/camera.uvc.markdown b/source/_components/camera.uvc.markdown index 6c924446cc2..d83f1457e87 100644 --- a/source/_components/camera.uvc.markdown +++ b/source/_components/camera.uvc.markdown @@ -21,7 +21,7 @@ The platform connects to the Unifi NVR software and automatically discovers/adds It is recommended that you create a new user for this platform in the NVR software and only give the user the permissions it need to operate. -- The API key is found in the specific user's `API Access` tab in the NVR software. +- The API key is found in `User` -> `My account` -> `API Access` in the NVR software. - The camera password is found in `Settings` -> `Camera Settings` -> `Camera Password` in the NVR software. ### {% linkable_title Configuration %} @@ -44,7 +44,7 @@ nvr: port: description: The port number to use for accessing the NVR. required: false - type: int + type: integer default: 7080 key: description: The API key available from the NVR web interface. diff --git a/source/_components/camera.xiaomi.markdown b/source/_components/camera.xiaomi.markdown index d326e7b9c20..14c4f935686 100644 --- a/source/_components/camera.xiaomi.markdown +++ b/source/_components/camera.xiaomi.markdown @@ -13,7 +13,7 @@ ha_release: 0.72 ha_iot_class: "Local Polling" --- -The `Xiaomi` camera platform allows you to utilize Xiaomi Cameras within Home Assistant. +The `Xiaomi` camera platform allows you to utilize Xiaomi Cameras within Home Assistant. To successfully implement this platform, the Home Assistant host should be capable of multiple simultaneous reads. For every concurrent Home Assistant user, a connection will be made to the camera every 10 seconds. This should normally not be a problem. @@ -53,18 +53,42 @@ camera: name: Camera host: '192.168.1.100' model: 'yi' - password: my_password_123 + password: YOUR_PASSWORD ``` -Configuration variables: - -- **name** (*Required*): A human-friendly name for the camera. -- **host** (*Required*): The IP address or hostname of the camera. -- **model** (*Required*): The model of Xiaomi Camera, currently supporting yi and xiaofang. -- **password** (*Required*): The password to the FTP server on the camera (from above), can be any string as the current firmware doesn't allow setting ftp passwords. -- **path** (*Optional*): The path to the raw MP4 files. Defaults to `/media/mmcblk0p1/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). +{% configuration %} +name: + description: A human-friendly name for the camera. + required: true + type: string +host: + description: The IP address or hostname of the camera. + required: true + type: string +model: + description: The model of Xiaomi Camera, currently supporting yi and xiaofang. + required: true + type: string +password: + description: The password to the FTP server on the camera (from above), can be any string as the current firmware doesn't allow setting ftp passwords. + required: true + type: string +path: + description: The path to the raw MP4 files. + required: false + default: /media/mmcblk0p1/record + type: string +username: + description: The user that can access the FTP server. + required: false + default: root + type: string +ffmpeg_arguments: + description: > + Extra options to pass to `ffmpeg` + required: false + type: string +{% endconfiguration %}The default for `path:` will not work with all cameras. It may be needed that you add that key with the exact path for your device. @@ -82,7 +106,7 @@ camera: name: My Camera host: '192.168.1.100' model: 'xiaofang' - password: my_password_123 + password: YOUR_PASSWORD path: /home/camera/feed ffmpeg_arguments: '-vf scale=800:450' ``` diff --git a/source/_components/canary.markdown b/source/_components/canary.markdown index 186d704e17e..d9805b5edff 100644 --- a/source/_components/canary.markdown +++ b/source/_components/canary.markdown @@ -40,7 +40,7 @@ canary: timeout: description: Timeout to wait for connections. required: false - type: int + type: integer default: 10 {% endconfiguration %} diff --git a/source/_components/cast.markdown b/source/_components/cast.markdown index 7243ad78a09..1bd86aef388 100644 --- a/source/_components/cast.markdown +++ b/source/_components/cast.markdown @@ -15,15 +15,20 @@ ha_iot_class: "Local Polling" redirect_from: /components/media_player.cast/ --- - -Google Cast devices like Android TVs and Chromecasts will be automatically discovered if you enable [the discovery component]({{site_root}}/components/discovery/). If you don't have the discovery component enabled, you can enable the Cast component by going to the Integrations page inside the config panel. +Google Cast devices like Android TVs and Chromecasts will be automatically +discovered if you enable [the discovery component](/components/discovery/). If +you don't have the discovery component enabled, you can enable the Cast +component by going to the Integrations page inside the config panel. ## {% linkable_title Advanced use %} -The Cast component has some extra configuration options available for advanced users. You will still need to create a config entry to initialize the Cast component. - -For example, Cast devices can only be discovered if they are on the same subnet as Home Assistant. If this is not the case, you want to configure the IP address of the Cast device directly: +The Cast component has some extra configuration options available for advanced +users. You will still need to create a config entry to initialize the Cast +component. +For example, Cast devices can only be discovered if they are on the same subnet +as Home Assistant. If this is not the case, +you want to configure the IP address of the Cast device directly: ```yaml # Example configuration.yaml entry @@ -32,7 +37,31 @@ cast: - host: 192.168.1.10 ``` -Configuration variables: +{% configuration %} +media_player: + description: A list that contains all Cast devices. + required: true + type: list + keys: + host: + description: Use only if you don't want to scan for devices. + required: false + type: string + ignore_cec: + description: > + A list of Chromecasts that should ignore CEC data for determining the + active input. [See the upstream documentation for more information.](https://github.com/balloob/pychromecast#ignoring-cec-data) + required: false + type: list +{% endconfiguration %} -- **host** (*Optional*): Use only if you don't want to scan for devices. -- **ignore_cec** (*Optional*) A list of Chromecasts that should ignore CEC data for determining the active input. [See the upstream documentation for more information.](https://github.com/balloob/pychromecast#ignoring-cec-data) +If you want to manually configure multiple Cast media players, you can define +those as follows: + +```yaml +# Example configuration.yaml entry for multiple devices +cast: + media_player: + - host: IP_ADDRESS_DEVICE_1 + - host: IP_ADDRESS_DEVICE_2 +``` diff --git a/source/_components/climate.generic_thermostat.markdown b/source/_components/climate.generic_thermostat.markdown index 91d5d269252..274ac0377f9 100644 --- a/source/_components/climate.generic_thermostat.markdown +++ b/source/_components/climate.generic_thermostat.markdown @@ -14,7 +14,7 @@ ha_iot_class: "Local Polling" --- -The `generic_thermostat` climate platform is a thermostat implemented in Home Assistant. It uses a sensor and a switch connected to a heater or air conditioning under the hood. When in heater mode, if the measured temperature is cooler then the target temperature, the heater will be turned on and turned off when the required temperature is reached. When in air conditioning mode, if the measured temperature is hotter then the target temperature, the air conditioning will be turned on and turned off when required temperature is reached. +The `generic_thermostat` climate platform is a thermostat implemented in Home Assistant. It uses a sensor and a switch connected to a heater or air conditioning under the hood. When in heater mode, if the measured temperature is cooler then the target temperature, the heater will be turned on and turned off when the required temperature is reached. When in air conditioning mode, if the measured temperature is hotter then the target temperature, the air conditioning will be turned on and turned off when required temperature is reached. One Generic Thermostat entity can only control one switch. If you need to activate two switches, one for a heater and one for an air conditioner, you will need two Generic Thermostat entities. ```yaml # Example configuration.yaml entry diff --git a/source/_components/climate.modbus.markdown b/source/_components/climate.modbus.markdown index 164ae4a4877..77d62c2cf86 100644 --- a/source/_components/climate.modbus.markdown +++ b/source/_components/climate.modbus.markdown @@ -38,15 +38,15 @@ name: slave: description: The number of the slave (Optional for tcp and upd Modbus, use 1). required: true - type: int + type: integer target_temp_register: description: Register number for target temperature (Setpoint). required: true - type: int + type: integer current_temp_register: description: Register number for current temperature (Process value). required: true - type: int + type: integer data_type: description: Response representation (int, uint, float, custom). If float selected, value will converted to IEEE 754 floating point format. required: false @@ -55,11 +55,11 @@ data_type: count: description: Number of registers to read. required: false - type: int + type: integer precision: description: Number of valid decimals. required: false - type: int + type: integer default: 0 {% endconfiguration %} diff --git a/source/_components/climate.mqtt.markdown b/source/_components/climate.mqtt.markdown index c9179e230b9..96f98766b54 100644 --- a/source/_components/climate.mqtt.markdown +++ b/source/_components/climate.mqtt.markdown @@ -86,6 +86,10 @@ current_temperature_topic: description: The MQTT topic on which to listen for the current temperature. required: false type: string +current_temperature_template: + description: A template with which the value received on `current_temperature_topic` will be rendered. + required: false + type: template power_command_topic: description: The MQTT topic to publish commands to change the power state. This is useful if your device has a separate power toggle in addition to mode. required: false @@ -102,6 +106,11 @@ mode_state_template: description: A template to render the value received on the `mode_state_topic` with. required: false type: template +modes: + description: A list of supported modes. + required: false + default: ['auto', 'off', 'cool', 'heat', 'dry', 'fan_only'] + type: list temperature_command_topic: description: The MQTT topic to publish commands to change the target temperature. required: false @@ -126,6 +135,11 @@ fan_mode_state_template: description: A template to render the value received on the `fan_mode_state_topic` with. required: false type: template +fan_modes: + description: A list of supported fan modes. + required: false + default: ['auto', 'low', 'medium', 'high'] + type: list swing_mode_command_topic: description: The MQTT topic to publish commands to change the swing mode. required: false @@ -138,6 +152,11 @@ swing_mode_state_template: description: A template to render the value received on the `swing_mode_state_topic` with. required: false type: template +swing_modes: + description: A list of supported swing modes. + required: false + default: ['on', 'off'] + type: list away_mode_command_topic: description: The MQTT topic to publish commands to change the away mode. required: false diff --git a/source/_components/climate.venstar.markdown b/source/_components/climate.venstar.markdown index 253e8700675..7667b735434 100644 --- a/source/_components/climate.venstar.markdown +++ b/source/_components/climate.venstar.markdown @@ -65,7 +65,7 @@ ssl: timeout: description: Number of seconds for API timeout. required: false - type: int + type: integer default: 5 humidifier: description: Report humidity and expose humidifier setpoints. diff --git a/source/_components/climate.zhong_hong.markdown b/source/_components/climate.zhong_hong.markdown index da1eeb6428a..5d7d14d7919 100644 --- a/source/_components/climate.zhong_hong.markdown +++ b/source/_components/climate.zhong_hong.markdown @@ -33,12 +33,12 @@ port: description: The port of your controller. required: false default: 9999 - type: int + type: integer gateway_address: description: The gateway address for the gateway (Settings in the controller itself). required: false default: 1 - type: int + type: integer {% endconfiguration %} diff --git a/source/_components/config.markdown b/source/_components/config.markdown index 29aa9ce2aea..b697cec5e82 100644 --- a/source/_components/config.markdown +++ b/source/_components/config.markdown @@ -10,6 +10,7 @@ footer: true logo: home-assistant.png ha_category: Front end ha_release: 0.39 +ha_qa_scale: internal --- The `config` component is designed to display panels in the frontend to configure and manage parts of Home Assistant. @@ -21,9 +22,17 @@ To enable the configuration panel, add the following to your `configuration.yaml config: ``` +### {% linkable_title Integrations %} + +This section enables you to manage integrations for devices such as Philips Hue and Sonos from within Home Assistant. + +### {% linkable_title Users %} + +This section enables you to manage your Home Assistant users. + ### {% linkable_title General %} -This section enables you to control Home Assistant from within Home Assistant. Check your configuration, reload the core, groups, and automation, and the Home Assistant process itself. With a single mouse click. +This section enables you to control Home Assistant from within Home Assistant. Check your configuration, reload the core, groups, scripts, automations, and the Home Assistant process itself with a single mouse click.
diff --git a/source/_components/configurator.markdown b/source/_components/configurator.markdown
index 9cabdccbb35..0d033105f77 100644
--- a/source/_components/configurator.markdown
+++ b/source/_components/configurator.markdown
@@ -9,6 +9,7 @@ sharing: true
footer: true
logo: home-assistant.png
ha_category: Other
+ha_qa_scale: internal
---
diff --git a/source/_components/conversation.markdown b/source/_components/conversation.markdown index e9bb86aaabc..ed949157290 100644 --- a/source/_components/conversation.markdown +++ b/source/_components/conversation.markdown @@ -9,6 +9,7 @@ sharing: true footer: true logo: home-assistant.png ha_category: "Voice" +ha_qa_scale: internal --- The conversation component allows you to converse with Home Assistant. You can either converse by pressing the microphone in the frontend (supported browsers only (no iOS)) or by calling the `conversation/process` service with the transcribed text. diff --git a/source/_components/counter.markdown b/source/_components/counter.markdown index d6d3c263cb0..8beaea252ad 100644 --- a/source/_components/counter.markdown +++ b/source/_components/counter.markdown @@ -10,6 +10,7 @@ footer: true logo: home-assistant.png ha_category: Automation ha_release: 0.53 +ha_qa_scale: internal --- The `counter` component allows one to count occurrences fired by automations. diff --git a/source/_components/cover.command_line.markdown b/source/_components/cover.command_line.markdown index e6c08e5496b..b91c4a645ba 100644 --- a/source/_components/cover.command_line.markdown +++ b/source/_components/cover.command_line.markdown @@ -41,7 +41,7 @@ Configuration variables: ## {% linkable_title Examples %} -In this section you find some real life examples of how to use this sensor. +In this section you find some real-life examples of how to use this sensor. ### {% linkable_title Full configuration %} diff --git a/source/_components/cover.group.markdown b/source/_components/cover.group.markdown index c29b4b46a1d..93f50ab5785 100644 --- a/source/_components/cover.group.markdown +++ b/source/_components/cover.group.markdown @@ -11,6 +11,7 @@ ha_category: Cover ha_release: 0.66 ha_iot_class: "Local Push" logo: home-assistant.png +ha_qa_scale: internal --- The `group` platform can create a cover that combines several cover entities into one. diff --git a/source/_components/cover.mqtt.markdown b/source/_components/cover.mqtt.markdown index 0690125f5ed..b3f15bfeccd 100644 --- a/source/_components/cover.mqtt.markdown +++ b/source/_components/cover.mqtt.markdown @@ -163,7 +163,7 @@ unique_id: ## {% linkable_title Examples %} -In this section you will find some real life examples of how to use this platform. +In this section you will find some real-life examples of how to use this platform. ### {% linkable_title Full configuration without tilt %} diff --git a/source/_components/cover.template.markdown b/source/_components/cover.template.markdown index 77748e12b6c..b7118e97961 100644 --- a/source/_components/cover.template.markdown +++ b/source/_components/cover.template.markdown @@ -11,14 +11,17 @@ ha_category: Cover ha_release: 0.48 ha_iot_class: "Local Push" logo: home-assistant.png +ha_qa_scale: internal --- -The `template` platform can create covers that combine components and provides the ability to run scripts or invoke services for each of the open, close, stop, position and tilt commands of a cover. +The `template` platform can create covers that combine components and provides +the ability to run scripts or invoke services for each of the open, +close, stop, position and tilt commands of a cover. ## {% linkable_title Configuration %} -To enable Template Covers in your installation, add the following to your -`configuration.yaml` file: +To enable Template Covers in your installation, +add the following to your `configuration.yaml` file: {% raw %} ```yaml @@ -87,12 +90,12 @@ cover: optimistic: description: Force cover position to use [optimistic mode](#optimistic-mode). required: false - type: bool + type: boolean default: false tilt_optimistic: description: Force cover tilt position to use [optimistic mode](#optimistic-mode). required: false - type: bool + type: boolean default: false tilt_template: description: Defines a template to get the tilt state of the cover. Legal values are numbers between `0` (closed) and `100` (open). @@ -103,8 +106,8 @@ cover: ## {% linkable_title Considerations %} If you are using the state of a platform that takes extra time to load, the -Template Cover may get an `unknown` state during startup. This results -in error messages in your log file until that platform has completed loading. +Template Cover may get an `unknown` state during startup. This results in error +messages in your log file until that platform has completed loading. If you use `is_state()` function in your template, you can avoid this situation. For example, you would replace {% raw %}`{{ states.switch.source.state == 'on' }}`{% endraw %} @@ -114,19 +117,19 @@ result: ## {% linkable_title Optimistic Mode %} -In optimistic mode, the cover position state is maintained internally. This -mode is automatically enabled if neither [`value_template`](#value_template) or +In optimistic mode, the cover position state is maintained internally. This mode +is automatically enabled if neither [`value_template`](#value_template) or [`position_template`](#position_template) are specified. Note that this is unlikely to be very reliable without some feedback mechanism, since there is otherwise no way to know if the cover is moving properly. The cover can be -forced into optimistic mode by using the [`optimistic`](#optimistic) -attribute. There is an equivalent mode for `tilt_position` that is enabled -when [`tilt_template`](#tilt_template) is not specified or when the +forced into optimistic mode by using the [`optimistic`](#optimistic) attribute. +There is an equivalent mode for `tilt_position` that is enabled when +[`tilt_template`](#tilt_template) is not specified or when the [`tilt_optimistic`](#tilt_optimistic) attribute is used. ## {% linkable_title Examples %} -In this section you will find some real life examples of how to use this cover. +In this section you will find some real-life examples of how to use this cover. ### {% linkable_title Garage Door %} diff --git a/source/_components/deconz.markdown b/source/_components/deconz.markdown index 869a441c8a9..0340ef07126 100644 --- a/source/_components/deconz.markdown +++ b/source/_components/deconz.markdown @@ -31,39 +31,7 @@ Home Assistant will automatically discover deCONZ presence on your network, if ` 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 **Settings** -> **Gateway** -> **Advanced** -> **Authenticate app** in deCONZ and then use the deCONZ configurator in Home Assistant frontend to create an API key. When you're done setting up deCONZ it will be stored as a config entry. -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 -``` - -{% configuration %} -host: - description: The IP address of your deCONZ web server. - required: false - type: string -api_key: - description: The API key to access your deCONZ web server. - required: false - type: string -port: - description: Configure port deCONZ web server is accessible from. - required: false - default: 80 - type: int -{% endconfiguration %} - -A full configuration could look like this: - -```yaml -# Example configuration.yaml entry -deconz: - host: 127.0.0.1 - api_key: 0123456789 - port: 80 -``` +You can manually add deCONZ by going to the integrations page. ## {% linkable_title Debugging component %} @@ -107,7 +75,7 @@ Note: deCONZ automatically signals Home Assistant when new sensors are added, bu ## {% linkable_title Remote control devices %} -Remote controls (ZHASwitch category) will be not be exposed as regular entities, 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. +Remote controls (ZHASwitch category) will not be exposed as regular entities, 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. Typical values for switches, the event codes are 4 numbers where the first and last number are of interest here. diff --git a/source/_components/device_sun_light_trigger.markdown b/source/_components/device_sun_light_trigger.markdown index d49c4e1565f..2be37360ace 100644 --- a/source/_components/device_sun_light_trigger.markdown +++ b/source/_components/device_sun_light_trigger.markdown @@ -9,6 +9,7 @@ sharing: true footer: true logo: home-assistant.png ha_category: Automation +ha_qa_scale: internal --- Home Assistant has a built-in component called `device_sun_light_trigger` to help you automate your lights. The component will: diff --git a/source/_components/device_tracker.asuswrt.markdown b/source/_components/device_tracker.asuswrt.markdown index 7889253ce98..ac26ef901fc 100644 --- a/source/_components/device_tracker.asuswrt.markdown +++ b/source/_components/device_tracker.asuswrt.markdown @@ -52,7 +52,7 @@ protocol: port: description: SSH port to use. required: false - type: int + type: integer default: 22 mode: description: "The operating mode of the router (`router` or `ap`)." diff --git a/source/_components/device_tracker.ping.markdown b/source/_components/device_tracker.ping.markdown index 675150cb18c..84c41802c23 100644 --- a/source/_components/device_tracker.ping.markdown +++ b/source/_components/device_tracker.ping.markdown @@ -10,6 +10,7 @@ footer: true logo: home-assistant.png ha_category: Network ha_release: 0.36 +ha_qa_scale: internal --- @@ -31,9 +32,15 @@ device_tracker: hostone: 192.168.2.10 ``` -Configuration variables: - -- **hosts** array (*Required*): List of device names and their corresponding IP address or hostname. -- **count** (*Optional*): Number of packet used for each device (avoid false detection). +{% configuration %} +hosts: + description: List of device names and their corresponding IP address or hostname. + required: true + type: array +count: + description: Number of packet used for each device (avoid false detection). + required: false + type: integer +{% 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.tomato.markdown b/source/_components/device_tracker.tomato.markdown index 998b528d510..0c080449b64 100644 --- a/source/_components/device_tracker.tomato.markdown +++ b/source/_components/device_tracker.tomato.markdown @@ -12,12 +12,21 @@ ha_category: Presence Detection ha_release: pre 0.7 --- +The `tomato` platform requires an extra config variable called `http_id`. The +value can be obtained by logging in to the Tomato admin interface and search for +`http_id` in the page source code. -The `tomato` platform requires an extra config variable called `http_id`. The value can be obtained by logging in to the Tomato admin interface and search for `http_id` in the page source code. +Because of a limitation in Tomato's API, this platform will only track wireless +devices. If tracking wired devices like a Philips Hue Hub is necessary, it is +possible to use another platform like +[NMAP](/components/device_tracker.nmap_tracker/). -Because of a limitation in Tomato's API, this platform will only track wireless devices. If tracking wired devices like a Philips Hue Hub is necessary, it is possible to use another platform like [Nmap](/components/device_tracker.nmap_tracker/). +Because of a limitation in Tomato's API, this platform will only track wireless devices. +If tracking wired devices like a Philips Hue Hub is necessary, +it is possible to use another platform like [Nmap](/components/device_tracker.nmap_tracker/). -To use this device tracker in your installation, add the following to your `configuration.yaml` file: +To use this device tracker in your installation, +add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry @@ -32,22 +41,22 @@ device_tracker: {% configuration %} host: description: "The IP address or hostname of your router, e.g., `192.168.1.1` or `rt-ac68u`." - required: false + required: true type: string port: description: "The port number of your router, e.g., `443`." required: false - type: int + type: integer default: 80/443 (automatically detected) ssl: description: "Whether to connect via `https`." required: false - type: bool + type: boolean 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`." required: false - type: [string, bool] + type: [string, boolean] default: true username: description: "The username of an user with administrative privileges, usually *admin*." @@ -63,13 +72,17 @@ http_id: type: string {% endconfiguration %} -See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked. +See the [device tracker component page](/components/device_tracker/) for +instructions how to configure the people to be tracked. -A description of the API s available in this [Tomato API](http://paulusschoutsen.nl/blog/2013/10/tomato-api-documentation/) blog post. +A description of the API s available in this +[Tomato API](http://paulusschoutsen.nl/blog/2013/10/tomato-api-documentation/) +blog post. SSL Certificate: -Gathering the SSL Certificate of your router can be accomplished with this (or a similar) command: +Gathering the SSL Certificate of your router can be accomplished with this (or +a similar) command: ```bash openssl s_client -showcerts -connect 172.10.10.1:443 /dev/null | openssl x509 -outform PEM > router_cert.pem -``` \ No newline at end of file +``` diff --git a/source/_components/device_tracker.unifi.markdown b/source/_components/device_tracker.unifi.markdown index 94dee4ca71c..2bb4372c4b3 100644 --- a/source/_components/device_tracker.unifi.markdown +++ b/source/_components/device_tracker.unifi.markdown @@ -9,6 +9,7 @@ sharing: true footer: true logo: ubiquiti.png ha_category: Presence Detection +ha_iot_class: "Local Polling" ha_release: 0.14 --- @@ -45,7 +46,7 @@ host: port: description: The port of your controller's web interface default: 8443 - type: int + type: integer required: false site_id: description: For multisite installations, you can specify `site_id` to specify which is used @@ -59,7 +60,7 @@ verify_ssl: default: true detection_time: description: How long since the last seen time before the device is marked away, specified in seconds. - type: int + type: integer required: false default: 300 ssid_filter: diff --git a/source/_components/device_tracker.unifi_direct.markdown b/source/_components/device_tracker.unifi_direct.markdown index 4816832b8e1..9bc5ad22104 100644 --- a/source/_components/device_tracker.unifi_direct.markdown +++ b/source/_components/device_tracker.unifi_direct.markdown @@ -9,6 +9,7 @@ sharing: true footer: true logo: ubiquiti.png ha_category: Presence Detection +ha_iot_class: "Local Polling" ha_release: 0.59 --- diff --git a/source/_components/device_tracker.volvooncall.markdown b/source/_components/device_tracker.volvooncall.markdown index 0177adf5ded..26ad808ce08 100644 --- a/source/_components/device_tracker.volvooncall.markdown +++ b/source/_components/device_tracker.volvooncall.markdown @@ -1,6 +1,6 @@ --- layout: page -title: "Volvo On Call" +title: "Volvo On Call Device Tracker" description: "Instructions for how to integrate Volvo On Call into Home Assistant." date: 2016-10-02 17:00 sidebar: true @@ -13,4 +13,4 @@ ha_release: "0.30" --- -Integrates Volvo on Call into Home Assistant. See the [main component](/components/volvooncall/) for configuration instructions. +Integrates Volvo on Call device tracker into Home Assistant. See the [main component](/components/volvooncall/) for configuration instructions. diff --git a/source/_components/device_tracker.xiaomi.markdown b/source/_components/device_tracker.xiaomi.markdown index d38571007cb..640f240efc2 100644 --- a/source/_components/device_tracker.xiaomi.markdown +++ b/source/_components/device_tracker.xiaomi.markdown @@ -12,7 +12,6 @@ ha_category: Presence Detection ha_release: 0.36 --- - The `xiaomi` platform offers presence detection by looking at connected devices to a [Xiaomi](http://miwifi.com) router. To use an Xiaomi router in your installation, add the following to your `configuration.yaml` file: @@ -25,11 +24,20 @@ device_tracker: password: YOUR_ADMIN_PASSWORD ``` -Configuration variables: - -- **host** (*Required*): The IP address of your router, eg. `192.168.0.1`. -- **username** (*Optional*: The admin username. By default `admin`. -- **password** (*Required*): The password for the admin account. +{% configuration %} +host: + description: "The IP address of your router, e.g., `192.168.0.1`." + required: true + type: string +username: + description: The admin username. + required: false + default: admin + type: string +password: + description: The password for the admin account. + 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/discovery.markdown b/source/_components/discovery.markdown index 5ab929d212e..4f4ef7f5a74 100644 --- a/source/_components/discovery.markdown +++ b/source/_components/discovery.markdown @@ -9,6 +9,7 @@ sharing: true footer: true logo: home-assistant.png ha_category: Other +ha_qa_scale: internal --- 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: diff --git a/source/_components/downloader.markdown b/source/_components/downloader.markdown index beec2268765..f41c2fd1168 100644 --- a/source/_components/downloader.markdown +++ b/source/_components/downloader.markdown @@ -10,6 +10,7 @@ footer: true logo: home-assistant.png ha_category: Downloading ha_release: pre 0.7 +ha_qa_scale: internal --- The `downloader` component provides a service to download files. It will raise an error and not continue to set itself up when the download directory does not exist. The directory needs to be writable for the user that is running Home Assistant. diff --git a/source/_components/duckdns.markdown b/source/_components/duckdns.markdown index 96f9fc3c917..7b67ed702e3 100644 --- a/source/_components/duckdns.markdown +++ b/source/_components/duckdns.markdown @@ -22,8 +22,8 @@ To use the component in your installation, add the following to your `configurat ```yaml # Example configuration.yaml entry duckdns: - domain: mysubdomain - access_token: abcdefgh + domain: YOUR_SUBDOMAIN + access_token: YOUR_ACCSS_TOKEN ``` {% configuration duckdns %} @@ -36,3 +36,7 @@ duckdns: required: true type: string {% endconfiguration %} + +
+If you are running the Hass.io [DuckDNS add-on](/addons/duckdns/) this component is not required. The add-on will keep your IP updated with DuckDNS. +
diff --git a/source/_components/egardia.markdown b/source/_components/egardia.markdown index 50efce55a66..b8f0b75396a 100644 --- a/source/_components/egardia.markdown +++ b/source/_components/egardia.markdown @@ -48,7 +48,7 @@ version: port: description: The port of the alarm panel. required: false - type: int + type: integer default: 80 report_server_enabled: description: Enable reporting by server. @@ -58,7 +58,7 @@ report_server_enabled: report_server_port: description: Port of the Egardia server. required: false - type: int + type: integer default: 52010 report_server_codes: description: Map of list of codes for the different states. diff --git a/source/_components/emulated_hue.markdown b/source/_components/emulated_hue.markdown index 1f1170eabaa..fd7c73fe024 100644 --- a/source/_components/emulated_hue.markdown +++ b/source/_components/emulated_hue.markdown @@ -50,37 +50,54 @@ emulated_hue: emulated_hue: ``` -Configuration variables: - -- **type** (*Optional*): The type of assistant which we are emulating. Either `alexa` or `google_home`, defaults to `google_home`. **This configuration option is deprecated and will be removed in a future release. It is no longer necessary to define type.** -- **host_ip** (*Optional*): The IP address that your Home Assistant installation is running on. If you do not specify this option, the component will attempt to determine the IP address on its own. -- **listen_port** (*Optional*): The port the Hue bridge API web server will run on. If not specified, this defaults to 8300. This can be any free port on your system. - -- **advertise_ip** (*Optional*): If you need to override the IP address used for UPnP discovery. (For example, using network isolation in Docker) -- **advertise_port** (*Optional*): If you need to specifically override the advertised UPnP port. - -- **upnp_bind_multicast** (*Optional*): Whether or not to bind the UPnP (SSDP) listener to the multicast address (239.255.255.250) or instead to the (unicast) host_ip address specified above (or automatically determined). The default is true, which will work for most situations. In special circumstances, like running in a FreeBSD or FreeNAS jail, you may need to disable this. - -- **off_maps_to_on_domains** (*Optional*): The domains that maps an "off" command to an "on" command. - - For example, if `script` is included in the list, and you ask Alexa to "turn off the *water plants* script," the command will be handled as if you asked her to turn on the script. - - If not specified, this defaults to the following list: - - - `script` - - `scene` - -- **expose_by_default** (*Optional*): Whether or not entities should be exposed via the bridge by default instead of explicitly (see the 'emulated_hue' customization below). If not specified, this defaults to true. Warning: If you have a lot of devices (more than 49 total across all exposed domains), you should be careful with this option. Exposing more devices than Alexa supports can result in it not seeing any of them. If you are having trouble getting any devices to show up, try disabling this, and explicitly exposing just a few devices at a time to see if that fixes it. - -- **exposed_domains** (*Optional*): The domains that are exposed by default if `expose_by_default` is set to true. If not specified, this defaults to the following list: - - `switch` - - `light` - - `group` - - `input_boolean` - - `media_player` - - `fan` - -- **entities** (*Optional*): Customization for entities. +{% configuration %} +type: + description: The type of assistant which we are emulating. Either `alexa` or `google_home`. **This configuration option is deprecated and will be removed in a future release. It is no longer necessary to define type.** + required: false + type: string + default: google_home +host_ip: + description: The IP address that your Home Assistant installation is running on. If you do not specify this option, the component will attempt to determine the IP address on its own. + required: false + type: string +listen_port: + description: The port the Hue bridge API web server will run on. This can be any free port on your system. + required: false + type: integer + default: 8300 +advertise_ip: + description: If you need to override the IP address used for UPnP discovery. (For example, using network isolation in Docker) + required: false + type: string +advertise_port: + description: If you need to specifically override the advertised UPnP port. + required: false + type: integer +upnp_bind_multicast: + description: Whether or not to bind the UPnP (SSDP) listener to the multicast address (239.255.255.250) or instead to the (unicast) host_ip address specified above (or automatically determined). In special circumstances, like running in a FreeBSD or FreeNAS jail, you may need to disable this. + required: false + type: boolean + default: true +off_maps_to_on_domains: + description: The domains that maps an "off" command to an "on" command. For example, if `script` is included in the list, and you ask Alexa to "turn off the *water plants* script," the command will be handled as if you asked her to turn on the script. + required: false + type: list + default: [script, scene] +expose_by_default: + description: "Whether or not entities should be exposed via the bridge by default instead of explicitly (see the ‘emulated_hue’ customization below). Warning: If you have a lot of devices (more than 49 total across all exposed domains), you should be careful with this option. Exposing more devices than Alexa supports can result in it not seeing any of them. If you are having trouble getting any devices to show up, try disabling this, and explicitly exposing just a few devices at a time to see if that fixes it." + required: false + type: boolean + default: true +exposed_domains: + description: The domains that are exposed by default if `expose_by_default` is set to true. + required: false + type: list + default: [switch, light, group, input_boolean, media_player, fan] +entities: + description: Customization for entities. + required: false + type: list +{% endconfiguration %} A full configuration sample looks like the one below. diff --git a/source/_components/fan.mqtt.markdown b/source/_components/fan.mqtt.markdown index 1e988b474f1..f48971fde9c 100644 --- a/source/_components/fan.mqtt.markdown +++ b/source/_components/fan.mqtt.markdown @@ -154,7 +154,7 @@ Make sure that your topics match exactly. `some-topic/` and `some-topic` are dif ## {% linkable_title Examples %} -In this section you find some real life examples of how to use this fan. +In this section you find some real-life examples of how to use this fan. ### {% linkable_title Full configuration %} diff --git a/source/_components/fan.template.markdown b/source/_components/fan.template.markdown index 974eb7508e4..189cad7ad79 100644 --- a/source/_components/fan.template.markdown +++ b/source/_components/fan.template.markdown @@ -11,6 +11,7 @@ ha_category: Fan ha_release: 0.69 ha_iot_class: "Local Push" logo: home-assistant.png +ha_qa_scale: internal --- The `template` platform creates fans that combine components and provides the diff --git a/source/_components/feedreader.markdown b/source/_components/feedreader.markdown index b5a6b9b3ea5..5ed987b90d1 100644 --- a/source/_components/feedreader.markdown +++ b/source/_components/feedreader.markdown @@ -39,7 +39,7 @@ feedreader: description: The maximum number of entries to extract from each feed. required: false default: 20 - type: int + type: integer {% endconfiguration %} The following configuration example shows how to configure update interval and maximum number of entries: diff --git a/source/_components/folder_watcher.markdown b/source/_components/folder_watcher.markdown index 338f0c7fdb0..1616a285b03 100644 --- a/source/_components/folder_watcher.markdown +++ b/source/_components/folder_watcher.markdown @@ -11,6 +11,7 @@ logo: home-assistant.png ha_category: System Monitor ha_iot_class: "Local Polling" ha_release: 0.67 +ha_qa_scale: internal --- 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: diff --git a/source/_components/foursquare.markdown b/source/_components/foursquare.markdown index 5ec302887eb..5d06ddaa085 100644 --- a/source/_components/foursquare.markdown +++ b/source/_components/foursquare.markdown @@ -23,10 +23,16 @@ foursquare: push_secret: "
+You can't write messages to yourself or get notifications in a group, if "you" write the message. The best way is to create a new Google Hangouts account for this integration.
+
+If you secured your account with 2-factor authentication: Only verification by app or SMS are supported. There is no support for verification by prompt on your phone.
+
+If you are sure your email and password are correct, but the component says the login is invalid, wait a few hours and try again. It might be that Google asks for a captcha which we can't support. Google does not provide official support for using bots with Google Hangouts, that's why we have to work around this.
+
-Events are saved in a local database. Google Graphs is used to draw the graph. Drawing is happening 100% in your browser. No data is transferred to anyone at any time. +Events are saved in a local database. Google Graphs is used to draw the graph. +Drawing is happening 100% in your browser. No data is transferred to anyone at any time.
+{% configuration %} +exclude: + description: Configure which components should **not** be displayed. + required: false + type: map + keys: + entities: + description: The list of entity ids to be excluded from the history. + required: false + type: list + domains: + description: The list of domains to be excluded from the history. + required: false + type: list +include: + description: Configure which components should be displayed. + required: false + type: map + keys: + entities: + description: The list of entity ids to be included in the history. + required: false + type: list + domains: + description: The list of domains to be included in the history. + required: false + type: list +{% endconfiguration %} -Configuration variables: +Without any `include` or `exclude` configuration the history displays graphs for + every entity (well that's not exactly true - for instance `hidden` entities or + `scenes` are never shown) on a given date. If you are only interested in some + of the entities you have several options: -- **exclude** (*Optional*): Configure which components should **not** be displayed. - - **entities** (*Optional*): The list of entity ids to be excluded from the history. - - **domains** (*Optional*): The list of domains to be excluded from the history. -- **include** (*Optional*): Configure which components should be displayed. - - **entities** (*Optional*): The list of entity ids to be included to the history. - - **domains** (*Optional*): The list of domains to be included to the history. - -Without any `include` or `exclude` configuration the history displays graphs for every entity (well that's not exactly true - for instance `hidden` entities or `scenes` are never shown) on a given date. If you are only interested in some of the entities you have several options: - -Define domains and entities to `exclude` (aka. blacklist). This is convenient when you are basically happy with the information displayed, but just want to remove some entities or domains. Usually these are entities/domains which do not change (like `weblink`) or rarely change (like `updater` or `automation`). +Define domains and entities to `exclude` (aka. blacklist). This is convenient +when you are basically happy with the information displayed, but just want to +remove some entities or domains. Usually these are entities/domains which do not +change (like `weblink`) or rarely change (like `updater` or `automation`). ```yaml # Example configuration.yaml entry with exclude @@ -59,7 +90,10 @@ history: - sensor.date ``` -Define domains and entities to display by using the `include` configuration (aka. whitelist). If you have a lot of entities in your system and your `exclude` list is getting too large, it might be better just to define the entities or domains to `include`. +Define domains and entities to display by using the `include` configuration +(aka. whitelist). If you have a lot of entities in your system and your +`exclude` list is getting too large, it might be better just to define the +entities or domains to `include`. ```yaml # Example configuration.yaml entry with include @@ -71,7 +105,13 @@ history: - media_player ``` -Use the `include` list to define the domains/entities to display, and exclude some of them within the `exclude` list. This makes sense if you, for instance, include the `sensor` domain, but want to exclude some specific sensors. Instead of adding every sensor entity to the `include` `entities` list just include the `sensor` domain and exclude the sensor entities you are not interested in. Note that the order of any `include` `entities` will be displayed as listed in the configuration, otherwise, the display order is arbitrary. +Use the `include` list to define the domains/entities to display, and exclude +some of them within the `exclude` list. This makes sense if you, for instance, +include the `sensor` domain, but want to exclude some specific sensors. Instead +of adding every sensor entity to the `include` `entities` list just include the +`sensor` domain and exclude the sensor entities you are not interested in. +Note that the order of any `include` `entities` will be displayed as listed in +the configuration, otherwise, the display order is arbitrary. ```yaml # Example configuration.yaml entry with include and exclude @@ -87,9 +127,9 @@ history: - sensor.date ``` -If you'd like the order of display of the sensors to follow the way -they are listed in the included entity list, you can set the flag -`use_include_order` to True. +If you'd like the order of display of the sensors to follow the way they are +listed in the included entity list, +you can set the flag `use_include_order` to true. ```yaml # Example configuration.yaml entry using specified entity display order @@ -101,10 +141,10 @@ history: - light.front_porch ``` - #### {% linkable_title Implementation details %} -The history is stored in a SQLite database `home-assistant_v2.db` within your configuration directory unless the `recorder` component is set up differently. +The history is stored in a SQLite database `home-assistant_v2.db` within your +configuration directory unless the `recorder` component is set up differently. - events table is all events except `time_changed` that happened while recorder component was running. - states table contains all the `new_state` values of `state_changed` events. @@ -116,11 +156,14 @@ The history is stored in a SQLite database `home-assistant_v2.db` within your co - `last_updated`: timestamp anything has changed (state, attributes) - `created`: timestamp this entry was inserted into the database -When the `history` component queries the states table it only selects states where the state has changed: `WHERE last_changed=last_updated` +When the `history` component queries the states table it only selects states +where the state has changed: `WHERE last_changed=last_updated` -#### {% linkable_title On dates %} +#### {% 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](https://www.epochconverter.com/) 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 @@ -129,4 +172,5 @@ datetime.fromtimestamp(1422830502) #### {% linkable_title API %} -The history information is also available through the [RESTful API](/developers/rest_api/#get-apihistory). +The history information is also available through the +[RESTful API](/developers/rest_api/#get-apihistory). diff --git a/source/_components/history_graph.markdown b/source/_components/history_graph.markdown index f38cd482907..5059d1ba1cb 100644 --- a/source/_components/history_graph.markdown +++ b/source/_components/history_graph.markdown @@ -10,7 +10,9 @@ footer: true ha_category: History logo: home-assistant.png ha_release: "0.55" +ha_qa_scale: internal --- +
-It is HIGHLY recommended that you set the `api_password`, especially if you are planning to expose your installation to the internet. +It is HIGHLY recommended that you set the `api_password`, +especially if you are planning to expose your installation to the internet.
@@ -27,27 +30,26 @@ http: api_password: YOUR_PASSWORD ``` -Configuration variables: - -{% configuration http %} +{% configuration %} api_password: description: Protect Home Assistant with a password. required: false type: string server_host: - description: 'Only listen to incoming requests on specific IP/host (default: bind to `0.0.0.0` which means accept all IPv4 connections). Use `server_host: "::0"` if you want to listen to (and only) IPv6.' + description: "Only listen to incoming requests on specific IP/host. By default it will accept all IPv4 connections. Use `server_host: ::0` if you want to listen to (and only) IPv6." required: false type: string + default: 0.0.0.0 server_port: description: Let you set a port to use. required: false type: integer default: 8123 base_url: - description: "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." + description: "The URL that Home Assistant is available on the internet. For example: `hass-example.duckdns.org:8123`. 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." required: false type: string - default: The local IP address + default: Your local IP address ssl_certificate: description: Path to your TLS/SSL certificate to serve Home Assistant over a secure connection. required: false @@ -64,15 +66,15 @@ cors_allowed_origins: description: "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`." required: false type: string, list -trusted_proxies: - description: "List of trusted proxies, consisting of IP addresses or networks, that are allowed to set the `X-Forwarded-For` header. This is required when using `use_x_forwarded_for` because 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 set with extreme care." - required: false - type: string, list use_x_forwarded_for: description: "Enable parsing of the `X-Forwarded-For` header, passing on the client's correct IP address in proxied setups. You **must** also whitelist trusted proxies using the `trusted_proxies` setting above for this to work. Non-whitelisted requests with this header will be considered IP spoofing attacks, and the header will, therefore, be ignored." required: false type: boolean default: false +trusted_proxies: + description: "List of trusted proxies, consisting of IP addresses or networks, that are allowed to set the `X-Forwarded-For` header. This is required when using `use_x_forwarded_for` because 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 set with extreme care." + required: false + type: string, list trusted_networks: description: "List of trusted networks, consisting of IP addresses or networks, that are allowed to bypass password protection when accessing Home Assistant. If using a reverse proxy with the `use_x_forwarded_for` and `trusted_proxies` options enabled, requests proxied to Home Assistant with a trusted `X-Forwarded-For` header will appear to come from the IP given in that header instead of the proxy IP." required: false @@ -83,7 +85,7 @@ ip_ban_enabled: type: boolean default: false login_attempts_threshold: - description: "Number of failed login attempt from single IP after which it will be automatically banned if `ip_ban_enabled` is True. When set to -1 no new automatic bans will be added." + description: "Number of failed login attempt from single IP after which it will be automatically banned if `ip_ban_enabled` is `true`. When set to -1 no new automatic bans will be added." required: false type: integer default: -1 @@ -106,7 +108,7 @@ http: cors_allowed_origins: - https://google.com - https://www.home-assistant.io - use_x_forwarded_for: True + use_x_forwarded_for: true trusted_proxies: - 127.0.0.1 - ::1 @@ -115,36 +117,55 @@ http: - ::1 - 192.168.0.0/24 - fd00::/8 - ip_ban_enabled: True + ip_ban_enabled: true login_attempts_threshold: 5 ``` -The [Set up encryption using Let's Encrypt](/blog/2015/12/13/setup-encryption-using-lets-encrypt/) blog post gives you details about the encryption of your traffic using free certificates from [Let's Encrypt](https://letsencrypt.org/). +The [Set up encryption using Let's Encrypt](/blog/2015/12/13/setup-encryption-using-lets-encrypt/) +blog post gives you details about the encryption of your traffic using free +certificates from [Let's Encrypt](https://letsencrypt.org/). -Or use a self signed certificate following the instructions here [Self-signed certificate for SSL/TLS](/docs/ecosystem/certificates/tls_self_signed_certificate/). +Or use a self signed certificate following the instructions here +[Self-signed certificate for SSL/TLS](/docs/ecosystem/certificates/tls_self_signed_certificate/). ## {% linkable_title APIs %} -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/). +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. ## {% linkable_title HTTP sensors %} -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. +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**. +All [requests](/developers/rest_api/#post-apistatesltentity_id) need to be sent +to the endpoint of the device and must be **POST**. ## {% linkable_title IP filtering and banning %} -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. @@ -152,7 +173,11 @@ 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 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/huawei_lte.markdown b/source/_components/huawei_lte.markdown
index 7d6afd4afa6..ba637bb5d79 100644
--- a/source/_components/huawei_lte.markdown
+++ b/source/_components/huawei_lte.markdown
@@ -47,3 +47,14 @@ password:
required: true
type: string
{% endconfiguration %}
+
+### {% linkable_title Tested routers %}
+
+Routers we know to be working with this component based on the documentation of used libraries and reports by users:
+
+- Huawei B310s-22
+- Huawei B525s-23a
+- Huawei E5186s-22a
+- Huawei B618
+
+This is not a complete list. The component can probably connect to other Huawei LTE routers running similar firmware.
diff --git a/source/_components/hue.markdown b/source/_components/hue.markdown
index a171a29dc69..d9832903b1f 100644
--- a/source/_components/hue.markdown
+++ b/source/_components/hue.markdown
@@ -10,6 +10,7 @@ footer: true
logo: philips_hue.png
ha_category: Hub
ha_iot_class: "Local Polling"
+ha_qa_scale: platinum
featured: true
ha_release: "0.60"
ha_qa_scale: platinum
@@ -32,12 +33,24 @@ hue:
- host: DEVICE_IP_ADDRESS
```
-Configuration variables:
-
-- **host** (*Required*): The 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_hue_groups** (*Optional*): (true/false) Enable this to stop Home Assistant from importing the groups defined on the Hue bridge.
+{% configuration %}
+host:
+ description: The IP address of the device, eg. 192.168.1.10. Required if not using the `discovery` component to discover Hue bridges.
+ required: true
+ type: string
+allow_unreachable:
+ description: This will allow unreachable bulbs to report their state correctly.
+ required: false
+ type: boolean
+filename:
+ description: Make this unique if specifying multiple Hue hubs.
+ required: false
+ type: string
+allow_hue_groups:
+ description: Enable this to stop Home Assistant from importing the groups defined on the Hue bridge.
+ required: false
+ type: boolean
+{% endconfiguration %}
## {% linkable_title Examples %}
diff --git a/source/_components/hydrawise.markdown b/source/_components/hydrawise.markdown
index f45b1255bdc..f864bee1a70 100644
--- a/source/_components/hydrawise.markdown
+++ b/source/_components/hydrawise.markdown
@@ -33,7 +33,7 @@ access_token:
scan_interval:
description: The time interval, in seconds, to poll the Hydrawise cloud.
required: false
- type: int
+ type: integer
default: 30
{% endconfiguration %}
diff --git a/source/_components/ihc.markdown b/source/_components/ihc.markdown
index 0030d30361f..5fca84708fe 100644
--- a/source/_components/ihc.markdown
+++ b/source/_components/ihc.markdown
@@ -13,30 +13,32 @@ ha_release: "0.62"
ha_iot_class: "Local Push"
---
-IHC Controller integration for Home Assistant allows you to connect the LK IHC controller to Home Assistant.
-(The controller is sold under other names in different countries - "ELKO Living system" in Sweden and Norway)
+IHC Controller integration for Home Assistant allows you to connect the LK IHC
+controller to Home Assistant. The controller is sold under other names in
+different countries - "ELKO Living system" in Sweden and Norway
-An `ihc` section must be present in the `configuration.yaml` file and contain the following options:
+An `ihc` section must be present in the `configuration.yaml` file and contain
+the following options:
```yaml
# Example configuration.yaml entry
ihc:
url: http://192.168.1.3
- username: admin
- password: mysecret
- auto_setup: True
- info: True
+ username: YOUR_USERNAME
+ password: YOUR_PASSWORD
+ info: true
```
{% configuration %}
auto_setup:
- description: True to have IHC products auto setup.
+ description: Automatic setup of IHC products.
required: false
- type: bool
+ type: boolean
+ default: true
info:
- description: If True additional IHC info will be shown on each component.
+ description: Shows the IHC "name", "note" and "position" attributes of each component. This will make it easier to identify the IHC products within Home Assistant.
required: false
- type: bool
+ type: boolean
password:
description: The password for the IHC Controller.
required: true
@@ -51,40 +53,44 @@ username:
type: string
{% endconfiguration %}
-The info option will show the IHC "name", "note" and "position" attributes.
-This will make it easier to identify the IHC products within Home Assistant
-
There is currently support for the following device types within Home Assistant:
-- [Binary Sensor](/components/binary_sensor.ihc/)
-- [Sensor](/components/sensor.ihc/)
-- [Light](/components/light.ihc/)
-- [Switch](/components/switch.ihc/)
+- [Binary Sensor](/components/binary_sensor.ihc/)
+- [Sensor](/components/sensor.ihc/)
+- [Light](/components/light.ihc/)
+- [Switch](/components/switch.ihc/)
### Auto setup of IHC products
-If the auto setup is enabled, the `ihc` component will automatically find IHC products and insert these as devices in Home Assistant.
-To disable this set auto_setup to False. (Auto setup is on by default)
-See the individual device types for a list of IHC products to be recognized automatically.
+If the auto setup is enabled, the `ihc` component will automatically find IHC
+products and insert these as devices in Home Assistant.
+To disable this set auto_setup to false. See the individual device types for a
+list of IHC products to be recognized automatically.
-Components will get a default name that is a combination of the IHC group and IHC resource id.
-If you want to change the display names use the [Customizing entities](/docs/configuration/customizing-devices/)
+Components will get a default name that is a combination of the IHC group and
+IHC resource id.
+If you want to change the display names use the
+[Customizing entities](/docs/configuration/customizing-devices/).
### {% linkable_title Manual setup %}
-Each device is associated with an IHC resource id.
-To manually setup components you specify resource ids from the IHC project.
-(The IHC project is the file you edit/upload to the IHC Controller using LK IHC Visual - or similar program if your controller is not the LK brand).
-The project file is an XML file and you can view it with any text/XML editor.
-You can rename it to have the XML extension and use a browser like Chrome or Internet Explorer.
-The resources are the \
@@ -77,7 +78,7 @@ input_number:
required: false
type: string
icon:
- description: Icon to display in front of the box/slider in the frontend. Refer to the [Customizing devices](/docs/configuration/customizing-devices/#possible-values) page for possible values.
+ description: Icon to display in front of the box/slider in the frontend.
required: false
type: icon
{% endconfiguration %}
diff --git a/source/_components/input_select.markdown b/source/_components/input_select.markdown
index dec70767fd1..ad54719e9b6 100644
--- a/source/_components/input_select.markdown
+++ b/source/_components/input_select.markdown
@@ -10,6 +10,7 @@ footer: true
logo: home-assistant.png
ha_category: Automation
ha_release: 0.13
+ha_qa_scale: internal
---
The `input_select` component allows the user to define a list of values that can be selected via the frontend and can be used within conditions of automation. When a user selects a new item, a state transition event is generated. This state event can be used in an `automation` trigger.
@@ -53,7 +54,7 @@ input_select:
type: Element of options
default: First element of options
icon:
- description: Icon to display for the component. Refer to the [Customizing devices](/docs/configuration/customizing-devices/#possible-values) page for possible values.
+ description: Icon to display for the component.
required: false
type: icon
{% endconfiguration %}
diff --git a/source/_components/input_text.markdown b/source/_components/input_text.markdown
index 187f08a0e46..fc1247988ba 100644
--- a/source/_components/input_text.markdown
+++ b/source/_components/input_text.markdown
@@ -10,6 +10,7 @@ footer: true
logo: home-assistant.png
ha_category: Automation
ha_release: 0.53
+ha_qa_scale: internal
---
The `input_text` component allows the user to define values that can be controlled via the frontend and can be used within conditions of automation. Changes to the value stored in the text box generate state events. These state events can be utilized as `automation` triggers as well. It can also be configured in password mode (obscured text).
@@ -45,12 +46,12 @@ input_text:
min:
description: Minimum length for the text value.
required: false
- type: int
+ type: integer
default: 0
max:
description: Maximum length for the text value.
required: false
- type: int
+ type: integer
default: 100
initial:
description: Initial value when Home Assistant starts.
diff --git a/source/_components/intent_script.markdown b/source/_components/intent_script.markdown
index eab43f4b930..17e664d3808 100644
--- a/source/_components/intent_script.markdown
+++ b/source/_components/intent_script.markdown
@@ -10,9 +10,10 @@ footer: true
logo: home-assistant.png
ha_category: Intent
ha_release: "0.50"
+ha_qa_scale: internal
---
-The intent_script component allows users to configure actions and responses to intents. Intents can be fired by any component that supports it. Examples are [Alexa](/components/alexa/) (Amazon Echo), [API.ai](/components/dialogflow/) (Google Assistant) and [Snips](/components/snips/).
+The `intent_script` component allows users to configure actions and responses to intents. Intents can be fired by any component that supports it. Examples are [Alexa](/components/alexa/) (Amazon Echo), [API.ai](/components/dialogflow/) (Google Assistant) and [Snips](/components/snips/).
```yaml
# Example configuration.yaml entry
diff --git a/source/_components/introduction.markdown b/source/_components/introduction.markdown
index 759142229dc..83a39cc1612 100644
--- a/source/_components/introduction.markdown
+++ b/source/_components/introduction.markdown
@@ -9,6 +9,7 @@ sharing: true
footer: true
logo: home-assistant.png
ha_category: Other
+ha_qa_scale: internal
---
The introduction component will show a card in the UI with 'Welcome Home!' and steps on how to get started. It will also print the same message to the console when starting up.
diff --git a/source/_components/iota.markdown b/source/_components/iota.markdown
index d50ad4f5452..4a367e2e38c 100644
--- a/source/_components/iota.markdown
+++ b/source/_components/iota.markdown
@@ -13,9 +13,11 @@ ha_release: 0.62
ha_iot_class: "Cloud Polling"
---
-[IOTA](http://iota.org/) is a new blockless distributed ledger which is scalable, lightweight and makes it possible to transfer value without any fees.
+[IOTA](http://iota.org/) is a new blockless distributed ledger which is
+scalable, lightweight and makes it possible to transfer value without any fees.
-The `iota` component displays various details (e.g., the balance, node attributes) of IOTA wallets.
+The `iota` component displays various details
+(e.g., the balance, node attributes) of IOTA wallets.
```yaml
# configuration.yaml example
@@ -34,8 +36,8 @@ iri:
testnet:
description: Flag for indicating "testnet".
required: false
+ type: boolean
default: false
- type: bool
wallets:
description: List of IOTA wallets.
required: true
diff --git a/source/_components/joaoapps_join.markdown b/source/_components/joaoapps_join.markdown
index 822a14604ba..61ef1c09c9c 100644
--- a/source/_components/joaoapps_join.markdown
+++ b/source/_components/joaoapps_join.markdown
@@ -12,9 +12,15 @@ ha_category: Hub
ha_release: "0.24"
---
-The `joaoapps_join` component exposes services from [Join](http://joaoapps.com/join). In Home Assistant, the Join features are divided up in two locations, the Join component, and the Join notify platform. The notify platform allows us to send messages to Join devices, the component allows us to access the other special features that Join offers.
+The `joaoapps_join` component exposes services from
+[Join](http://joaoapps.com/join). In Home Assistant, the Join features are
+divided up in two locations, the Join component, and the Join notify platform.
+The notify platform allows us to send messages to Join devices, the component
+allows us to access the other special features that Join offers.
-In the `configuration.yaml` file you need to provide the api key and device id or name of the target device. You can find your device id and api key [here](https://joinjoaomgcd.appspot.com/).
+In the `configuration.yaml` file you need to provide the api key and device id
+or name of the target device. You can find your device id and api key
+[here](https://joinjoaomgcd.appspot.com/).
To set it up, add the following information to your `configuration.yaml` file:
@@ -33,20 +39,41 @@ joaoapps_join:
api_key: asd97823jb628a34fwsdfwefd5384345tf2d
```
-Configuration variables:
+{% configuration %}
+api_key:
+ description: The API key for Join.
+ required: true
+ type: string
+device_id:
+ description: The id of your device.
+ required: false
+ type: string
+device_ids:
+ description: Comma separated list of device ids.
+ required: false
+ type: string
+device_names:
+ description: Comma separated list of device names.
+ required: false
+ type: string
+{% endconfiguration %}
-- **api_key** (*Required*): The API key for Join.
-- **device_id** (*Optional*): The id of your device.
-- **device_ids** (*Optional*): Comma separated list of device ids.
-- **device_names** (*Optional*): Comma separated list of device names.
-
-The notify service has two optional parameters: `icon` and `vibration`. You can use them like so:
+The notify service has two optional parameters: `icon` and `vibration`.
+You can use them like so:
```json
-{"message":"Hello from Home Assistant!","title":"Home Assistant","data":{"icon":"https://goo.gl/xeetdy", "vibration":"0,65,706,86,657,95,668,100"}}
+{
+ "message": "Hello from Home Assistant!",
+ "title": "Home Assistant",
+ "data": {
+ "icon": "https://goo.gl/xeetdy",
+ "vibration": "0,65,706,86,657,95,668,100"
+ }
+}
```
-The services exposed in the `joaoapps_join` component can be used with the service data described below:
+The services exposed in the `joaoapps_join` component can be used with the
+service data described below:
| Service | Data |
|------------------------------ |------------------------------------------------------------------ |
diff --git a/source/_components/light.group.markdown b/source/_components/light.group.markdown
index 4ec8262463d..c70a6e7e78f 100644
--- a/source/_components/light.group.markdown
+++ b/source/_components/light.group.markdown
@@ -11,6 +11,7 @@ ha_category: Light
ha_release: 0.65
ha_iot_class: "Local Push"
logo: home-assistant.png
+ha_qa_scale: internal
---
The group light platform lets you combine multiple lights into one entity. All child lights of a light group can still be used as usual, but controlling the state of the grouped light will forward the command to each child light.
diff --git a/source/_components/light.hyperion.markdown b/source/_components/light.hyperion.markdown
index 7cba5e18f41..c7622a1a3fc 100644
--- a/source/_components/light.hyperion.markdown
+++ b/source/_components/light.hyperion.markdown
@@ -15,6 +15,8 @@ ha_iot_class: "Local Polling"
The `hyperion` platform allows you to integrate your [Hyperion](https://hyperion-project.org/wiki) into Home Assistant. Hyperion is an open source Ambilight implementation which runs on many platforms.
+## {% linkable_title Configuration %}
+
To use your Hyperion light in your installation, add the following to your `configuration.yaml` file:
```yaml
@@ -24,12 +26,38 @@ light:
host: IP_ADDRESS
```
-Configuration variables:
-
-- **host** (*Required*): The IP address of the device the Hyperion service is running on.
-- **port** (*Optional*): The port used to communicate with the Hyperion service. Defaults to `19444`.
-- **name** (*Optional*): The name of the device used in the frontend.
-- **priority** (*Optional*): The priority of the Hyperion instance. Defaults to `128`.
-- **hdmi_priority** (*Optional*): The priority of the HDMI grabber of this Hyperion instance, note that this priority must be higher than all other priorities used for correct behavior. Defaults to `880`.
-- **default_color** (*Optional*): The color of the light. Defaults to `[255, 255, 255]`.
-- **effect_list** (*Optional*): The list of effects that can be used. Defaults to `['HDMI', 'Cinema brighten lights', 'Cinema dim lights', 'Knight rider', 'Blue mood blobs', 'Cold mood blobs', 'Full color mood blobs', 'Green mood blobs', 'Red mood blobs', 'Warm mood blobs', 'Police Lights Single', 'Police Lights Solid', 'Rainbow mood', 'Rainbow swirl fast', 'Rainbow swirl', 'Random', 'Running dots', 'System Shutdown', 'Snake', 'Sparks Color', 'Sparks', 'Strobe blue', 'Strobe Raspbmc', 'Strobe white', 'Color traces', 'UDP multicast listener', 'UDP listener', 'X-Mas']`.
+{% configuration %}
+ host:
+ description: The IP address of the device the Hyperion service is running on.
+ required: true
+ type: string
+ port:
+ description: The port used to communicate with the Hyperion service.
+ required: false
+ type: int
+ default: 19444
+ name:
+ description: The name of the device used in the frontend.
+ required: false
+ type: string
+ priority:
+ description: The priority of the Hyperion instance.
+ required: false
+ type: int
+ default: 128
+ hdmi_priority:
+ description: The priority of the HDMI grabber of this Hyperion instance, note that this priority must be higher than all other priorities used for correct behavior.
+ required: false
+ type: int
+ default: 880
+ default_color:
+ description: The color of the light.
+ required: false
+ type: list
+ default: "[255, 255, 255]"
+ effect_list:
+ description: The list of effects that can be used.
+ required: false
+ type: list
+ default: "['HDMI', 'Cinema brighten lights', 'Cinema dim lights', 'Knight rider', 'Blue mood blobs', 'Cold mood blobs', 'Full color mood blobs', 'Green mood blobs', 'Red mood blobs', 'Warm mood blobs', 'Police Lights Single', 'Police Lights Solid', 'Rainbow mood', 'Rainbow swirl fast', 'Rainbow swirl', 'Random', 'Running dots', 'System Shutdown', 'Snake', 'Sparks Color', 'Sparks', 'Strobe blue', 'Strobe Raspbmc', 'Strobe white', 'Color traces', 'UDP multicast listener', 'UDP listener', 'X-Mas']"
+{% endconfiguration %}
diff --git a/source/_components/light.ihc.markdown b/source/_components/light.ihc.markdown
index 214f19564be..22a7b2cf60b 100644
--- a/source/_components/light.ihc.markdown
+++ b/source/_components/light.ihc.markdown
@@ -13,17 +13,19 @@ ha_release: 0.62
ha_iot_class: "Local Push"
---
-Before you can use the IHC Light platform, you must setup the [IHC Component](/components/ihc/)
+Before you can use the IHC Light platform, you must setup the
+[IHC Component](/components/ihc/)
-When auto setup is enabled the following products will be found in the IHC project and setup as light devices:
+When auto setup is enabled the following products will be found in the IHC
+project and setup as light devices:
-* Wireless lamp outlet dimmer
-* Wireless dimmer
-* Wireless combi dimmer 4 buttons
-* Wireless lamp outlet relay
-* Wireless combi relay 4 buttons
-* Wireless mobile dimmer
-* Dataline lamp outlet
+- Wireless lamp outlet dimmer
+- Wireless dimmer
+- Wireless combi dimmer 4 buttons
+- Wireless lamp outlet relay
+- Wireless combi relay 4 buttons
+- Wireless mobile dimmer
+- Dataline lamp outlet
To manually configure IHC lights insert this section in your configuration:
@@ -48,18 +50,19 @@ lights:
dimmable:
description: Set to True if the IHC resource is a light level
required: false
- type: bool
+ type: boolean
default: false
id:
description: The IHC resource id.
required: true
- type: int
+ type: integer
name:
description: The name of the component
required: false
type: string
{% endconfiguration %}
-In the example above 12345 is ihc resource id and "tablelight" is the name.
-The IHC resource id can be a light level for dimmers or a boolean output of a relay.
-For more information about IHC resource ids see [Manual Setup](/components/ihc/#manual-setup)
+In the example above 12345 is ihc resource id and "tablelight" is the name.
+The IHC resource id can be a light level for dimmers or a boolean output of a
+relay. For more information about IHC resource ids see
+[Manual Setup](/components/ihc/#manual-setup).
diff --git a/source/_components/light.lifx.markdown b/source/_components/light.lifx.markdown
index 04f444540fe..cb6dc00f2f9 100644
--- a/source/_components/light.lifx.markdown
+++ b/source/_components/light.lifx.markdown
@@ -22,10 +22,16 @@ _Please note, the `lifx` platform does not support Windows. The `lifx_legacy` pl
light:
- platform: lifx
```
-Configuration variables:
-
-- **broadcast** (*Optional*): The broadcast address for discovering lights. Only needed if using more than one network interface. Omit if you are unsure.
-- **server** (*Optional*): Your server address. Will listen on all interfaces if omitted. Omit if you are unsure.
+{% configuration %}
+broadcast:
+ description: The broadcast address for discovering lights. Only needed if using more than one network interface. Omit if you are unsure.
+ required: false
+ type: string
+server:
+ description: Your server address. Will listen on all interfaces if omitted. Omit if you are unsure.
+ required: false
+ type: string
+{% endconfiguration %}
## {% linkable_title Set state %}
diff --git a/source/_components/light.lw12wifi.markdown b/source/_components/light.lw12wifi.markdown
index 028528c6a56..c1b01102873 100644
--- a/source/_components/light.lw12wifi.markdown
+++ b/source/_components/light.lw12wifi.markdown
@@ -34,7 +34,7 @@ host:
port:
description: Some firmware versions of the LW-12 controller listen on different ports.
required: false
- type: int
+ type: integer
default: 5000
name:
description: Name to use in the frontend.
diff --git a/source/_components/light.mqtt.markdown b/source/_components/light.mqtt.markdown
index b7ca1ff13a5..b6409f10043 100644
--- a/source/_components/light.mqtt.markdown
+++ b/source/_components/light.mqtt.markdown
@@ -122,11 +122,11 @@ rgb_command_template:
required: false
type: string
rgb_command_topic:
- description: "The MQTT topic to publish commands to change the light's RGB state."
+ description: "The MQTT topic to publish commands to change the light's RGB state. Please note that the color value sent by Home Assistant is normalized to full brightness if `brightness_command_topic` is set. Brightness information is in this case sent separately in the `brightness_command_topic`. This will cause a light that expects an absolute color value (including brightness) to flicker."
required: false
type: string
rgb_state_topic:
- description: The MQTT topic subscribed to receive RGB state updates. The expected payload is the RGB values separated by commas, for example `255,0,127`.
+ description: "The MQTT topic subscribed to receive RGB state updates. The expected payload is the RGB values separated by commas, for example, `255,0,127`. Please note that the color value received by Home Assistant is normalized to full brightness. Brightness information is received separately in the `brightness_state_topic`."
required: false
type: string
rgb_value_template:
@@ -205,7 +205,7 @@ payload_not_available:
## {% linkable_title Examples %}
-In this section you will find some real life examples of how to use this sensor.
+In this section you will find some real-life examples of how to use this sensor.
### {% linkable_title Brightness and RGB support %}
diff --git a/source/_components/light.mqtt_json.markdown b/source/_components/light.mqtt_json.markdown
index cd4f65737e5..49dfbd502ef 100644
--- a/source/_components/light.mqtt_json.markdown
+++ b/source/_components/light.mqtt_json.markdown
@@ -177,7 +177,7 @@ payload_not_available:
## {% linkable_title Examples %}
-In this section you find some real life examples of how to use this sensor.
+In this section you find some real-life examples of how to use this sensor.
### {% linkable_title Brightness and RGB support %}
@@ -262,6 +262,8 @@ Home Assistant expects the hue values to be in the range 0 to 360 and the satura
- There is also another implementation forked from the above repo, it supports all the same features but is made for addressable LED strips using FastLED on a NodeMCU V3 it can be found [here](https://github.com/JammyDodger231/nodemcu-mqtt-rgb-led).
+- [McLighting](https://github.com/toblum/McLighting) is another ESP8266 firmware for WS2812 addressable LEDs.
+
- [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 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.
diff --git a/source/_components/light.mqtt_template.markdown b/source/_components/light.mqtt_template.markdown
index 11b43726724..27f5e0f0b33 100644
--- a/source/_components/light.mqtt_template.markdown
+++ b/source/_components/light.mqtt_template.markdown
@@ -137,7 +137,7 @@ payload_not_available:
## {% linkable_title Examples %}
-In this section you find some real life examples of how to use this light.
+In this section you find some real-life examples of how to use this light.
### {% linkable_title Simple string payload %}
diff --git a/source/_components/light.rpi_gpio_pwm.markdown b/source/_components/light.rpi_gpio_pwm.markdown
index 1ea0438332d..d292b213a54 100644
--- a/source/_components/light.rpi_gpio_pwm.markdown
+++ b/source/_components/light.rpi_gpio_pwm.markdown
@@ -45,7 +45,7 @@ Configuration variables:
## {% linkable_title Examples %}
-In this section you find some real life examples of how to use this sensor.
+In this section you find some real-life examples of how to use this sensor.
### {% linkable_title RGB LED connected to PCA9685 controller %}
diff --git a/source/_components/light.template.markdown b/source/_components/light.template.markdown
index 9d1315b3106..5ac3c4189b1 100644
--- a/source/_components/light.template.markdown
+++ b/source/_components/light.template.markdown
@@ -11,6 +11,7 @@ ha_category: Light
ha_release: 0.46
ha_iot_class: "Local Push"
logo: home-assistant.png
+ha_qa_scale: internal
---
The `template` platform creates lights that combine components and provides the
@@ -93,7 +94,7 @@ result:
## {% linkable_title Examples %}
-In this section you will find some real life examples of how to use this light.
+In this section you will find some real-life examples of how to use this light.
### {% linkable_title Theater Volume Control %}
diff --git a/source/_components/light.zigbee.markdown b/source/_components/light.zigbee.markdown
index a7d8529551e..d88f348cb44 100644
--- a/source/_components/light.zigbee.markdown
+++ b/source/_components/light.zigbee.markdown
@@ -24,9 +24,22 @@ light:
pin: 0
```
-Configuration variables:
-
-- **name** (*Required*): The name you would like to give the light in Home Assistant.
-- **pin** (*Required*): The number identifying which pin to use.
-- **address** (*Optional*): The long 64 bit address of the remote ZigBee device whose digital output pin you would like to switch. Do not include this variable if you want to switch the local ZigBee device's pins.
-- **on_state** (*Optional*): Either `high` (default) or `low`, depicting whether the digital output pin is pulled `high` or `low` when the light is turned on.
+{% configuration %}
+name:
+ description: The name you would like to give the light in Home Assistant.
+ required: true
+ type: string
+pin:
+ description: The number identifying which pin to use.
+ required: true
+ type: integer
+address:
+ description: The long 64-bit address of the remote ZigBee device whose digital output pin you would like to switch. Do not include this variable if you want to switch the local ZigBee device's pins.
+ required: false
+ type: string
+on_state:
+ description: Either `high` or `low`, depicting whether the digital output pin is pulled `high` or `low` when the light is turned on.
+ required: false
+ default: high
+ type: string
+{% endconfiguration %}
diff --git a/source/_components/lock.markdown b/source/_components/lock.markdown
index 97cc4622020..89d504093a3 100644
--- a/source/_components/lock.markdown
+++ b/source/_components/lock.markdown
@@ -14,6 +14,44 @@ Keeps track which locks are in your environment, their state and allows you to c
* Maintains a state per lock and a combined state `all_locks`.
* Registers services `lock.lock` and `lock.unlock` to control locks.
+### {% linkable_title Services %}
+
+A lock component provides the following services:
+
+#### {% linkable_title Service `lock.lock` %}
+
+Lock your door, the attribute should appear under a 'data' attribute for the service.
+
+| Service data attribute | Optional | Description |
+|---------------------------|----------|-------------------------------------------------------|
+| `entity_id` | no | Entity of the relevant lock. |
+
+##### {% linkable_title Example %}
+
+```yaml
+action:
+ service: lock.lock
+ data:
+ entity_id: lock.my_place
+```
+
+#### {% linkable_title Service `lock.unlock` %}
+
+Unlock your door, the attribute should appear under a 'data' attribute for the service.
+
+| Service data attribute | Optional | Description |
+|---------------------------|----------|-------------------------------------------------------|
+| `entity_id` | no | Entity of the relevant lock. |
+
+##### {% linkable_title Example %}
+
+```yaml
+action:
+ service: lock.unlock
+ data:
+ entity_id: lock.my_place
+```
+
### {% linkable_title Use the services %}
Go to the **Developer Tools**, then to **Call Service** in the frontend, and choose `lock.lock` or `lock.unlock` from the list of available services (**Services:** on the left). Enter something like the sample below into the **Service Data** field and hit **CALL SERVICE**.
diff --git a/source/_components/lock.mqtt.markdown b/source/_components/lock.mqtt.markdown
index a1689fbd199..7009e9224e9 100644
--- a/source/_components/lock.mqtt.markdown
+++ b/source/_components/lock.mqtt.markdown
@@ -95,7 +95,7 @@ Make sure that your topics match exactly. `some-topic/` and `some-topic` are dif
## {% linkable_title Examples %}
-In this section you will find some real life examples of how to use this lock.
+In this section you will find some real-life examples of how to use this lock.
### {% linkable_title Full configuration %}
diff --git a/source/_components/logbook.markdown b/source/_components/logbook.markdown
index 438e7474306..eb3682fb339 100644
--- a/source/_components/logbook.markdown
+++ b/source/_components/logbook.markdown
@@ -11,25 +11,55 @@ logo: logbook.png
ha_category: "History"
---
-
When you set **power_on_enabled** as True, you have to turn on your TV on the first time with the remote.
-Then you will be able to turn on with Home-Assistant.
+Then you will be able to turn on with Home Assistant.
Also, with **power_on_enabled** as True, the Aquos logo on your TV will stay on when you turn off the TV and your TV could consumes more power.
This platform now uses the web interface of the Logitech Media Server to send commands. The default port of the web interface is 9000. It is the same port that you use to access the LMS through your web browser. Originally, this platform used the telnet interface, which defaults to 9090. If you previously specified the port in your configuration file, you will likely need to update it.
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:
+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:
```yaml
# Example configuration.yaml entry
logbook:
```
-Configuration variables:
+{% configuration %}
+exclude:
+ description: "Configure which components should **not** create logbook entries."
+ required: false
+ type: map
+ keys:
+ entities:
+ description: The list of entity ids to be excluded from creating logbook entries.
+ required: false
+ type: list
+ domains:
+ description: The list of domains to be excluded from creating logbook entries.
+ required: false
+ type: list
+include:
+ description: Configure which components should create logbook entries.
+ required: false
+ type: map
+ keys:
+ entities:
+ description: The list of entity ids to be included in creating logbook entries.
+ required: false
+ type: list
+ domains:
+ description: The list of domains to be included in creating logbook entries.
+ required: false
+ type: list
+{% endconfiguration %}
-- **exclude** (*Optional*): Configure which components should **not** create logbook entries.
- - **entities** (*Optional*): The list of entity ids to be excluded from creating logbook entries.
- - **domains** (*Optional*): The list of domains to be excluded from creating logbook entries.
-- **include** (*Optional*): Configure which components should create logbook entries.
- - **entities** (*Optional*): The list of entity ids to be included in creating logbook entries.
- - **domains** (*Optional*): The list of domains to be included in creating logbook entries.
-
-If you want to exclude messages of some entities or domains from the logbook just add the `exclude` parameter like:
+If you want to exclude messages of some entities or domains from the logbook
+just add the `exclude` parameter like:
```yaml
# Example of excluding domains and entities from the logbook
@@ -43,7 +73,8 @@ logbook:
- weblink
```
-In case you just want to see messages from some specific entities or domains use the `include` configuration:
+In case you just want to see messages from some specific entities or domains use
+the `include` configuration:
```yaml
# Example to show how to include only the listed domains and entities in the logbook
@@ -55,7 +86,9 @@ logbook:
- media_player
```
-You can also use the `include` list and filter out some entities or domains with an `exclude` list. Usually this makes sense if you define domains on the include side and filter out some specific entities.
+You can also use the `include` list and filter out some entities or domains with
+an `exclude` list. Usually this makes sense if you define domains on the include
+side and filter out some specific entities.
```yaml
# Example of combining include and exclude configurations
@@ -73,14 +106,22 @@ logbook:
### {% linkable_title Exclude Events %}
-Entities customized as hidden are excluded from the logbook by default, but sometimes you want to show the entity in the UI and not in the logbook. For instance you use the `sensor.date`to show the current date in the UI, but you do not want a logbook entry for that sensor every day.
-To exclude these entities just add them to the `exclude` > `entities` list in the configuration of the logbook.
+Entities customized as hidden are excluded from the logbook by default,
+but sometimes you want to show the entity in the UI and not in the logbook.
+For instance you use the `sensor.date`to show the current date in the UI,
+but you do not want a logbook entry for that sensor every day.
+To exclude these entities just add them to the `exclude` > `entities` list in
+the configuration of the logbook.
-To exclude all events from a whole domain add it to the `exclude` > `domain` list. For instance you use the `sun` domain only to trigger automations on the `azimuth attribute, then you possible are not interested in the logbook entries for sun rise and sun set.
+To exclude all events from a whole domain add it to the `exclude` > `domain`
+list. For instance you use the `sun` domain only to trigger automations on the
+`azimuth` attribute, then you possible are not interested in the logbook entries
+for sun rise and sun set.
### {% linkable_title Custom Entries %}
-It is possible to add custom entries to the logbook by using the script component to fire an event.
+It is possible to add custom entries to the logbook by using the script
+component to fire an event.
```yaml
# Example configuration.yaml entry
diff --git a/source/_components/logger.markdown b/source/_components/logger.markdown
index d3cef23a013..9fa7c1b3e12 100644
--- a/source/_components/logger.markdown
+++ b/source/_components/logger.markdown
@@ -9,18 +9,22 @@ sharing: true
footer: true
logo: home-assistant.png
ha_category: "Utility"
+ha_qa_scale: internal
---
-The `logger` component lets you define the level of logging activities in Home Assistant.
+The `logger` component lets you define the level of logging activities in Home
+Assistant.
-To enable the `logger` component in your installation, add the following to your `configuration.yaml` file:
+To enable the `logger` component in your installation,
+add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
logger:
```
-To log all messages and ignore events lower than critical for specified components:
+To log all messages and ignore events lower than critical for specified
+components:
```yaml
# Example configuration.yaml entry
@@ -31,7 +35,8 @@ logger:
homeassistant.components.camera: critical
```
-To ignore all messages lower than critical and log event for specified components:
+To ignore all messages lower than critical and log event for specified
+components:
```yaml
# Example configuration.yaml entry
@@ -102,9 +107,10 @@ data:
homeassistant.components.media_player.yamaha: debug
```
-The log information are stored in the [configuration directory](/docs/configuration/)
-as `home-assistant.log` and you can read it with the command-line tool `cat` or
-follow it dynamically with `tail -f`.
+The log information are stored in the
+[configuration directory](/docs/configuration/) as `home-assistant.log`
+and you can read it with the command-line tool `cat` or follow it dynamically
+with `tail -f`.
If you are a Hassbian user you can use the example below:
diff --git a/source/_components/map.markdown b/source/_components/map.markdown
index deacb922222..c7a5e90eefe 100644
--- a/source/_components/map.markdown
+++ b/source/_components/map.markdown
@@ -9,6 +9,7 @@ sharing: true
footer: true
logo: home-assistant.png
ha_category: "Other"
+ha_qa_scale: internal
---
This offers a map on the frontend to display the location of tracked devices. To set up tracked devices, look at the [device tracker](/components/device_tracker/) documentation.
diff --git a/source/_components/maxcube.markdown b/source/_components/maxcube.markdown
index 7439d2d19fe..223d962f68f 100644
--- a/source/_components/maxcube.markdown
+++ b/source/_components/maxcube.markdown
@@ -56,11 +56,11 @@ maxcube:
port:
description: The UDP port number.
required: false
- type: int
+ type: integer
default: 62910
scan_interval:
description: The update interval in seconds
required: false
- type: int
+ type: integer
default: 300
{% endconfiguration %}
diff --git a/source/_components/media_extractor.markdown b/source/_components/media_extractor.markdown
index 8386b0390a3..60b03259a0e 100644
--- a/source/_components/media_extractor.markdown
+++ b/source/_components/media_extractor.markdown
@@ -10,6 +10,7 @@ footer: true
logo: home-assistant.png
ha_category: Media Player
ha_release: 0.49
+ha_qa_scale: internal
---
diff --git a/source/_components/media_player.aquostv.markdown b/source/_components/media_player.aquostv.markdown
index 0e3dbcba7e0..156f50853f0 100644
--- a/source/_components/media_player.aquostv.markdown
+++ b/source/_components/media_player.aquostv.markdown
@@ -38,7 +38,7 @@ Configuration variables:
in the side bar. Using your web browsers search tool to find the `hangouts.conversations` entity. You will find something like bellow
+
+```
+0: {
+ "id": "HTML5 push notifications **do not** work on iOS.
-To enable this platform, add the following lines to your `configuration.yaml` file: +To enable this platform, +add the following lines to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry notify: - - name: NOTIFIER_NAME - platform: html5 + - platform: html5 + name: NOTIFIER_NAME gcm_api_key: 'gcm-server-key' gcm_sender_id: 'gcm-sender-id' ``` -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`. -- **gcm_api_key** (*Required if pushing to Chrome*): The API Server key provided to you by Google for Google Cloud Messaging (GCM). Required to push to Chrome. -- **gcm_sender_id** (*Required if pushing to Chrome*): The sender ID provided to you by Google for Google Cloud Messaging (GCM). Required to push to Chrome. +{% 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 + type: string + default: notify +gcm_api_key: + description: The API Server key provided to you by Google for Google Cloud Messaging (GCM). Required to push to Chrome. + required: true + type: string +gcm_sender_id: + description: The sender ID provided to you by Google for Google Cloud Messaging (GCM). Required to push to Chrome. + required: true + type: string +{% endconfiguration %} ### {% linkable_title Getting ready for Chrome %} @@ -92,13 +106,17 @@ Assuming the previous test completed successfully and your browser was registere ### {% linkable_title Usage %} -The `html5` platform accepts a standard notify payload. However, there are also some special features built in which you can control in the payload. +The `html5` platform accepts a standard notify payload. However, there are also +some special features built in which you can control in the payload. -Any JSON examples below can be [converted to YAML](https://www.json2yaml.com/) for automations. +Any JSON examples below can be [converted to YAML](https://www.json2yaml.com/) +for automations. #### {% linkable_title Actions %} -Chrome supports notification actions, which are configurable buttons that arrive with the notification and can cause actions on Home Assistant to happen when pressed. You can send [up to 2 actions](https://cs.chromium.org/chromium/src/third_party/WebKit/public/platform/modules/notifications/WebNotificationConstants.h?q=maxActions&sq=package:chromium&dr=CSs&l=14). +Chrome supports notification actions, +which are configurable buttons that arrive with the notification and can cause +actions on Home Assistant to happen when pressed. You can send up to 2 actions. ```json { @@ -121,7 +139,10 @@ Chrome supports notification actions, which are configurable buttons that arrive #### {% linkable_title Data %} -Any parameters that you pass in the notify payload that aren't valid for use in the HTML5 notification (`actions`, `badge`, `body`, `dir`, `icon`, `image`, `lang`, `renotify`, `requireInteraction`, `tag`, `timestamp`, `vibrate`) will be sent back to you in the [callback events](#automating-notification-events). +Any parameters that you pass in the notify payload that aren't valid for use in +the HTML5 notification (`actions`, `badge`, `body`, `dir`, `icon`, `image`, +`lang`, `renotify`, `requireInteraction`, `tag`, `timestamp`, `vibrate`) will be +sent back to you in the [callback events](#automating-notification-events). ```json { @@ -135,7 +156,11 @@ Any parameters that you pass in the notify payload that aren't valid for use in #### {% linkable_title Tag %} -By default, every notification sent has a randomly generated UUID (v4) set as its _tag_ or unique identifier. The tag is unique to the notification, _not_ to a specific target. If you pass your own tag in the notify payload you can replace the notification by sending another notification with the same tag. You can provide a `tag` like so: +By default, every notification sent has a randomly generated UUID (v4) set as +its _tag_ or unique identifier. The tag is unique to the notification, _not_ to +a specific target. If you pass your own tag in the notify payload you can +replace the notification by sending another notification with the same tag. +You can provide a `tag` like so: ```json { @@ -147,7 +172,8 @@ By default, every notification sent has a randomly generated UUID (v4) set as it } ``` -Example of adding a tag to your notification. This won't create new notification if there already exists one with the same tag. +Example of adding a tag to your notification. This won't create new notification +if there already exists one with the same tag. ```yaml - alias: Push/update notification of sensor state with tag @@ -165,7 +191,9 @@ Example of adding a tag to your notification. This won't create new notification #### {% linkable_title Targets %} -If you do not provide a `target` parameter in the notify payload a notification will be sent to all registered targets as listed in `html5_push_registrations.conf`. You can provide a `target` parameter like so: +If you do not provide a `target` parameter in the notify payload a notification +will be sent to all registered targets as listed in +`html5_push_registrations.conf`. You can provide a `target` parameter like so: ```json { @@ -187,11 +215,16 @@ If you do not provide a `target` parameter in the notify payload a notification #### {% linkable_title Overrides %} -You can pass any of the parameters listed [here](https://developer.mozilla.org/en-US/docs/Web/API/ServiceWorkerRegistration/showNotification#Parameters) in the `data` dictionary. Please note, [Chrome specifies](https://cs.chromium.org/chromium/src/third_party/WebKit/public/platform/modules/notifications/WebNotificationConstants.h?q=maxActions&sq=package:chromium&dr=CSs&l=21) that the maximum size for an icon is 320px by 320px, the maximum `badge` size is 96px by 96px and the maximum icon size for an action button is 128px by 128px. +You can pass any of the parameters listed +[here](https://developer.mozilla.org/en-US/docs/Web/API/ServiceWorkerRegistration/showNotification#Parameters) +in the `data` dictionary. Please note, Chrome specifies that the maximum size +for an icon is 320px by 320px, the maximum `badge` size is 96px by 96px and the +maximum icon size for an action button is 128px by 128px. #### {% linkable_title URL %} -You can provide a URL to open when the notification is clicked by putting `url` in the data dictionary like so: +You can provide a URL to open when the notification is clicked by putting `url` +in the data dictionary like so: ```json { @@ -203,11 +236,15 @@ You can provide a URL to open when the notification is clicked by putting `url` } ``` -If no URL or actions are provided, interacting with a notification will open your Home Assistant in the browser. You can use relative URLs to refer to Home Assistant, i.e. `/map` would turn into `https://192.168.1.2:8123/map`. +If no URL or actions are provided, interacting with a notification will open +your Home Assistant in the browser. You can use relative URLs to refer to Home +Assistant, i.e. `/map` would turn into `https://192.168.1.2:8123/map`. ### {% linkable_title Automating notification events %} -During the lifespan of a single push notification, Home Assistant will emit a few different events to the event bus which you can use to write automations against. +During the lifespan of a single push notification, +Home Assistant will emit a few different events to the event bus which you can +use to write automations against. Common event payload parameters are: @@ -219,11 +256,15 @@ Common event payload parameters are: | `target` | The target that this notification callback describes. | | `type` | The type of event callback received. Can be `received`, `clicked` or `closed`. | -You can use the `target` parameter to write automations against a single `target`. For more granularity, use `action` and `target` together to write automations which will do specific things based on what target clicked an action. +You can use the `target` parameter to write automations against a single +`target`. For more granularity, +use `action` and `target` together to write automations which will do specific +things based on what target clicked an action. #### {% linkable_title received event %} -You will receive an event named `html5_notification.received` when the notification is received on the device. +You will receive an event named `html5_notification.received` when the +notification is received on the device. ```yaml - alias: HTML5 push notification received and displayed on device @@ -234,7 +275,9 @@ You will receive an event named `html5_notification.received` when the notificat #### {% linkable_title clicked event %} -You will receive an event named `html5_notification.clicked` when the notification or a notification action button is clicked. The action button clicked is available as `action` in the `event_data`. +You will receive an event named `html5_notification.clicked` when the +notification or a notification action button is clicked. +The action button clicked is available as `action` in the `event_data`. ```yaml - alias: HTML5 push notification clicked @@ -256,7 +299,8 @@ or #### {% linkable_title closed event %} -You will receive an event named `html5_notification.closed` when the notification is closed. +You will receive an event named `html5_notification.closed` when the +notification is closed. ```yaml - alias: HTML5 push notification clicked @@ -267,7 +311,10 @@ You will receive an event named `html5_notification.closed` when the notificatio ### {% linkable_title Making notifications work with NGINX proxy %} -If you use [NGINX](/ecosystem/nginx/) as a proxy with authentication in front of your Home Assistant instance, you may have trouble with receiving events back to Home Assistant. It's because of authentication token that cannot be passed through the proxy. +If you use [NGINX](/ecosystem/nginx/) as a proxy with authentication in front of +your Home Assistant instance, +you may have trouble with receiving events back to Home Assistant. +It's because of authentication token that cannot be passed through the proxy. To solve the issue put additional location into your nginx site's configuration: @@ -281,9 +328,11 @@ location /api/notify.html5/callback { } ``` -This rule check if request have `Authorization` HTTP header and bypass the htpasswd (if you use one). +This rule check if request have `Authorization` HTTP header and bypass the +htpasswd (if you use one). If you still have the problem, even with mentioned rule, try to add this code: + ```bash proxy_set_header Authorization $http_authorization; proxy_pass_header Authorization; diff --git a/source/_components/notify.joaoapps_join.markdown b/source/_components/notify.joaoapps_join.markdown index 2143480d0e3..e5b6c76e90a 100644 --- a/source/_components/notify.joaoapps_join.markdown +++ b/source/_components/notify.joaoapps_join.markdown @@ -12,5 +12,5 @@ ha_category: Notifications ha_release: "0.24" --- -See the [Joaoapps Join component page](/components/joaoapps_join/) for information how to get the join notify platform running. - +See the [Joaoapps Join component page](/components/joaoapps_join/) for +information how to get the join notify platform running. diff --git a/source/_components/notify.lametric.markdown b/source/_components/notify.lametric.markdown index b9ee3343439..f68d978dba3 100644 --- a/source/_components/notify.lametric.markdown +++ b/source/_components/notify.lametric.markdown @@ -32,7 +32,7 @@ name: lifetime: description: Defines how long the message remains in LaMetric notification queue (in seconds). required: false - type: int + type: integer default: 10 icon: description: An icon or animation. @@ -41,7 +41,7 @@ icon: cycles: description: Defines how often the notification is displayed. required: false - type: int + type: integer default: 1 priority: description: Defines the priority of the notification. diff --git a/source/_components/notify.telegram.markdown b/source/_components/notify.telegram.markdown index 9fd9b2f0d63..42acb5bd290 100644 --- a/source/_components/notify.telegram.markdown +++ b/source/_components/notify.telegram.markdown @@ -84,10 +84,17 @@ notify: chat_id: CHAT_ID_2 ``` -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`. -- **chat_id** (*Required*): The chat ID of your user. +{% 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 +chat_id: + description: The chat ID of your user. + required: true + type: integer +{% endconfiguration %} To use notifications, please see the [getting started with automation page](/getting-started/automation/). @@ -106,12 +113,24 @@ action: - 'Task 3:/command3, Task 4:/command4' ``` -Configuration variables: - -- **message** (*Required*): Message text. -- **title** (*Optional*): Will be composed as '%title\n%message'. -- **keyboard** (*Optional*): List of rows of commands, comma-separated, to make a custom keyboard. -- **inline_keyboard** (*Optional*): List of rows of commands, comma-separated, to make a custom inline keyboard with buttons with associated callback data. +{% configuration %} +title: + description: Will be composed as '%title\n%message'. + required: false + type: string +message: + description: Message text. + required: true + type: string +keyboard: + description: List of rows of commands, comma-separated, to make a custom keyboard. + required: false + type: list +inline_keyboard: + description: List of rows of commands, comma-separated, to make a custom inline keyboard with buttons with associated callback data. + required: false + type: list +{% endconfiguration %} ### {% linkable_title Photo support %} @@ -133,15 +152,41 @@ action: caption: I.e. for a Title ``` -Configuration variables: - -- **url** or **file** (*Required*): For local or remote path to an image. -- **caption** (*Optional*): The title of the image. -- **username** (*Optional*): Username for a URL which require HTTP authentication. -- **password** (*Optional*): Username for a URL which require HTTP authentication. -- **authentication** (*Optional*): Set to 'digest' to use HTTP digest authentication, defaults to 'basic'. -- **keyboard** (*Optional*): List of rows of commands, comma-separated, to make a custom keyboard. -- **inline_keyboard** (*Optional*): List of rows of commands, comma-separated, to make a custom inline keyboard with buttons with associated callback data. +{% configuration %} +url: + description: A remote path to an image. Either this or the `file` configuration option is required. + required: true + type: string +file: + description: A local path to an image. Either this or the `url` configuration option is required. + required: true + type: string +caption: + description: The title of the image. + required: false + type: string +username: + description: Username for a URL which require HTTP authentication. + required: false + type: string +password: + description: Password for a URL which require HTTP authentication. + required: false + type: string +authentication: + description: Set to 'digest' to use HTTP digest authentication. + required: false + default: basic + type: string +keyboard: + description: List of rows of commands, comma-separated, to make a custom keyboard. + required: false + type: list +inline_keyboard: + description: List of rows of commands, comma-separated, to make a custom inline keyboard with buttons with associated callback data. + required: false + type: list +{% endconfiguration %}Since Home Assistant version 0.48 you have to [whitelist the source folder](/docs/configuration/basic/) of the file you want to include in the notification. @@ -176,15 +221,41 @@ action: caption: I.e. for a Title ``` -Configuration variables: - -- **url** or **file** (*Required*): For local or remote path to a video. -- **caption** (*Optional*): The title of the video. -- **username** (*Optional*): Username for a URL which require HTTP authentication. -- **password** (*Optional*): Username for a URL which require HTTP authentication. -- **authentication** (*Optional*): Set to 'digest' to use HTTP digest authentication, defaults to 'basic'. -- **keyboard** (*Optional*): List of rows of commands, comma-separated, to make a custom keyboard. -- **inline_keyboard** (*Optional*): List of rows of commands, comma-separated, to make a custom inline keyboard with buttons with associated callback data. +{% configuration %} +url: + description: A remote path to an video. Either this or the `file` configuration option is required. + required: true + type: string +file: + description: A local path to an video. Either this or the `url` configuration option is required. + required: true + type: string +caption: + description: The title of the video. + required: false + type: string +username: + description: Username for a URL which require HTTP authentication. + required: false + type: string +password: + description: Password for a URL which require HTTP authentication. + required: false + type: string +authentication: + description: Set to 'digest' to use HTTP digest authentication. + required: false + default: basic + type: string +keyboard: + description: List of rows of commands, comma-separated, to make a custom keyboard. + required: false + type: list +inline_keyboard: + description: List of rows of commands, comma-separated, to make a custom inline keyboard with buttons with associated callback data. + required: false + type: list +{% endconfiguration %} ### {% linkable_title Document support %} @@ -204,15 +275,41 @@ action: - '/command3, /command4' ``` -Configuration variables: - -- **url** or **file** (*Required*): For local or remote path to a document. -- **caption** (*Optional*): The title of the document. -- **username** (*Optional*): Username for a URL which require HTTP authentication. -- **password** (*Optional*): Username for a URL which require HTTP authentication. -- **authentication** (*Optional*): Set to 'digest' to use HTTP digest authentication, defaults to 'basic'. -- **keyboard** (*Optional*): List of rows of commands, comma-separated, to make a custom keyboard. -- **inline_keyboard** (*Optional*): List of rows of commands, comma-separated, to make a custom inline keyboard with buttons with associated callback data. +{% configuration %} +url: + description: A remote path to an document. Either this or the `file` configuration option is required. + required: true + type: string +file: + description: A local path to an document. Either this or the `url` configuration option is required. + required: true + type: string +caption: + description: The title of the document. + required: false + type: string +username: + description: Username for a URL which require HTTP authentication. + required: false + type: string +password: + description: Password for a URL which require HTTP authentication. + required: false + type: string +authentication: + description: Set to 'digest' to use HTTP digest authentication. + required: false + default: basic + type: string +keyboard: + description: List of rows of commands, comma-separated, to make a custom keyboard. + required: false + type: list +inline_keyboard: + description: List of rows of commands, comma-separated, to make a custom inline keyboard with buttons with associated callback data. + required: false + type: list +{% endconfiguration %} ### {% linkable_title Location support %} @@ -230,9 +327,21 @@ action: longitude: 117.22743 ``` -Configuration variables: - -- **latitude** (*Required*): The latitude to send. -- **longitude** (*Required*): The longitude to send. -- **keyboard** (*Optional*): List of rows of commands, comma-separated, to make a custom keyboard. -- **inline_keyboard** (*Optional*): List of rows of commands, comma-separated, to make a custom inline keyboard with buttons with associated callback data. +{% configuration %} +latitude: + description: The latitude to send. + required: true + type: float +longitude: + description: The longitude to send. + required: true + type: float +keyboard: + description: List of rows of commands, comma-separated, to make a custom keyboard. + required: false + type: list +inline_keyboard: + description: List of rows of commands, comma-separated, to make a custom inline keyboard with buttons with associated callback data. + required: false + type: list +{% endconfiguration %} diff --git a/source/_components/notify.webostv.markdown b/source/_components/notify.webostv.markdown index c3dbadfbe4a..65603b7bb0c 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 on how to integrate a LG WebOS TV within Home Assistant." +title: "LG webOS TV notifications" +description: "Instructions on how to integrate a LG webOS TV within Home Assistant." date: 2016-04-18 23:24 sidebar: true comments: false @@ -13,11 +13,13 @@ ha_iot_class: "Local Polling" ha_release: 0.18 --- -The `webostv` platform allows you to send notifications to a LG WebOS Smart TV. +The `webostv` platform allows you to send notifications to a LG webOS Smart TV. -When the TV is first connected, you will need to accept Home Assistant on the TV to allow communication. +When the TV is first connected, +you will need to accept Home Assistant on the TV to allow communication. -To add a TV to your installation, add the following to your `configuration.yaml` file and follow the configurator instructions: +To add a TV to your installation, add the following to your `configuration.yaml` +file and follow the configurator instructions: ```yaml # Example configuration.yaml entry @@ -28,12 +30,25 @@ notify: filename: webostv.conf ``` -Configuration variables: - -- **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. +{% configuration %} +host: + description: The IP of the LG webOS Smart TV, e.g., 192.168.0.10 + required: true + type: string +name: + description: The name you would like to give to the LG webOS Smart TV. + required: true + type: string +filename: + description: "The filename where the pairing key with the TV should be stored. This path is relative to Home Assistant's config directory. **NOTE**: When using multiple TVs each TV will need its own unique file." + required: false + type: string + default: webostv.conf +icon: + description: The path to an image file to use as the icon in notifications. + required: false + type: [string, icon] +{% endconfiguration %} A possible automation could be: @@ -51,7 +66,8 @@ automation: message: "You should open a window! (Livingroom Co2: {{ states.sensor.netatmo_livingroom_co2.state }}ppm)" ``` -The icon can be overridden for individual notifications by providing a path to an alternative icon image to use: +The icon can be overridden for individual notifications by providing a path to +an alternative icon image to use: ```yaml automation: diff --git a/source/_components/nuimo_controller.markdown b/source/_components/nuimo_controller.markdown index 92b1bbd618f..e450fc515f0 100644 --- a/source/_components/nuimo_controller.markdown +++ b/source/_components/nuimo_controller.markdown @@ -64,4 +64,4 @@ Troubleshooting: - install the newest version of [pygattlib](https://bitbucket.org/OscarAcena/pygattlib) from the repository, either because there is no binary package for your system or the pip version contains errors, with `pip install hg+https://bitbucket.org/OscarAcena/pygattlib --target $HOME/.homeassistant/deps`. (Dependencies of pygattlib: `sudo apt-get install pkg-config libboost-python-dev libboost-thread-dev libbluetooth-dev libglib2.0-dev python-dev`) -Then invoke home-assistant with `hass --skip-pip`. +Then invoke Home Assistant with `hass --skip-pip`. diff --git a/source/_components/octoprint.markdown b/source/_components/octoprint.markdown index 03f0fae06d4..29e6c039ed9 100644 --- a/source/_components/octoprint.markdown +++ b/source/_components/octoprint.markdown @@ -34,3 +34,12 @@ Configuration variables: - **bed** (*Optional*): If the printer has a heated bed. - **number_of_tools** (*Optional*): Number of temperature adjustable tools. i.e. nozzle. +If the OctoPrint host is equipped with a web camera it is possible to add this as well. + +```yaml +camera: + - platform: mjpeg + name: OctoPrint + still_image_url: http://YOUR_OCTOPRINT_HOST_IP/webcam/?action=snapshot + mjpeg_url: http://YOUR_OCTOPRINT_HOST_IP/webcam/?action=stream +``` diff --git a/source/_components/openuv.markdown b/source/_components/openuv.markdown index acb6f184bed..390249c7d30 100644 --- a/source/_components/openuv.markdown +++ b/source/_components/openuv.markdown @@ -53,7 +53,7 @@ api_key: scan_interval: description: the frequency (in seconds) between data updates required: false - type: int + type: integer default: 1800 binary_sensors: description: binary sensor-related configuration options diff --git a/source/_components/panel_iframe.markdown b/source/_components/panel_iframe.markdown index 908ca35829b..ba13cf6967b 100644 --- a/source/_components/panel_iframe.markdown +++ b/source/_components/panel_iframe.markdown @@ -55,8 +55,8 @@ panel_iframe: required: true type: string icon: - description: Icon for entry. Pick an icon that you can find on [materialdesignicons.com](https://materialdesignicons.com/) to use for your input and prefix the name with `mdi:`. For example `mdi:car`, `mdi:ambulance`, or `mdi:motorbike`. + description: Icon for entry. required: false - type: string + type: icon {% endconfiguration %} diff --git a/source/_components/persistent_notification.markdown b/source/_components/persistent_notification.markdown index 9fac3ddc0cf..d43ab0b4361 100644 --- a/source/_components/persistent_notification.markdown +++ b/source/_components/persistent_notification.markdown @@ -10,6 +10,7 @@ footer: true logo: home-assistant.png ha_category: Other ha_release: 0.23 +ha_qa_scale: internal --- The `persistent_notification` can be used to show a message on the frontend that has to be dismissed by the user. @@ -55,6 +56,29 @@ action: notification_id: "1234" ``` +This automation example shows a notification when the Z-Wave network is starting and removes it when the network is ready. + +```yaml +- alias: 'Z-Wave network is starting' + trigger: + - platform: event + event_type: zwave.network_start + action: + - service: persistent_notification.create + data: + title: "Z-Wave" + message: "Z-Wave network is starting..." + notification_id: zwave + +- alias: 'Z-Wave network is ready' + trigger: + - platform: event + event_type: zwave.network_ready + action: + - service: persistent_notification.dismiss + data: + notification_id: zwave +``` ### {% linkable_title Markdown support %} diff --git a/source/_components/plant.markdown b/source/_components/plant.markdown index df2947e19da..b133b98f942 100644 --- a/source/_components/plant.markdown +++ b/source/_components/plant.markdown @@ -10,6 +10,7 @@ footer: true logo: home-assistant.png ha_category: Environment ha_release: 0.44 +ha_qa_scale: internal --- This`plant`component lets you merge moisture, conductivity, light intensity, temperature and battery level for a plant into a single UI element. It also supports setting minimum and maximum values for each measurement and will change its state to "problem" if it is not within those limits. diff --git a/source/_components/rainmachine.markdown b/source/_components/rainmachine.markdown index 61ebb649104..c82d3cfc9b3 100644 --- a/source/_components/rainmachine.markdown +++ b/source/_components/rainmachine.markdown @@ -55,7 +55,7 @@ password: port: description: the TCP port used by your unit for the REST API required: false - type: int + type: integer default: 8080 ssl: description: whether communication with the local device should occur over HTTPS @@ -65,7 +65,7 @@ ssl: scan_interval: description: the frequency (in seconds) between data updates required: false - type: int + type: integer default: 60 binary_sensors: description: binary sensor-related configuration options @@ -95,7 +95,7 @@ switches: zone_run_time: description: the default number of seconds that a zone should run when turned on required: false - type: int + type: integer default: 600 {% endconfiguration %} diff --git a/source/_components/recorder.markdown b/source/_components/recorder.markdown index d843e6f1200..230ac6b1bc0 100644 --- a/source/_components/recorder.markdown +++ b/source/_components/recorder.markdown @@ -10,6 +10,7 @@ footer: true logo: home-assistant.png ha_category: "History" ha_release: pre 0.7 +ha_qa_scale: internal --- The `recorder` component is storing details in a database which then are handled by the [`history` component](/components/history/). @@ -39,12 +40,12 @@ recorder: description: Specify the number of history days to keep in recorder database after a purge. required: false default: 10 - type: int + type: integer purge_interval: description: How often (in days) the purge task runs. If a scheduled purge is missed (e.g., if Home Assistant was not running), the schedule will resume soon after Home Assistant restarts. You can use the [service](#service-purge) call `purge` when required without impacting the purge schedule. If this is set to `0` (zero), automatic purging is disabled. required: false default: 1 - type: int + type: integer exclude: description: Configure which components should be excluded required: false @@ -158,7 +159,7 @@ If the `recorder` component is activated then some components support `restore_s | MS SQL Server | `mssql+pymssql://user:pass@SERVER_IP/DB_NAME?charset=utf8` |
-If you use MariaDB 10 you need to add port 3307 to the SERVER_IP, e.g., `mysql://user:password@SERVER_IP:3307/DB_NAME?charset=utf8`. +If you use MariaDB 10 you need to add port 3307 (or another port depending on which port is used by, for example: your hosting provider.) to the SERVER_IP, e.g., `mysql://user:password@SERVER_IP:3307/DB_NAME?charset=utf8`.
@@ -167,6 +168,10 @@ Unix Socket connections always bring performance advantages over TCP, if the dat
If you want to use Unix Sockets for PostgreSQL you need to modify the `pg_hba.conf`. See [PostgreSQL](#postgresql)
++If you are using the default `FULL` recovery model for MS SQL Server you will need to manually backup your log file to prevent your transaction log from growing too large. It is recommended you change the recovery model to `SIMPLE` unless you are worried about data loss between backups. +
+ ### {% linkable_title Database startup %} If you are running a database server instance on the same server as Home Assistant then you must ensure that this service starts before Home Assistant. For a Linux instance running Systemd (Raspberry Pi, Debian, Ubuntu and others) then you should edit the service file. diff --git a/source/_components/remote.harmony.markdown b/source/_components/remote.harmony.markdown index c6178d048c9..6785cdb9fc4 100644 --- a/source/_components/remote.harmony.markdown +++ b/source/_components/remote.harmony.markdown @@ -13,7 +13,6 @@ ha_iot_class: "Local Push" ha_release: "0.34" --- - The `harmony` remote platform allows you to control the state of your [Harmony Hub Device](http://www.logitech.com/en-us/product/harmony-hub). Supported units: @@ -77,6 +76,25 @@ Start an activity. Will start the default `activity` from configuration.yaml if | `entity_id` | yes | Only act on a specific remote, else target all. | `activity` | yes | Activity ID or Activity Name to start. +##### {% linkable_title Example %} + +In the file 'harmony_REMOTENAME.conf' you can find the available activities, for example: + +```text +Activities + 22054907 - Watch TV +``` + +Using the activity name 'Watch TV', you can call a service via automation to switch this activity on: + +```yaml +action: + - service: remote.turn_on + entity_id: remote.bed_room_hub + data: + activity: "Watch TV" +``` + ### {% linkable_title Service `remote.send_command` %} Send a single command or a set of commands to one device, device ID and available commands are written to the configuration file at startup. You can optionally specify the number of times you wish to repeat the command(s) and delay you want between repeated command(s). diff --git a/source/_components/remote.xiaomi_miio.markdown b/source/_components/remote.xiaomi_miio.markdown index 8284a738688..4d018dd3752 100644 --- a/source/_components/remote.xiaomi_miio.markdown +++ b/source/_components/remote.xiaomi_miio.markdown @@ -43,12 +43,12 @@ name: slot: description: The slot used to save learned command. required: false - type: int + type: integer default: 1 timeout: description: Timeout for learning a new command. required: false - type: int + type: integer default: 30 hidden: description: Hide the entity from UI. There is currently no reason to show the entity in UI as turning it off or on does nothing. diff --git a/source/_components/rflink.markdown b/source/_components/rflink.markdown index 208301d229b..81b696fae33 100644 --- a/source/_components/rflink.markdown +++ b/source/_components/rflink.markdown @@ -94,14 +94,15 @@ When pressing the button on the physical remote, RFLink detects the signal and t light: - platform: rflink automatic_add: true -switch: - - platform: rflink - automatic_add: true sensor: - platform: rflink automatic_add: true ``` +[RFLink Switches](https://www.home-assistant.io/components/switch.rflink/) cannot be added automatically. + +The RFLink component does not know the difference between a switch and a light. Therefore all switchable devices are automatically added as light by default. However, once the ID of a switch is known, it can be used to configure it as a switch type in HA, for example, to add it to a different group, hide it or configure a nice name. + ### {% linkable_title Ignoring devices %} The RFLink platform can be configured to completely ignore a device on a platform level. This is useful when you have neighbors which also use 433 MHz technology. diff --git a/source/_components/rss_feed_template.markdown b/source/_components/rss_feed_template.markdown index d5ac1313672..36fcddfc51f 100644 --- a/source/_components/rss_feed_template.markdown +++ b/source/_components/rss_feed_template.markdown @@ -20,7 +20,7 @@ For example, on Android, the app "Simple RSS Widget" can be used to display temp ```yaml # Example configuration.yaml entry rss_feed_template: - # Accessible on+ You can't use this sensor in a Container (like Hass.io) as it requires access to the physical CPU. Also, not all [ARM CPUs](https://github.com/workhorsy/py-cpuinfo/#cpu-support) are supported. +
+ +## {% linkable_title Configuration %} + To add this platform to your installation, add the following to your `configuration.yaml` file: ```yaml @@ -24,6 +31,10 @@ sensor: - platform: cpuspeed ``` -Configuration variables: - -- **name** (*Optional*): Name of the sensor. +{% configuration %} +name: + description: Name to use in the frontend. + required: false + type: string + default: CPU speed +{% endconfiguration %} diff --git a/source/_components/sensor.cups.markdown b/source/_components/sensor.cups.markdown index 2e32f5aa0f9..86966e192b6 100644 --- a/source/_components/sensor.cups.markdown +++ b/source/_components/sensor.cups.markdown @@ -46,7 +46,7 @@ host: port: description: Port of the CUPS print server. required: false - type: int + type: integer default: 631 {% endconfiguration %} diff --git a/source/_components/sensor.file.markdown b/source/_components/sensor.file.markdown index 627e7f28ff2..3e8ea059e98 100644 --- a/source/_components/sensor.file.markdown +++ b/source/_components/sensor.file.markdown @@ -36,7 +36,7 @@ Configuration variables: ## {% linkable_title Examples %} -In this section you find some real life examples of how to use this sensor. +In this section you find some real-life examples of how to use this sensor. ### {% linkable_title Entries as JSON %} diff --git a/source/_components/sensor.filter.markdown b/source/_components/sensor.filter.markdown index a0a07337a70..98f13fb6733 100644 --- a/source/_components/sensor.filter.markdown +++ b/source/_components/sensor.filter.markdown @@ -11,6 +11,7 @@ ha_category: Utility ha_release: 0.65 ha_iot_class: "Local Push" logo: home-assistant.png +ha_qa_scale: internal --- The `filter` platform enables sensors that process the states of other entities. @@ -80,12 +81,12 @@ filters: precision: description: See [_lowpass_](#low-pass) filter. Defines the precision of the filtered state, through the argument of round(). required: false - type: int + type: integer default: None time_constant: description: See [_lowpass_](#low-pass) filter. Loosely relates to the amount of time it takes for a state to influence the output. required: false - type: int + type: integer default: 10 radius: description: See [_outlier_](#outlier) filter. Band radius from median of previous states. diff --git a/source/_components/sensor.gearbest.markdown b/source/_components/sensor.gearbest.markdown index 31803acb752..069d942e84b 100644 --- a/source/_components/sensor.gearbest.markdown +++ b/source/_components/sensor.gearbest.markdown @@ -40,7 +40,7 @@ items: id: description: The ID of the product. required: false - type: int + type: integer url: description: The URL of the product. required: false diff --git a/source/_components/sensor.glances.markdown b/source/_components/sensor.glances.markdown index 6750e177b99..e9321628a61 100644 --- a/source/_components/sensor.glances.markdown +++ b/source/_components/sensor.glances.markdown @@ -59,7 +59,7 @@ host: port: description: The port where Glances is listening. required: false - type: int + type: integer default: 61208 name: description: The prefix for the sensors. @@ -69,7 +69,7 @@ name: version: description: "The version of the Glances API. Supported version: `2` and `3`." required: false - type: int + type: integer default: 2 resources: description: Entries to monitor. diff --git a/source/_components/sensor.gpsd.markdown b/source/_components/sensor.gpsd.markdown index d66cc20110f..857a0d1c95e 100644 --- a/source/_components/sensor.gpsd.markdown +++ b/source/_components/sensor.gpsd.markdown @@ -61,7 +61,7 @@ host: port: description: The port which GPSD is using. required: false - type: int + type: integer default: 2947 name: description: Friendly name to use for the frontend. diff --git a/source/_components/sensor.history_stats.markdown b/source/_components/sensor.history_stats.markdown index d324bc26b52..8a9c76b7ebb 100644 --- a/source/_components/sensor.history_stats.markdown +++ b/source/_components/sensor.history_stats.markdown @@ -11,6 +11,7 @@ logo: home-assistant.png ha_category: Utility ha_iot_class: "Local Polling" ha_release: 0.39 +ha_qa_scale: internal --- The `history_stats` sensor platform provides quick statistics about another component or platforms, using data from the [history](/components/history/). diff --git a/source/_components/sensor.ihc.markdown b/source/_components/sensor.ihc.markdown index b3e91ed9823..6e2c2885fb4 100644 --- a/source/_components/sensor.ihc.markdown +++ b/source/_components/sensor.ihc.markdown @@ -13,13 +13,15 @@ ha_release: 0.62 ha_iot_class: "Local Push" --- -Before you can use the IHC Sensor platform, you must setup the [IHC Component](/components/ihc/) +Before you can use the IHC Sensor platform, you must setup the +[IHC Component](/components/ihc/) -When auto setup is enabled the following products will be found in the IHC project and setup as sensors: +When auto setup is enabled the following products will be found in the IHC +project and setup as sensors: -* Dataline temperature sensor - Will insert 2 temperature sensors -* Dataline Humidity - Will insert 1 humidity and 2 temperature sensors (calculated dewpoint) -* Dataline Lux - will insert 1 light and 1 temperature sensor +- Dataline temperature sensor - Will insert 2 temperature sensors +- Dataline Humidity - Will insert 1 humidity and 2 temperature sensors (calculated dewpoint) +- Dataline Lux - will insert 1 light and 1 temperature sensor To manually configure IHC sensors insert this section: @@ -43,7 +45,7 @@ sensors: id: description: The IHC resource id. required: true - type: int + type: integer name: description: The name of the component required: false @@ -54,6 +56,5 @@ sensors: type: string {% endconfiguration %} -The resource id should be a IHC float resource. -For more information about IHC resource ids see [Manual Setup](/components/ihc/#manual-setup) - +The resource id should be a IHC float resource. For more information about IHC +resource ids see [Manual Setup](/components/ihc/#manual-setup). diff --git a/source/_components/sensor.iota.markdown b/source/_components/sensor.iota.markdown index e907cb2795f..365796a68d6 100644 --- a/source/_components/sensor.iota.markdown +++ b/source/_components/sensor.iota.markdown @@ -13,10 +13,10 @@ ha_release: 0.62 ha_iot_class: "Cloud Polling" --- -The sensors are automatically created if the [IOTA hub](/components/iota/) is present. +The sensors are automatically created if the [IOTA hub](/components/iota/) is +present. Available sensors: - Wallet balance - Node information - diff --git a/source/_components/sensor.iperf3.markdown b/source/_components/sensor.iperf3.markdown index 0cb7cb2dabe..068a9b879ad 100644 --- a/source/_components/sensor.iperf3.markdown +++ b/source/_components/sensor.iperf3.markdown @@ -52,11 +52,11 @@ sensor: description: Specify the test duration in seconds. Default is 10 and the valid range is from 5 to 10. required: false default: 10 - type: int + type: integer parallel: description: Specify the number of concurrent streams to connect to the server. Default is 1 and the valid range is from 1 to 20. default: 1 - type: int + type: integer protocol: description: Specify the protocol to be used on the test. Default is TCP and the valid values are TCP or UDP. If your Iperf3 server is located in the Internet, consider to use TCP instead of UDP. If the protocol is set to use UDP, the sensor may not get updated due to package retransmission issues due to its nature. required: false @@ -66,7 +66,7 @@ sensor: description: Specify the frequency in seconds which the test will be perfomed. Default value is 1 hour. required: false default: 3600 - type: int + type: integer {% endconfiguration %} You can find a list of public Iperf3 servers [here](https://iperf.fr/iperf-servers.php). You can also start your own Iperf3 server using the [mlabbe/iperf3's](https://hub.docker.com/r/mlabbe/iperf3/) docker image or just refer to your `iperf3` command's man page. diff --git a/source/_components/sensor.jewish_calendar.markdown b/source/_components/sensor.jewish_calendar.markdown index 42a4c53ad8b..53002877895 100644 --- a/source/_components/sensor.jewish_calendar.markdown +++ b/source/_components/sensor.jewish_calendar.markdown @@ -34,13 +34,13 @@ latitude: required: false description: Latitude for time calculations of the sensor. default: Home Assistant location - type: int + type: integer longitude: required: false description: Longitude for time calculations of the sensor. default: Home Assistant location - type: int -disapora: + type: integer +diaspora: required: false description: Consider the location as diaspora or not for calculation of the weekly portion and holidays. default: False @@ -89,7 +89,7 @@ sensors: sensor: - platform: jewish_calendar language: english - disapora: True + diaspora: True sensors: - date - weekly_portion diff --git a/source/_components/sensor.knx.markdown b/source/_components/sensor.knx.markdown index 6e0921c341a..3819a6dfdfd 100644 --- a/source/_components/sensor.knx.markdown +++ b/source/_components/sensor.knx.markdown @@ -33,7 +33,42 @@ sensor: - **address** (*Required*): KNX group address of the sensor. - **name** (*Optional*): A name for this device used within Home Assistant. -- **type** (*Optional*): "percent", "temperature", "humidity", "illuminance", "brightness", "speed_ms", "current", "power", "electric_current", "electric_potential", "energy", "frequency", "heatflowrate", "phaseanglerad", "phaseangledeg", "powerfactor" or "speed". +- **type** (*Optional*): A type from the following table can be defined. The DPT of the group address should match the expected KNX DPT to be parsed correctly. + +| type | unit | expected KNX DPT | +|--------------------|------|------------------| +| percent | % | 5.001 | +| pulse | | 5.010 | +| temperature | °C | 9.001 | +| humidity | % | 9.007 | +| illuminance | lx | 9.004 | +| brightness | lx | 7.013 | +| speed_ms | m/s | 9.005 | +| current | mA | 7.012 | +| voltage | mV | 9.020 | +| power | W | 14.056 | +| electric_current | A | 14.019 | +| electric_potential | V | 14.027 | +| energy | J | 14.031 | +| frequency | Hz | 14.033 | +| heatflowrate | W | 14.036 | +| phaseanglerad | rad | 14.054 | +| phaseangledeg | ° | 14.055 | +| powerfactor | | 14.057 | +| speed | m/s | 14.065 | +| enthalpy | H | 9.* | +| ppm | ppm | 9.008 | +| DPT-7 | | 7.* | +| 2byte_unsigned | | 7.* | +| DPT-9 | | 9.* | +| DPT-12 | | 12.* | +| 4byte_unsigned | | 12.* | +| DPT-13 | | 13.* | +| 4byte_signed | | 13.* | +| DPT-14 | | 14.* | +| 4byte_float | | 14.* | + + ## {% linkable_title Full example %} diff --git a/source/_components/sensor.lacrosse.markdown b/source/_components/sensor.lacrosse.markdown index b634ccbcd37..3d69b6c39ed 100644 --- a/source/_components/sensor.lacrosse.markdown +++ b/source/_components/sensor.lacrosse.markdown @@ -51,7 +51,7 @@ sensor: baud: description: The serial baudrate. required: true - type: int + type: integer default: 57600 led: description: Activate or deactivate the Jeelink LED. @@ -60,19 +60,19 @@ sensor: frequency: description: Initial frequency in 5kHz steps. required: false - type: int + type: integer datarate: description: "Set the data rate in kbps. Special values for well-known settings are: `0`: 17.241 kbps, `1`: 9.579 kbps, `2`: 8.842 kbps." required: false - type: int + type: integer toggle_mask: description: "The following values can be combined bitwise: `1` = 17.241 kbps, `2` = 9.579 kbps, `4` = 8.842 kbps" required: false - type: int + type: integer toggle_interval: description: Enable the toggle mode and set the interval in seconds. required: false - type: int + type: integer sensors: description: A list of your sensors. required: true @@ -89,7 +89,7 @@ sensor: id: description: The LaCrosse Id of the sensor. required: true - type: int + type: integer {% endconfiguration %} diff --git a/source/_components/sensor.min_max.markdown b/source/_components/sensor.min_max.markdown index 4606862da2d..be649657ae8 100644 --- a/source/_components/sensor.min_max.markdown +++ b/source/_components/sensor.min_max.markdown @@ -11,6 +11,7 @@ logo: home-assistant.png ha_category: Utility ha_iot_class: "Local Polling" ha_release: "0.31" +ha_qa_scale: internal --- diff --git a/source/_components/sensor.modbus.markdown b/source/_components/sensor.modbus.markdown index 5868888488e..d9681e8f678 100644 --- a/source/_components/sensor.modbus.markdown +++ b/source/_components/sensor.modbus.markdown @@ -81,5 +81,5 @@ sensor: scale: 0.1 offset: 0 precision: 1 - data_type: int + data_type: integer ``` diff --git a/source/_components/sensor.mold_indicator.markdown b/source/_components/sensor.mold_indicator.markdown index e2d870f7924..f4f86197cc8 100644 --- a/source/_components/sensor.mold_indicator.markdown +++ b/source/_components/sensor.mold_indicator.markdown @@ -9,8 +9,9 @@ sharing: true footer: true logo: home-assistant.png ha_category: Environment -ha_release: '0.20' +ha_release: "0.20" ha_iot_class: "Local Polling" +ha_qa_scale: internal --- 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. diff --git a/source/_components/sensor.moon.markdown b/source/_components/sensor.moon.markdown index 6a292040da2..5e7aadde293 100644 --- a/source/_components/sensor.moon.markdown +++ b/source/_components/sensor.moon.markdown @@ -11,6 +11,7 @@ logo: home-assistant.png ha_category: Environment ha_iot_class: "Local Polling" ha_release: 0.38 +ha_qa_scale: internal --- diff --git a/source/_components/sensor.mqtt.markdown b/source/_components/sensor.mqtt.markdown index 0b44200064a..8b8a0fc07b6 100644 --- a/source/_components/sensor.mqtt.markdown +++ b/source/_components/sensor.mqtt.markdown @@ -40,20 +40,20 @@ name: qos: description: The maximum QoS level of the state topic. required: false - type: int + type: integer default: 0 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`). + description: Icon for the sensor. required: false - type: string + type: icon expire_after: description: Defines the number of seconds after the value expires if it's not updated. required: false - type: int + type: integer default: 0 value_template: description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract the value." @@ -95,7 +95,7 @@ device_class: ## {% linkable_title Examples %} -In this section you find some real life examples of how to use this sensor. +In this section you find some real-life examples of how to use this sensor. ### {% linkable_title JSON attributes configuration %} diff --git a/source/_components/sensor.nest.markdown b/source/_components/sensor.nest.markdown index f31f62b9b3e..99d40e63016 100644 --- a/source/_components/sensor.nest.markdown +++ b/source/_components/sensor.nest.markdown @@ -59,9 +59,9 @@ The following conditions are available by device: ## {% linkable_title Security State %}-This feature is not designed to transfer your Home Assitant to a security system, neither Home Assistant nor Nest be liable to You for damages, +This feature is not designed to transfer your Home Assistant to a security system, neither Home Assistant nor Nest be liable to You for damages, or consequential damages of any character arising as a result of use this feature. - + This feature does not depend on the [Nest Secure alarm system](https://nest.com/alarm-system/overview/) and is not a reflection of the status of that system, nor does it react to state changes in that system.
diff --git a/source/_components/sensor.netdata.markdown b/source/_components/sensor.netdata.markdown index 0a1a4df622d..d758364265d 100644 --- a/source/_components/sensor.netdata.markdown +++ b/source/_components/sensor.netdata.markdown @@ -68,7 +68,7 @@ host: port: description: The port that the Netdata instance is running on. required: false - type: int + type: integer default: 19999 name: description: Name of the monitored Netdata instance. @@ -96,7 +96,7 @@ resources: icon: description: Icon to use for the sensor. required: false - type: string + type: icon default: "mdi:desktop-classic" {% endconfiguration %} diff --git a/source/_components/sensor.nut.markdown b/source/_components/sensor.nut.markdown index 744002c0f08..fc39be6e0f0 100644 --- a/source/_components/sensor.nut.markdown +++ b/source/_components/sensor.nut.markdown @@ -43,7 +43,7 @@ sensor: description: The port number. required: false default: 3493 - type: int + type: integer alias: description: Name of the ups on the NUT server. required: false diff --git a/source/_components/sensor.openhardwaremonitor.markdown b/source/_components/sensor.openhardwaremonitor.markdown index 6479aa9c9d8..3968a2f0866 100644 --- a/source/_components/sensor.openhardwaremonitor.markdown +++ b/source/_components/sensor.openhardwaremonitor.markdown @@ -33,7 +33,7 @@ sensor: port: description: The port of your Open Hardware Monitor API. Defaults to 8085. required: false - type: int + type: integer {% endconfiguration %}
diff --git a/source/_components/sensor.opensky.markdown b/source/_components/sensor.opensky.markdown
index 39bbb600b4b..f1e13674e70 100644
--- a/source/_components/sensor.opensky.markdown
+++ b/source/_components/sensor.opensky.markdown
@@ -39,7 +39,7 @@ Configuration options for the OpenSky Network sensor:
- **opensky_entry**: Fired when a flight enters the region.
- **opensky_exit**: Fired when a flight exits the region.
-Both events have two attributes:
+Both events have three attributes:
- **sensor**: Name of `opensky` sensor that fired the event.
- **callsign**: Callsign of the flight.
diff --git a/source/_components/sensor.otp.markdown b/source/_components/sensor.otp.markdown
index 3f0cd12d337..2364e986398 100644
--- a/source/_components/sensor.otp.markdown
+++ b/source/_components/sensor.otp.markdown
@@ -11,6 +11,7 @@ logo: home-assistant.png
ha_category: Utility
ha_iot_class: "Local Polling"
ha_release: 0.49
+ha_qa_scale: internal
---
The `otp` sensor generates One-Time Passwords according to [RFC6238](https://tools.ietf.org/html/rfc6238) that is compatible with most OTP generators available, including Google Authenticator. You can use this when building custom security solutions and want to use "rolling codes", that change every 30 seconds.
diff --git a/source/_components/sensor.pyload.markdown b/source/_components/sensor.pyload.markdown
index 4bfd7edf02f..221be40d59c 100644
--- a/source/_components/sensor.pyload.markdown
+++ b/source/_components/sensor.pyload.markdown
@@ -32,7 +32,7 @@ host:
port:
description: The port your pyLoad interface uses.
required: false
- type: int
+ type: integer
default: 8000
name:
description: The name to use when displaying this pyLoad instance.
diff --git a/source/_components/sensor.radarr.markdown b/source/_components/sensor.radarr.markdown
index 0ec88883e51..11635a8d18d 100644
--- a/source/_components/sensor.radarr.markdown
+++ b/source/_components/sensor.radarr.markdown
@@ -45,7 +45,7 @@ Configuration variables:
## {% linkable_title Examples %}
-In this section you find some real life examples of how to use this sensor.
+In this section you find some real-life examples of how to use this sensor.
### {% linkable_title Get Episodes airing in next 2 days %}
diff --git a/source/_components/sensor.random.markdown b/source/_components/sensor.random.markdown
index e3515333eab..91787f6777f 100644
--- a/source/_components/sensor.random.markdown
+++ b/source/_components/sensor.random.markdown
@@ -11,6 +11,7 @@ logo: home-assistant.png
ha_category: Utility
ha_iot_class: "Local Polling"
ha_release: 0.32
+ha_qa_scale: internal
---
@@ -40,7 +41,7 @@ minimum:
maximum:
description: Upper limit for the values.
required: false
- type: int
+ type: integer
default: 20
unit_of_measurement:
description: Defines the units of measurement of the sensor, if any.
@@ -48,6 +49,3 @@ unit_of_measurement:
type: string
{% endconfiguration %}
-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]: /docs/configuration/platform_options/
diff --git a/source/_components/sensor.rest.markdown b/source/_components/sensor.rest.markdown
index d9594344e8b..7e756ce6a3d 100644
--- a/source/_components/sensor.rest.markdown
+++ b/source/_components/sensor.rest.markdown
@@ -109,7 +109,7 @@ $ curl -X GET http://192.168.1.31/temperature/
## {% linkable_title Examples %}
-In this section you find some real life examples of how to use this sensor.
+In this section you find some real-life examples of how to use this sensor.
### {% linkable_title External IP address %}
diff --git a/source/_components/sensor.rmvtransport.markdown b/source/_components/sensor.rmvtransport.markdown
index e6584282bda..6c4cea8129b 100644
--- a/source/_components/sensor.rmvtransport.markdown
+++ b/source/_components/sensor.rmvtransport.markdown
@@ -55,7 +55,7 @@ time_offset:
description: Do not display departures leaving sooner than this number of minutes. Useful if you are a couple of minutes away from the stop.
required: false
default: The defaults is 0.
- type: int
+ type: integer
max_journeys:
description: Specify the maximal number of journeys.
required: false
diff --git a/source/_components/sensor.scrape.markdown b/source/_components/sensor.scrape.markdown
index 47019c97a23..b6da7d08d77 100644
--- a/source/_components/sensor.scrape.markdown
+++ b/source/_components/sensor.scrape.markdown
@@ -40,7 +40,7 @@ Configuration variables:
## {% linkable_title Examples %}
-In this section you find some real life examples of how to use this sensor. There is also a [Jupyter notebook](http://nbviewer.jupyter.org/github/home-assistant/home-assistant-notebooks/blob/master/web-scraping.ipynb) available for this example to give you a bit more insight.
+In this section you find some real-life examples of how to use this sensor. There is also a [Jupyter notebook](http://nbviewer.jupyter.org/github/home-assistant/home-assistant-notebooks/blob/master/web-scraping.ipynb) available for this example to give you a bit more insight.
### {% linkable_title Home Assistant %}
diff --git a/source/_components/sensor.season.markdown b/source/_components/sensor.season.markdown
index 9e2ecc39c74..c2ce54a145c 100644
--- a/source/_components/sensor.season.markdown
+++ b/source/_components/sensor.season.markdown
@@ -11,6 +11,7 @@ ha_category: Utility
logo: home-assistant.png
ha_iot_class: "Local Polling"
ha_release: 0.53
+ha_qa_scale: internal
---
The `season` sensor will display the current astronomical or meteorological season (Spring, Summer, Autumn, Winter) based on the user's setting in the configuration file.
diff --git a/source/_components/sensor.sensehat.markdown b/source/_components/sensor.sensehat.markdown
index a2236c2fb5f..cc0a9da56d2 100644
--- a/source/_components/sensor.sensehat.markdown
+++ b/source/_components/sensor.sensehat.markdown
@@ -42,8 +42,9 @@ Configuration variables:
#### Customizing the Sense HAT data
**Format the sensor values**
-Add the following to your `sensor`
+Add the following to your `sensor`:
+{% raw %}
```yaml
# Example configuration.yaml entry
sensor:
@@ -56,18 +57,19 @@ sensor:
- platform: template
sensors:
sensehat_temperature:
- value_template: '{% raw %}{{ states.sensor.temperature.state | round(1) }}{% endraw %}'
+ value_template: '{{ states.sensor.temperature.state | round(1) }}'
unit_of_measurement: '°C'
sensehat_pressure:
- value_template: '{% raw %}{{ states.sensor.pressure.state | round(1) }}{% endraw %}'
+ value_template: '{{ states.sensor.pressure.state | round(1) }}'
unit_of_measurement: 'mb'
sensehat_humidity:
- value_template: '{% raw %}{{ states.sensor.humidity.state | round(1) }}{% endraw %}'
+ value_template: '{{ states.sensor.humidity.state | round(1) }}'
unit_of_measurement: '%'
```
+{% endraw %}
**Give the values friendly names & icons**
-Add the following to your `customize`
+Add the following to your `customize`:
```yaml
# Example configuration.yaml entry
@@ -84,7 +86,7 @@ customize:
```
**Create a group**
-Add the following to your `groups`
+Add the following to your `groups`:
```yaml
# Example configuration.yaml entry
@@ -106,9 +108,11 @@ group:
### Directions for installing on Raspberry Pi All-In-One installer and HASSbian:
+
Here are the steps to make the _SenseHAT_ sensor work _successfully_ with the virtual environment versions.
#### Install SenseHAT package to _homeassistant_venv_
+
```bash
# switch to the homeassistant_venv environment
sudo -u homeassistant -H -s
@@ -118,7 +122,9 @@ source /srv/homeassistant/homeassistant_venv/bin/activate
pip3 install sense-hat
# be patient, this will take a long while
```
+
#### Return to `pi`
+
Type `exit` to quit out of the _homeassistant_venv_ back to your `pi` environment.
As all of the following steps should be under the `pi` user environment.
@@ -141,8 +147,8 @@ ln -s /usr/lib/python3/dist-packages/RTIMU.cpython-35m-arm-linux-gnueabihf.so /s
sudo reboot
```
-Unfortunately enabling the SenseHAT Sensor component for a Virtual Environment install of Home-Assistant fails with errors.
-_(The Raspberry Pi All-In-One installer and HASSbian both run Home-Assistant in an virtual environment)._
+Unfortunately enabling the SenseHAT Sensor component for a Virtual Environment install of Home Assistant fails with errors.
+_(The Raspberry Pi All-In-One installer and HASSbian both run Home Assistant in an virtual environment)._
These issues have been discussed in the repository issue (#5093)[https://github.com/home-assistant/home-assistant/issues/5093)
This fix has been tested with a clean install of:
@@ -151,6 +157,6 @@ This fix has been tested with a clean install of:
and
-* [Home-Assistant 0.37.1](/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 356ced350f5..4954fb15fc6 100644
--- a/source/_components/sensor.serial.markdown
+++ b/source/_components/sensor.serial.markdown
@@ -43,7 +43,7 @@ baudrate:
description: Baudrate of the serial port.
required: false
default: 9600 Bps
- type: int
+ type: integer
value_template:
description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract a value from the serial line."
required: false
diff --git a/source/_components/sensor.serial_pm.markdown b/source/_components/sensor.serial_pm.markdown
index 454bb3bdb9f..5d579cc9a9b 100644
--- a/source/_components/sensor.serial_pm.markdown
+++ b/source/_components/sensor.serial_pm.markdown
@@ -17,6 +17,8 @@ Particulate matter sensors measure the amount of very small particles in the air
Cheap LED based sensors usually use a GPIO interface that is hard to attach to computers. However, there are a lot of laser LED based sensors on the market that use a serial interface and can be [connected to your Home Assistant system easily with an USB to serial converter](https://www.open-homeautomation.com/2016/07/20/connecting-an-particulate-matter-sensor-to-your-pc-or-mac/).
+## {% linkable_title Supported Sensors %}
+
At this time, the following sensors are supported:
* oneair,s3
@@ -28,8 +30,34 @@ At this time, the following sensors are supported:
* plantower,pms2003
* plantower,pms3003
+## {% linkable_title Configuration %}
+
To use your PM sensor in your installation, add the following to your `configuration.yaml` file:
+```yaml
+sensor:
+ - platform: serial_pm
+ serial_device: /dev/tty.SLAB_USBtoUART
+ brand: oneair,s3
+```
+
+{% configuration %}
+serial_device:
+ description: The serial port to use. On *nix systems, it can often be identified by `$ ls /dev/tty*`
+ required: true
+ type: string
+name:
+ description: The name displayed in the frontend.
+ required: false
+ type: string
+brand:
+ description: Manufacturer and type of the sensor. (Use a value from the supported sensors list.).
+ required: true
+ type: string
+{% endconfiguration %}
+
+### {% linkable_title Named Sensor Configuration Example %}
+
```yaml
sensor:
- platform: serial_pm
@@ -38,7 +66,3 @@ sensor:
brand: novafitness,sds011
```
-- **serial_device** (*Required*): The serial port to use. On *nix systems, it can often be identified by `$ ls /dev/tty*`
-- **name** (*Optional*): The name displayed in the frontend.
-- **brand** (*Required*): Manufacturer and type of the sensor.
-
diff --git a/source/_components/sensor.sht31.markdown b/source/_components/sensor.sht31.markdown
index 7adbfc2ceea..f1a46c17810 100644
--- a/source/_components/sensor.sht31.markdown
+++ b/source/_components/sensor.sht31.markdown
@@ -40,7 +40,7 @@ sensor:
description: I2C address of the sensor.
required: false
default: "`0x44`"
- type: int
+ type: integer
monitored_conditions:
description: Conditions to monitor.
required: false
diff --git a/source/_components/sensor.simulated.markdown b/source/_components/sensor.simulated.markdown
index ef4d98bd73d..b54ecd4234d 100644
--- a/source/_components/sensor.simulated.markdown
+++ b/source/_components/sensor.simulated.markdown
@@ -11,6 +11,7 @@ logo: home-assistant.png
ha_category: Utility
ha_iot_class: "Local Polling"
ha_release: 0.65
+ha_qa_scale: internal
---
The `simulated` sensor platform provides a simulated sensor that generates a time-varying signal `V(t)` given by the [function](https://en.wikipedia.org/wiki/Sine_wave):
@@ -75,7 +76,7 @@ seed:
description: The [seed](https://docs.python.org/3.6/library/random.html#random.seed) value for the random noise component.
required: false
default: 999
- type: int
+ type: integer
spread:
description: The spread is the range of the randomly distributed values about their mean. This is sometimes referred to as the Full Width at Half Maximum ([FWHM](https://en.wikipedia.org/wiki/Full_width_at_half_maximum)) of the random distribution.
required: false
diff --git a/source/_components/sensor.sonarr.markdown b/source/_components/sensor.sonarr.markdown
index 837dde42b1d..b752a2a702d 100644
--- a/source/_components/sensor.sonarr.markdown
+++ b/source/_components/sensor.sonarr.markdown
@@ -48,7 +48,7 @@ Configuration variables:
## {% linkable_title Examples %}
-In this section you find some real life examples of how to use this sensor.
+In this section you find some real-life examples of how to use this sensor.
### {% linkable_title Get Episodes airing in next 2 days %}
diff --git a/source/_components/sensor.speedtest.markdown b/source/_components/sensor.speedtest.markdown
index fb95a0cdff2..bae1f1f576e 100644
--- a/source/_components/sensor.speedtest.markdown
+++ b/source/_components/sensor.speedtest.markdown
@@ -14,13 +14,18 @@ ha_release: 0.13
ha_iot_class: "Cloud Polling"
---
-The `speedtest` sensor component uses the [Speedtest.net](https://speedtest.net/) web service to measure network bandwidth performance.
+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).
+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:
+To add a Speedtest.net sensor to your installation,
+add the following to your `configuration.yaml` file:
Once per hour, on the hour (default):
@@ -49,7 +54,7 @@ sensor:
server_id:
description: Specify the speed test server to perform the test against.
required: false
- type: int
+ type: integer
day:
description: Specify the day(s) of the month to schedule the speed test. Use a list for multiple entries.
required: false
@@ -69,15 +74,24 @@ sensor:
type: [int, list]
default: 0
manual:
- description: True or False to turn manual mode on or off. Manual mode will disable scheduled speed tests.
+ description: >
+ `true` or `false` to turn manual mode on or off.
+ Manual mode will disable scheduled speed tests.
required: false
- type: bool
+ type: boolean
default: false
{% endconfiguration %}
-This component uses [speedtest-cli](https://github.com/sivel/speedtest-cli) to gather network performance data from Speedtest.net. Please be aware of the potential [inconsistencies](https://github.com/sivel/speedtest-cli#inconsistency) that this component may display.
+This component uses [speedtest-cli](https://github.com/sivel/speedtest-cli) to
+gather network performance data from Speedtest.net.
+Please be aware of the potential
+[inconsistencies](https://github.com/sivel/speedtest-cli#inconsistency) that
+this component may display.
-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.
+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 %}
diff --git a/source/_components/sensor.spotcrime.markdown b/source/_components/sensor.spotcrime.markdown
index 73bda02a894..166a2d5877a 100644
--- a/source/_components/sensor.spotcrime.markdown
+++ b/source/_components/sensor.spotcrime.markdown
@@ -46,7 +46,7 @@ api_key:
days:
description: Number of days you'd like see to crime statistics for.
required: false
- type: int
+ type: integer
include:
description: Event types you want statistics for.
required: false
diff --git a/source/_components/sensor.sql.markdown b/source/_components/sensor.sql.markdown
index 248b3caa8c0..612df43f726 100644
--- a/source/_components/sensor.sql.markdown
+++ b/source/_components/sensor.sql.markdown
@@ -68,7 +68,7 @@ queries:
## {% linkable_title Examples %}
-In this section you find some real life examples of how to use this sensor.
+In this section you find some real-life examples of how to use this sensor.
### {% linkable_title Current state of an entity %}
diff --git a/source/_components/sensor.statistics.markdown b/source/_components/sensor.statistics.markdown
index d28f73eabee..509e7f8db3c 100644
--- a/source/_components/sensor.statistics.markdown
+++ b/source/_components/sensor.statistics.markdown
@@ -11,6 +11,7 @@ logo: home-assistant.png
ha_category: Utility
ha_iot_class: "Local Polling"
ha_release: "0.30"
+ha_qa_scale: internal
---
diff --git a/source/_components/sensor.systemmonitor.markdown b/source/_components/sensor.systemmonitor.markdown
index 8f4ee938fea..10da7021396 100644
--- a/source/_components/sensor.systemmonitor.markdown
+++ b/source/_components/sensor.systemmonitor.markdown
@@ -13,9 +13,12 @@ ha_release: pre 0.7
ha_iot_class: "Local Push"
---
-The `systemmonitor` sensor platform allows you to monitor disk usage, memory usage, CPU usage, and running processes. This platform has superseded the process component which is now considered deprecated.
+The `systemmonitor` sensor platform allows you to monitor disk usage,
+memory usage, CPU usage, and running processes. This platform has superseded the
+process component which is now considered deprecated.
-To add this platform to your installation, add the following to your `configuration.yaml` file:
+To add this platform to your installation,
+add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
@@ -27,13 +30,22 @@ sensor:
- type: memory_free
```
-Configuration variables:
+{% configuration %}
+resources:
+ description: Contains all entries to display.
+ required: true
+ type: list
+ keys:
+ type:
+ description: The type of the information to display, please check the table below for details.
+ required: true
+ arg:
+ description: Argument to use, please check the table below for details.
+ required: false
+{% endconfiguration %}
-- **resources** array (*Required*): Contains all entries to display.
- - **type** (*Required*): The type of the information to display, please check the table below for details.
- - **arg** (*Optional*): Argument to use, please check the table below for details.
-
-The table contains types and their argument to use in your `configuration.yaml` file.
+The table contains types and their argument to use in your `configuration.yaml`
+file.
| Type (`type:`) | Argument (`arg:`) |
| :------------------ |:--------------------------|
@@ -62,7 +74,8 @@ The table contains types and their argument to use in your `configuration.yaml`
## {% linkable_title Linux specific %}
-To retrieve all available network interfaces on a Linux System, execute the `ifconfig` command.
+To retrieve all available network interfaces on a Linux System, execute the
+`ifconfig` command.
```bash
$ ifconfig -a | sed 's/[ \t].*//;/^$/d'
@@ -70,7 +83,9 @@ $ ifconfig -a | sed 's/[ \t].*//;/^$/d'
## {% linkable_title Windows specific %}
-When running this platform on Microsoft Windows, Typically, the default interface would be called `Local Area Connection`, so your configuration might look like:
+When running this platform on Microsoft Windows, Typically,
+the default interface would be called `Local Area Connection`,
+so your configuration might look like:
```yaml
sensor:
@@ -89,4 +104,4 @@ Wireless LAN adapter Wireless Network Connection:
Connection-specific DNS Suffix . :
```
-Where the name is `Wireless Network Connection`
+Where the name is `Wireless Network Connection`.
diff --git a/source/_components/sensor.tcp.markdown b/source/_components/sensor.tcp.markdown
index 1d27c668827..f3638d48bd8 100644
--- a/source/_components/sensor.tcp.markdown
+++ b/source/_components/sensor.tcp.markdown
@@ -39,7 +39,7 @@ Configuration options for the a TCP Sensor:
## {% linkable_title Examples %}
-In this section you find some real life examples of how to use this sensor.
+In this section you find some real-life examples of how to use this sensor.
### {% linkable_title EBUSd %}
diff --git a/source/_components/sensor.tellstick.markdown b/source/_components/sensor.tellstick.markdown
index c980118ed4e..d7f07a92d7b 100644
--- a/source/_components/sensor.tellstick.markdown
+++ b/source/_components/sensor.tellstick.markdown
@@ -33,7 +33,7 @@ Configuration variables:
## {% linkable_title Examples %}
-In this section you find some real life examples of how to use this sensor.
+In this section you find some real-life examples of how to use this sensor.
### {% linkable_title Full configuration %}
diff --git a/source/_components/sensor.temper.markdown b/source/_components/sensor.temper.markdown
index 65fd75fd725..c2452bdd1a2 100644
--- a/source/_components/sensor.temper.markdown
+++ b/source/_components/sensor.temper.markdown
@@ -28,12 +28,12 @@ sensor:
offset:
description: The offset to fix reported vales.
required: false
- type: int
+ type: integer
default: o
scale:
description: The scale for the sensor.
required: false
- type: int
+ type: integer
default: 1
name:
description: The name to use when displaying this switch.
diff --git a/source/_components/sensor.template.markdown b/source/_components/sensor.template.markdown
index e22d329efb0..c2942d023a0 100644
--- a/source/_components/sensor.template.markdown
+++ b/source/_components/sensor.template.markdown
@@ -11,6 +11,7 @@ ha_category: Sensor
ha_release: 0.12
ha_iot_class: "Local Push"
logo: home-assistant.png
+ha_qa_scale: internal
---
The `template` platform supports sensors which break out `state_attributes` from other entities.
@@ -83,7 +84,7 @@ If you are using the state of a platform that takes extra time to load, the Temp
## {% linkable_title Examples %}
-In this section you find some real life examples of how to use this sensor.
+In this section you find some real-life examples of how to use this sensor.
### {% linkable_title Sun Angle %}
diff --git a/source/_components/sensor.tibber.markdown b/source/_components/sensor.tibber.markdown
index 92dca29736f..5fb39f7999b 100644
--- a/source/_components/sensor.tibber.markdown
+++ b/source/_components/sensor.tibber.markdown
@@ -10,6 +10,7 @@ footer: true
logo: tibber.png
ha_category: Energy
ha_release: 0.55
+ha_qa_scale: silver
ha_iot_class: "Cloud Polling"
---
diff --git a/source/_components/sensor.time_date.markdown b/source/_components/sensor.time_date.markdown
index ce9547358eb..4a922a7e408 100644
--- a/source/_components/sensor.time_date.markdown
+++ b/source/_components/sensor.time_date.markdown
@@ -11,6 +11,7 @@ logo: home-assistant.png
ha_category: Calendar
ha_iot_class: "Local Push"
ha_release: pre 0.7
+ha_qa_scale: internal
---
diff --git a/source/_components/sensor.transmission.markdown b/source/_components/sensor.transmission.markdown
index 2fbbef26e8c..a1700cd591c 100644
--- a/source/_components/sensor.transmission.markdown
+++ b/source/_components/sensor.transmission.markdown
@@ -56,7 +56,7 @@ host:
port:
description: The port your Transmission daemon uses.
required: false
- type: int
+ type: integer
default: 9091
name:
description: The name to use when displaying this Transmission instance in the frontend.
diff --git a/source/_components/sensor.uptime.markdown b/source/_components/sensor.uptime.markdown
index 30f8cdadb29..c55011e0cff 100644
--- a/source/_components/sensor.uptime.markdown
+++ b/source/_components/sensor.uptime.markdown
@@ -11,6 +11,7 @@ ha_category: Utility
ha_iot_class: "Local Pushing"
logo: home-assistant.png
ha_release: 0.56
+ha_qa_scale: internal
---
diff --git a/source/_components/sensor.vasttrafik.markdown b/source/_components/sensor.vasttrafik.markdown
index 8f3862fdd84..76264932dec 100644
--- a/source/_components/sensor.vasttrafik.markdown
+++ b/source/_components/sensor.vasttrafik.markdown
@@ -23,22 +23,48 @@ Add the data to your `configuration.yaml` file as shown in the example:
# Example configuration.yaml entry
sensor:
- platform: vasttrafik
- key: XXXXXXXXXXXXXXXXXXX
- secret: YYYYYYYYYYYYYYYYY
+ key: YOUR_API_KEY
+ secret: YOUR_API_SECRET
departures:
- from: Musikvägen
```
-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 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.
+{% configuration %}
+key:
+ description: The API key to access your Västtrafik account.
+ required: true
+ type: string
+secret:
+ description: The API secret to access your Västtrafik account.
+ required: true
+ type: string
+departures:
+ description: List of travel routes.
+ required: true
+ type: list
+ keys:
+ name:
+ description: Name of the route.
+ required: false
+ type: string
+ from:
+ description: The start station.
+ required: true
+ type: string
+ heading:
+ description: Direction of the traveling.
+ required: false
+ type: string
+ lines:
+ description: Only consider these lines.
+ required: false
+ type: [list, string]
+ delay:
+ description: Delay in minutes.
+ required: false
+ type: string
+ default: 0
+{% endconfiguration %}
The data are coming from [Västtrafik](https://vasttrafik.se/).
@@ -48,8 +74,8 @@ A full configuration example could look like this:
# Example configuration.yaml entry
sensor:
- platform: vasttrafik
- key: XXXXXXXXXXXXXXXXXXX
- secret: YYYYYYYYYYYYYYYYY
+ key: YOUR_API_KEY
+ secret: YOUR_API_SECRET
departures:
- name: Mot järntorget
from: Musikvägen
diff --git a/source/_components/sensor.version.markdown b/source/_components/sensor.version.markdown
index dda7b220fab..92437ab87a8 100644
--- a/source/_components/sensor.version.markdown
+++ b/source/_components/sensor.version.markdown
@@ -11,9 +11,9 @@ ha_category: Utility
ha_iot_class: "Local Pushing"
logo: home-assistant.png
ha_release: 0.52
+ha_qa_scale: internal
---
-
The `version` sensor platform is displaying the current version of Home Assistant in the frontend.
## {% linkable_title Configuration %}
@@ -36,7 +36,9 @@ name:
## {% linkable_title Alternatives %}
-This sensor is an alternative to the existing solutions to achieve the same result through various platforms. Remember that you can easily get the installed version on the command line.
+This sensor is an alternative to the existing solutions to achieve the same
+result through various platforms.
+Remember that you can easily get the installed version on the command line.
```bash
$ hass --version
@@ -44,7 +46,8 @@ $ hass --version
Or go to the
diff --git a/source/_components/sun.markdown b/source/_components/sun.markdown
index 2b8cf1e3313..d56854b01b2 100644
--- a/source/_components/sun.markdown
+++ b/source/_components/sun.markdown
@@ -9,20 +9,24 @@ sharing: true
footer: true
logo: home-assistant.png
ha_category: Environment
+ha_qa_scale: internal
---
-The sun component will use your current location to track if the sun is above or below the horizon. The sun can be used within automation as [a trigger with an optional offset to simulate dawn/dusk][automation-trigger].
-
-[automation-trigger]: /getting-started/automation-trigger/#sun-trigger
+The sun component will use your current location to track if the sun is above or
+below the horizon. The sun can be used within automation as
+[a trigger with an optional offset to simulate dawn/dusk](/getting-started/automation-trigger/#sun-trigger).
```yaml
# Example configuration.yaml entry
sun:
```
-Configuration variables:
-
-- **elevation** (*Optional*): The (physical) elevation of your location, in meters above sea level. Defaults to the `elevation` in `configuration.yaml`, which is retrieved from Google Maps if not set.
+{% configuration %}
+elevation:
+ description: "The (physical) elevation of your location, in meters above sea level. Defaults to the `elevation` in `configuration.yaml`, which is retrieved from Google Maps if not set."
+ required: false
+ type: integer
+{% endconfiguration %}
-To get AVM Fritzbox switch follow the instructions for the general [Fritzbox](/components/fritzbox/).
-
- If you are using a Raspberry Pi, you must use PhantomJS.
+ If you are using a Raspberry Pi, you must use PhantomJS.
+
+ Hass.io containers are based on Alpine Linux. PhanthomJS is not available for Alpine Linux. Therefore it is currently not possible to use this component on Hass.io.
**Info** section of the **Developer Tools**.
-A [`command_line`](/components/sensor.command_line/) with [`hass`](/docs/tools/hass/) to display your current version.
+A [`command_line`](/components/sensor.command_line/) with
+[`hass`](/docs/tools/hass/) to display your current version.
```yaml
sensor:
@@ -53,7 +56,8 @@ sensor:
command: "/home/homeassistant/bin/hass --version"
```
-It's also possible to ready a file called `.HA_VERSION` which is located in your Home Assistant [configuration](/docs/configuration/) folder.
+It's also possible to ready a file called `.HA_VERSION` which is located in your
+Home Assistant [configuration](/docs/configuration/) folder.
```yaml
sensor:
@@ -62,7 +66,9 @@ sensor:
command: "cat /home/homeassistant/.homeassistant/.HA_VERSION"
```
-You might think that a [`rest` sensor](/components/sensor.rest/) could work, too, but it will not as Home Assistant is not ready when the sensor get initialized.
+You might think that a [`rest` sensor](/components/sensor.rest/) could work,
+too,
+but it will not as Home Assistant is not ready when the sensor get initialized.
{% raw %}
```yaml
diff --git a/source/_components/sensor.viaggiatreno.markdown b/source/_components/sensor.viaggiatreno.markdown
index d8ad4e16a00..e313e903b12 100644
--- a/source/_components/sensor.viaggiatreno.markdown
+++ b/source/_components/sensor.viaggiatreno.markdown
@@ -39,11 +39,11 @@ sensor:
train_id:
description: The ID of the train.
required: true
- type: int
+ type: integer
station_id:
description: The ID of the starting station.
required: true
- type: int
+ type: integer
train_name:
description: The name of the sensor. Defaults to 'Train 
@@ -30,9 +34,11 @@ Configuration variables:
### {% linkable_title Implementation Details %}
-The sun's event listener will call the service when the sun rises or sets with an offset.
+The sun's event listener will call the service when the sun rises or sets with
+an offset.
-The sun event need to have the type 'sun', which service to call, which event (sunset or sunrise) and the offset.
+The sun event need to have the type 'sun', which service to call,
+which event (sunset or sunrise) and the offset.
```json
{
@@ -50,8 +56,6 @@ The sun event need to have the type 'sun', which service to call, which event (s
| `above_horizon` | When the sun is above the horizon.
| `below_horizon` | When the sun is below the horizon.
-
-
| State Attributes | Description |
| --------- | ----------- |
| `next_rising` | Date and time of the next sun rising (in UTC).
diff --git a/source/_components/switch.command_line.markdown b/source/_components/switch.command_line.markdown
index 3f3ef8d0220..5811eb9a6e4 100644
--- a/source/_components/switch.command_line.markdown
+++ b/source/_components/switch.command_line.markdown
@@ -13,8 +13,10 @@ ha_release: pre 0.7
ha_iot_class: "Local Polling"
---
-
-The `command_line` switch platform issues specific commands when it is turned on and off. This might very well become our most powerful platform as it allows anyone to integrate any type of switch into Home Assistant that can be controlled from the command line, including calling other scripts!
+The `command_line` switch platform issues specific commands when it is turned on
+and off. This might very well become our most powerful platform as it allows
+anyone to integrate any type of switch into Home Assistant that can be
+controlled from the command line, including calling other scripts!
To enable it, add the following lines to your `configuration.yaml`:
@@ -28,27 +30,63 @@ switch:
command_off: switch_command off kitchen
```
-Configuration variables:
-
-- **switches** (*Required*): The array that contains all command switches.
- - **identifier** (*Required*): Name of the command switch as slug. Multiple entries are possible.
- - **command_on** (*Required*): The action to take for on.
- - **command_off** (*Required*): The action to take for off.
- - **command_state** (*Optional*): If given, this command will be run. Returning a result code `0` will indicate that the switch is on.
- - **value_template** (*Optional*): If specified, `command_state` will ignore the result code of the command but the template evaluating to `true` will indicate the switch is on.
- - **friendly_name** (*Optional*): The name used to display the switch in the frontend.
+{% configuration %}
+switches:
+ description: The array that contains all command switches.
+ required: true
+ type: map
+ keys:
+ identifier:
+ description: Name of the command switch as slug. Multiple entries are possible.
+ required: true
+ type: map
+ keys:
+ command_on:
+ description: The action to take for on.
+ required: true
+ type: string
+ command_off:
+ description: The action to take for off.
+ required: true
+ type: string
+ command_state:
+ description: "If given, this command will be run. Returning a result code `0` will indicate that the switch is on."
+ required: false
+ type: string
+ value_template:
+ description: "If specified, `command_state` will ignore the result code of the command but the template evaluating to `true` will indicate the switch is on."
+ required: false
+ type: string
+ friendly_name:
+ description: The name used to display the switch in the frontend.
+ required: false
+ type: string
+{% endconfiguration %}
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 %}
-In this section you find some real life examples of how to use this switch.
+In this section you find some real-life examples of how to use this switch.
### {% linkable_title aREST device %}
-The example below is doing the same as the [aREST switch](/components/switch.arest/). The command line tool [`curl`](http://curl.haxx.se/) is used to toggle a pin which is controllable through REST.
+The example below is doing the same as the
+[aREST switch](/components/switch.arest/).
+The command line tool [`curl`](http://curl.haxx.se/) is used to toggle a pin
+which is controllable through REST.
```yaml
# Example configuration.yaml entry
@@ -63,7 +101,10 @@ 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`](/components/automation/) or in [API calls](/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 %}
@@ -73,7 +114,6 @@ This switch will shutdown your system that is hosting Home Assistant.
This switch will shutdown your host immediately, there will be no confirmation.
Notify MFA module would not verify the one-time password deliveried success, so that if user cannot received the message due any reason, he/she may not be login again. Edit or remove `[your_config_dir]/.storage/auth_module.notify` can disable nofiy MFA module to resolve the issue.
diff --git a/source/_docs/automation.markdown b/source/_docs/automation.markdown
index 6729aa4fcb4..99ace9bb2e7 100644
--- a/source/_docs/automation.markdown
+++ b/source/_docs/automation.markdown
@@ -49,7 +49,7 @@ Actions are all about calling services. To explore the available services open t
### {% linkable_title Automation initial state %}
-You have to set an initial state in your automations in order for Home Assistant to enable them upon restart.
+You have to set an initial state in your automations in order for Home Assistant to always enable them upon restart.
```text
automation:
@@ -58,3 +58,5 @@ automation:
trigger:
...
```
+
+If you don't set this the previous state is restored. If you shut Home Assistant down before it finishes starting, the automation will be stored as being off, and your automations will be disabled at the next startup.
diff --git a/source/_docs/configuration/devices.markdown b/source/_docs/configuration/devices.markdown
index af0a9dd9494..43706169c3a 100644
--- a/source/_docs/configuration/devices.markdown
+++ b/source/_docs/configuration/devices.markdown
@@ -16,7 +16,7 @@ See the [components overview page](/components/) to find installation instructio
Classification for the available integrations:
-- [IoT class(/blog/2016/02/12/classifying-the-internet-of-things): Classifier for the device's behavior.
+- [IoT class](/blog/2016/02/12/classifying-the-internet-of-things): Classifier for the device's behavior.
- [Quality scale](/docs/quality_scale/): Representation of the integration's quality.
Usually every entity needs its own entry in the `configuration.yaml` file. There are two styles for multiple entries:
diff --git a/source/_docs/ecosystem/appdaemon/api.markdown b/source/_docs/ecosystem/appdaemon/api.markdown
index 8efa974eb47..be4a60c0245 100755
--- a/source/_docs/ecosystem/appdaemon/api.markdown
+++ b/source/_docs/ecosystem/appdaemon/api.markdown
@@ -942,7 +942,7 @@ time, interval, kwargs = self.info_timer(handle)
All of the scheduler calls above support 2 additional optional arguments, `random_start` and `random_end`. Using these arguments it is possible to randomize the firing of callbacks to the degree desired by setting the appropriate number of seconds with the parameters.
- `random_start` - start of range of the random time
-- `random_end` - end of range of the random time
+- `random_end` - end of range of the random time
`random_start` must always be numerically lower than `random_end`, they can be negative to denote a random offset before and event, or positive to denote a random offset after an event. The event would be an absolute or relative time or sunrise/sunset depending on which scheduler call you use and these values affect the base time by the spcified amount. If not specified, they will default to `0`.
@@ -1490,7 +1490,7 @@ service, kwargs = self.info_listen_event(handle)
### {% linkable_title fire_event() %}
-Fire an event on the HomeAssistant bus, for other components to hear.
+Fire an event on the Home Assistant bus, for other components to hear.
#### {% linkable_title Synopsis %}
diff --git a/source/_docs/ecosystem/backup/backup_dropbox.markdown b/source/_docs/ecosystem/backup/backup_dropbox.markdown
index 6baa2cbc9a0..5cf595abe35 100644
--- a/source/_docs/ecosystem/backup/backup_dropbox.markdown
+++ b/source/_docs/ecosystem/backup/backup_dropbox.markdown
@@ -37,6 +37,20 @@ Follow the instructions you see on your screen.
Go to the folder you have placed `dropbox.py`.
+- **Option A:**
+ Copy file `dropbox_uploader.sh` to : `.homeassistant/extraconfig/shell_code/` (so the full path would be similar to: `/home/homeassistant/.homeassistant/extraconfig/shell_code/dropbox_uploader.sh`)
+- **Option B:**
+ Edit `dropbox.py`:
+ Change the following line:
+ ```
+ uploader = "/home/homeassistant/.homeassistant/extraconfig/shell_code/dropbox_uploader.sh"
+ ```
+ to where you placed your file: (for example):
+ ```
+ uploader = "/home/homeassistant/MyFolder/dropbox_uploader.sh"
+ ```
+
+
```bash
$ python dropbox.py
```
diff --git a/source/_docs/ecosystem/ios/notifications/actions.markdown b/source/_docs/ecosystem/ios/notifications/actions.markdown
index eb66feb66f3..3112ae06a33 100644
--- a/source/_docs/ecosystem/ios/notifications/actions.markdown
+++ b/source/_docs/ecosystem/ios/notifications/actions.markdown
@@ -142,3 +142,9 @@ Notes:
* `textInput` will only exist if `behavior` was set to `textInput`.
* `actionData` is a dictionary with parameters passed in the `action_data` dictionary of the `push` dictionary in the original notification.
* When adding or updating push categories be sure to update push settings within the Home Assistant iOS app. This can be found within the app at **Settings** (gear icon) > **Notification Settings**.
+
+## {% linkable_title Compatibility with different devices %}
+
+* For devices that support "Force Touch" / "3D Touch" - a long press on the notification will cause the actions to appear. Devices such as iPhone 6S, iPhone 6S Plus, iPhone 7, iPhone 7 Plus, iPhone 8, iPhone 8 Plus, iPhone X, iPhone XS, iPhone XS Max as well as some iPad and Apple Watch models.
+
+* For device that do not support this feature - a left to right swipe on the notification + tap on 'View' button, will cause the relevant actions to appear. Devices such as iPhone 6 and below, iPhone SE, iPhone XR as some iPad models.
diff --git a/source/_docs/ecosystem/ios/notifications/basic.markdown b/source/_docs/ecosystem/ios/notifications/basic.markdown
index 7e0a5e92887..f05c21deba5 100644
--- a/source/_docs/ecosystem/ios/notifications/basic.markdown
+++ b/source/_docs/ecosystem/ios/notifications/basic.markdown
@@ -14,7 +14,7 @@ The iOS notify platform accepts the standard `title`, `message` and `target` par
Notes:
-* `title` only displays on Apple Watch and iOS 10 devices.
+* `title` only displays on Apple Watch and devices with iOS 10 or above.
* `target` can be used to specific a single device using its PushID, found in `ios.conf`. The preferred way of providing a target is through a target specific notify service.
@@ -44,7 +44,7 @@ automation:
```
#### Subtitle
-iOS 10 supports a subtitle in addition to the title:
+Starting with iOS 10, a subtitle is supported in addition to the title:
```yaml
automation
@@ -60,6 +60,25 @@ automation
subtitle: "Subtitle goes here"
```
+#### Thread-id (grouping notifications)
+Starting with iOS 12, grouping of notifications is supported. All notifications with the same thread-id will be grouped together in the notification center. Without a thread-id, all notifications from the app will be placed in a single group.
+
+```yaml
+automation:
+ - alias: Notify iOS app
+ trigger:
+ ...
+ action:
+ service: notify.ios_
-You can 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`
-It's time for another great release and we're introducing a brand new feature: device registry. This allows integrations to tell Home Assistant not only about entities, but also which devices the entities represent. It also allows integrations to tell Home Assistant how a device is connected to Home Assistant. For example, a Hue light bulb is connected to Home Assistant via the Hue hub.
+It's time for another great release and we're introducing a brand new feature: device registry. Thanks to [@Kane610] for driving this effort. This allows integrations to tell Home Assistant not only about entities, but also which devices the entities represent. It also allows integrations to tell Home Assistant how a device is connected to Home Assistant. For example, a Hue light bulb is connected to Home Assistant via the Hue hub.
@@ -56,6 +56,49 @@ Oh, and yes, there is also some cool new integrations. Support has been added fo
- GeoJSON platform ([@exxamalte] - [#16610]) ([geo_location docs]) (new-platform)
- Add linky sensor ([@tiste] - [#16468]) ([sensor.linky docs]) (new-platform)
+## {% linkable_title Release 0.79.1 - September 30 %}
+
+- Optimize Ring Sensors platform setup ([@awarecan] - [#16886]) ([binary_sensor.ring docs]) ([sensor.ring docs])
+- Fix exception during history_stats startup ([@amelchio] - [#16932]) ([sensor.history_stats docs])
+- Override unique_id of NestActivityZoneSensor ([@awarecan] - [#16961]) ([binary_sensor.nest docs])
+- Fix ISY blocking bug ([@OverloadUT] - [#16978]) ([light.isy994 docs])
+- Bump zm-py to 0.0.4 ([@rohankapoorcom] - [#16979]) ([zoneminder docs])
+
+[#16886]: https://github.com/home-assistant/home-assistant/pull/16886
+[#16932]: https://github.com/home-assistant/home-assistant/pull/16932
+[#16961]: https://github.com/home-assistant/home-assistant/pull/16961
+[#16978]: https://github.com/home-assistant/home-assistant/pull/16978
+[#16979]: https://github.com/home-assistant/home-assistant/pull/16979
+[@OverloadUT]: https://github.com/OverloadUT
+[@amelchio]: https://github.com/amelchio
+[@awarecan]: https://github.com/awarecan
+[@rohankapoorcom]: https://github.com/rohankapoorcom
+[binary_sensor.nest docs]: /components/binary_sensor.nest/
+[binary_sensor.ring docs]: /components/binary_sensor.ring/
+[light.isy994 docs]: /components/light.isy994/
+[sensor.history_stats docs]: /components/sensor.history_stats/
+[sensor.ring docs]: /components/sensor.ring/
+[zoneminder docs]: /components/zoneminder/
+
+## {% linkable_title Release 0.79.2 - October 1 %}
+
+- Fix MQTT certificates ([@balloob] - [#16999]) ([mqtt docs])
+- Fix switch.zoneminder name ([@rohankapoorcom] - [#17026]) ([switch.zoneminder docs])
+
+[#16999]: https://github.com/home-assistant/home-assistant/pull/16999
+[#17026]: https://github.com/home-assistant/home-assistant/pull/17026
+[@balloob]: https://github.com/balloob
+[@rohankapoorcom]: https://github.com/rohankapoorcom
+[mqtt docs]: /components/mqtt/
+[switch.zoneminder docs]: /components/switch.zoneminder/
+
+## {% linkable_title Release 0.79.3 - October 2 %}
+
+- Use correct event loop on Windows, fixing SSL and Subprocess requests. ([#16737], [#17066] - [@awarecan], [@balloob])
+
+[#16737]: https://github.com/home-assistant/home-assistant/pull/16737
+[#17066]: https://github.com/home-assistant/home-assistant/pull/17066
+
## {% 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.
@@ -84,6 +127,7 @@ Experiencing issues introduced by this release? Please report them in our [issue
- Add unique_id to Nest Sensors ([@cgarwood] - [#16869]) ([binary_sensor.nest docs]) ([sensor.nest docs]) (beta fix)
- Prevent discovered Tradfri while already configured ([@balloob] - [#16891]) ([tradfri docs]) (beta fix)
- Handle exception handling websocket command ([@balloob] - [#16927]) ([websocket_api docs]) (beta fix)
+- The `zoneminder` switch platform now uses new names. ([@rohankapoorcom] - [#16527]) ([zoneminder docs]) (breaking change)
## {% linkable_title All changes %}
diff --git a/source/developers/credits.markdown b/source/developers/credits.markdown
index 5de3f71a6d2..c2e7f95aa35 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-09-21 19:49:45 +0000
+date: 2018-09-28 20:02:13 +0000
sidebar: true
comments: false
sharing: true
@@ -13,7 +13,7 @@ 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 "7690 total commits to the home-assistant organization, 4314 commits to home-assistant, 1588 commits to home-assistant.io, 1067 commits to home-assistant-polymer, 237 commits to home-assistant-js, 129 commits to developers.home-assistant, 127 commits to netdisco, 94 commits to home-assistant-js-websocket, 40 commits to hass-release, 17 commits to LabelBot, 15 commits to home-assistant-assets, 11 commits to hassio, 9 commits to hbmqtt-auth-home-assistant, 8 commits to example-custom-config, 7 commits to micropython-home-assistant, 6 commits to custom-panel-starter-kit-react, 4 commits to ui-schema, 3 commits to hassio-addons, 3 commits to hassio-build, 2 commits to issue-bot, 2 commits to home-assistant-iOS, 2 commits to hassio-addons-example, 2 commits to lambda-home-assistant-github, 1 commit to home-assistant-notebooks, 1 commit to warrant, 1 commit to architecture")
+- [Paulus Schoutsen (@balloob)](https://github.com/balloob "7770 total commits to the home-assistant organization, 4347 commits to home-assistant, 1619 commits to home-assistant.io, 1080 commits to home-assistant-polymer, 237 commits to home-assistant-js, 132 commits to developers.home-assistant, 127 commits to netdisco, 94 commits to home-assistant-js-websocket, 40 commits to hass-release, 17 commits to LabelBot, 15 commits to home-assistant-assets, 11 commits to hassio, 9 commits to hbmqtt-auth-home-assistant, 8 commits to example-custom-config, 7 commits to micropython-home-assistant, 6 commits to custom-panel-starter-kit-react, 4 commits to ui-schema, 3 commits to hassio-addons, 3 commits to hassio-build, 2 commits to hassio-addons-example, 2 commits to issue-bot, 2 commits to home-assistant-iOS, 2 commits to lambda-home-assistant-github, 1 commit to warrant, 1 commit to home-assistant-notebooks, 1 commit to architecture")
### {% linkable_title Contributors %}
@@ -23,11 +23,11 @@ This page contains a list of people who have contributed in one way or another t
- [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 "84 total commits to the home-assistant organization, 59 commits to home-assistant, 25 commits to home-assistant.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 "26 total commits to the home-assistant organization, 15 commits to home-assistant, 7 commits to home-assistant.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 "27 total commits to the home-assistant organization, 15 commits to home-assistant, 8 commits to home-assistant.io, 2 commits to home-assistant-polymer, 1 commit to home-assistant-js-websocket, 1 commit to netdisco")
- [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.io")
- [Adam Dullage (@Dullage)](https://github.com/Dullage "3 total commits to the home-assistant organization, 3 commits to home-assistant.io")
-- [Adam Mills (@armills)](https://github.com/armills "331 total commits to the home-assistant organization, 174 commits to home-assistant, 93 commits to home-assistant-polymer, 59 commits to home-assistant.io, 3 commits to home-assistant-js, 1 commit to homebridge-homeassistant, 1 commit to developers.home-assistant")
+- [Adam Mills (@armills)](https://github.com/armills "332 total commits to the home-assistant organization, 174 commits to home-assistant, 93 commits to home-assistant-polymer, 60 commits to home-assistant.io, 3 commits to home-assistant-js, 1 commit to homebridge-homeassistant, 1 commit to developers.home-assistant")
- [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")
@@ -50,12 +50,12 @@ This page contains a list of people who have contributed in one way or another t
- [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.io")
- [Alexei Chetroi (@Adminiuga)](https://github.com/Adminiuga "12 total commits to the home-assistant organization, 11 commits to home-assistant, 1 commit to home-assistant-polymer")
-- [Alexis Iglauer (@ax42)](https://github.com/ax42 "3 total commits to the home-assistant organization, 3 commits to home-assistant.io")
+- [Alexis Iglauer (@ax42)](https://github.com/ax42 "4 total commits to the home-assistant organization, 4 commits to home-assistant.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.io, 2 commits to appdaemon, 2 commits to home-assistant")
- [Alok Saboo (@arsaboo)](https://github.com/arsaboo "148 total commits to the home-assistant organization, 83 commits to home-assistant.io, 53 commits to home-assistant, 7 commits to home-assistant-polymer, 3 commits to developers.home-assistant, 1 commit to pi-gen, 1 commit to hassio-addons")
- [amorsillo (@AndrewMorsillo)](https://github.com/AndrewMorsillo "1 total commits to the home-assistant organization, 1 commit to home-assistant-polymer")
-- [Anders Melchiorsen (@amelchio)](https://github.com/amelchio "252 total commits to the home-assistant organization, 206 commits to home-assistant, 44 commits to home-assistant.io, 2 commits to home-assistant-polymer")
+- [Anders Melchiorsen (@amelchio)](https://github.com/amelchio "258 total commits to the home-assistant organization, 212 commits to home-assistant, 44 commits to home-assistant.io, 2 commits to home-assistant-polymer")
- [andig (@andig)](https://github.com/andig "2 total commits to the home-assistant organization, 2 commits to pi-gen")
- [Andrea Campi (@andreacampi)](https://github.com/andreacampi "6 total commits to the home-assistant organization, 6 commits to home-assistant")
- [Andreas Björshammar (@abjorshammar)](https://github.com/abjorshammar "2 total commits to the home-assistant organization, 2 commits to home-assistant")
@@ -88,7 +88,7 @@ This page contains a list of people who have contributed in one way or another t
- [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 "2 total commits to the home-assistant organization, 2 commits to home-assistant")
- [arjenfvellinga (@arjenfvellinga)](https://github.com/arjenfvellinga "5 total commits to the home-assistant organization, 5 commits to home-assistant.io")
-- [Arno (@aetjansen)](https://github.com/aetjansen "3 total commits to the home-assistant organization, 3 commits to home-assistant.io")
+- [Arno Jansen (@aetjansen)](https://github.com/aetjansen "3 total commits to the home-assistant organization, 3 commits to home-assistant.io")
- [ArrayLabs (@arraylabs)](https://github.com/arraylabs "6 total commits to the home-assistant organization, 6 commits to home-assistant")
- [Artem (@ArtHome12)](https://github.com/ArtHome12 "2 total commits to the home-assistant organization, 2 commits to developers.home-assistant")
- [Arthur Leonard Andersen (@leoc)](https://github.com/leoc "9 total commits to the home-assistant organization, 9 commits to home-assistant")
@@ -124,6 +124,7 @@ This page contains a list of people who have contributed in one way or another t
- [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")
+- [Blake Blackshear (@blakeblackshear)](https://github.com/blakeblackshear "2 total commits to the home-assistant organization, 2 commits to home-assistant")
- [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.io")
- [Bob Clough (@thinkl33t)](https://github.com/thinkl33t "2 total commits to the home-assistant organization, 2 commits to home-assistant")
- [Bob Igo (@Human)](https://github.com/Human "3 total commits to the home-assistant organization, 3 commits to home-assistant.io")
@@ -161,26 +162,24 @@ This page contains a list of people who have contributed in one way or another t
- [Caius Seiger (@caiuspb)](https://github.com/caiuspb "3 total commits to the home-assistant organization, 3 commits to home-assistant")
- [Caleb Dunn (@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 "3 total commits to the home-assistant organization, 2 commits to home-assistant, 1 commit to netdisco")
-- [Carlo Costanzo (@CCOSTAN)](https://github.com/CCOSTAN "99 total commits to the home-assistant organization, 91 commits to home-assistant.io, 5 commits to home-assistant, 1 commit to fabric-home-assistant, 1 commit to hassbian-scripts, 1 commit to homebridge-homeassistant")
+- [Carlo Costanzo (@CCOSTAN)](https://github.com/CCOSTAN "99 total commits to the home-assistant organization, 91 commits to home-assistant.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")
-- [cdce8p (@cdce8p)](https://github.com/cdce8p "147 total commits to the home-assistant organization, 85 commits to home-assistant, 42 commits to home-assistant.io, 13 commits to home-assistant-polymer, 5 commits to hass-release, 2 commits to developers.home-assistant")
+- [cdce8p (@cdce8p)](https://github.com/cdce8p "157 total commits to the home-assistant organization, 94 commits to home-assistant, 42 commits to home-assistant.io, 13 commits to home-assistant-polymer, 5 commits to hass-release, 3 commits to developers.home-assistant")
- [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")
- [Censored3 (@Censored3)](https://github.com/Censored3 "2 total commits to the home-assistant organization, 2 commits to hassio-addons")
- [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 "34 total commits to the home-assistant organization, 21 commits to home-assistant, 13 commits to home-assistant.io")
+- [cgtobi (@cgtobi)](https://github.com/cgtobi "35 total commits to the home-assistant organization, 22 commits to home-assistant, 13 commits to home-assistant.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.io")
-- [Charles Garwood (@cgarwood)](https://github.com/cgarwood "33 total commits to the home-assistant organization, 16 commits to home-assistant.io, 10 commits to home-assistant, 7 commits to home-assistant-polymer")
+- [Charles Garwood (@cgarwood)](https://github.com/cgarwood "37 total commits to the home-assistant organization, 16 commits to home-assistant.io, 12 commits to home-assistant, 9 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.io")
- [Chayoung You (@yous)](https://github.com/yous "3 total commits to the home-assistant organization, 3 commits to home-assistant.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")
- [Chris (@chennin)](https://github.com/chennin "15 total commits to the home-assistant organization, 11 commits to home-assistant.io, 4 commits to home-assistant")
- [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 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.io, 4 commits to appdaemon")
- [Chris Thorn (@chris-thorn)](https://github.com/chris-thorn "7 total commits to the home-assistant organization, 7 commits to home-assistant.io")
- [ChrisS85 (@ChrisS85)](https://github.com/ChrisS85 "1 total commits to the home-assistant organization, 1 commit to hassio-build")
@@ -188,7 +187,7 @@ 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 Studer (@cstuder)](https://github.com/cstuder "4 total commits to the home-assistant organization, 4 commits to home-assistant.io")
- [ChristianKuehnel (@ChristianKuehnel)](https://github.com/ChristianKuehnel "39 total commits to the home-assistant organization, 23 commits to home-assistant, 16 commits to home-assistant.io")
-- [Christoph Gerneth (@c7h)](https://github.com/c7h "5 total commits to the home-assistant organization, 3 commits to home-assistant.io, 2 commits to home-assistant")
+- [Christoph Gerneth (@c7h)](https://github.com/c7h "3 total commits to the home-assistant organization, 3 commits to home-assistant.io")
- [Christoph Wagner (@Christoph-Wagner)](https://github.com/Christoph-Wagner "4 total commits to the home-assistant organization, 4 commits to home-assistant.io")
- [Christopher Viel (@Chris-V)](https://github.com/Chris-V "3 total commits to the home-assistant organization, 3 commits to home-assistant")
- [chrysn (@chrysn)](https://github.com/chrysn "65 total commits to the home-assistant organization, 65 commits to libcoap")
@@ -198,7 +197,6 @@ This page contains a list of people who have contributed in one way or another t
- [clach04 (@clach04)](https://github.com/clach04 "4 total commits to the home-assistant organization, 3 commits to home-assistant.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 "20 total commits to the home-assistant organization, 15 commits to home-assistant.io, 3 commits to developers.home-assistant, 2 commits to hassos")
-- [Colin Dunn (@colindunn)](https://github.com/colindunn "2 total commits to the home-assistant organization, 2 commits to home-assistant")
- [Colin Frei (@colinfrei)](https://github.com/colinfrei "3 total commits to the home-assistant organization, 3 commits to home-assistant.io")
- [Colin O'Dell (@colinodell)](https://github.com/colinodell "33 total commits to the home-assistant organization, 18 commits to home-assistant, 15 commits to home-assistant.io")
- [Colin Teubner (@netopiax)](https://github.com/netopiax "3 total commits to the home-assistant organization, 3 commits to home-assistant.io")
@@ -223,10 +221,10 @@ 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.io")
- [Daniel Bowman (@vrih)](https://github.com/vrih "5 total commits to the home-assistant organization, 4 commits to home-assistant, 1 commit to netdisco")
- [Daniel Escoz (@Darkhogg)](https://github.com/Darkhogg "3 total commits to the home-assistant organization, 3 commits to home-assistant.io")
-- [Daniel Høyer Iversen (@Danielhiversen)](https://github.com/Danielhiversen "330 total commits to the home-assistant organization, 210 commits to home-assistant, 117 commits to home-assistant.io, 3 commits to home-assistant-polymer")
+- [Daniel Høyer Iversen (@Danielhiversen)](https://github.com/Danielhiversen "335 total commits to the home-assistant organization, 214 commits to home-assistant, 118 commits to home-assistant.io, 3 commits to home-assistant-polymer")
- [Daniel Perna (@danielperna84)](https://github.com/danielperna84 "107 total commits to the home-assistant organization, 54 commits to home-assistant, 42 commits to home-assistant.io, 11 commits to hassio-addons")
- [Daniel Peukert (@dpeukert)](https://github.com/dpeukert "1 total commits to the home-assistant organization, 1 commit to home-assistant-polymer")
-- [Daniel Shokouhi (@dshokouhi)](https://github.com/dshokouhi "27 total commits to the home-assistant organization, 20 commits to home-assistant.io, 7 commits to home-assistant")
+- [Daniel Shokouhi (@dshokouhi)](https://github.com/dshokouhi "31 total commits to the home-assistant organization, 21 commits to home-assistant.io, 10 commits to home-assistant")
- [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 "6 total commits to the home-assistant organization, 3 commits to home-assistant.io, 2 commits to homebridge-homeassistant, 1 commit to hassio-addons")
@@ -261,19 +259,20 @@ This page contains a list of people who have contributed in one way or another t
- [DetroitEE (@DetroitEE)](https://github.com/DetroitEE "3 total commits to the home-assistant organization, 3 commits to home-assistant.io")
- [devdelay (@devdelay)](https://github.com/devdelay "16 total commits to the home-assistant organization, 7 commits to home-assistant.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.io")
-- [Diogo Gomes (@dgomes)](https://github.com/dgomes "74 total commits to the home-assistant organization, 49 commits to home-assistant, 24 commits to home-assistant.io, 1 commit to developers.home-assistant")
+- [Diogo Gomes (@dgomes)](https://github.com/dgomes "75 total commits to the home-assistant organization, 49 commits to home-assistant, 25 commits to home-assistant.io, 1 commit to developers.home-assistant")
- [Dmitri Pribysh (@dmand)](https://github.com/dmand "1 total commits to the home-assistant organization, 1 commit to hassos")
- [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 "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.io")
- [DrewSK (@dzsquared)](https://github.com/dzsquared "8 total commits to the home-assistant organization, 8 commits to home-assistant.io")
-- [DubhAd (@DubhAd)](https://github.com/DubhAd "419 total commits to the home-assistant organization, 415 commits to home-assistant.io, 2 commits to hassos, 2 commits to developers.home-assistant")
+- [DubhAd (@DubhAd)](https://github.com/DubhAd "456 total commits to the home-assistant organization, 452 commits to home-assistant.io, 2 commits to hassos, 2 commits to developers.home-assistant")
- [Duoxilian (@Duoxilian)](https://github.com/Duoxilian "11 total commits to the home-assistant organization, 6 commits to home-assistant.io, 5 commits to home-assistant")
- [ebpetway (@ebpetway)](https://github.com/ebpetway "55 total commits to the home-assistant organization, 55 commits to warrant")
- [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.io")
- [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")
- [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.io")
+- [emontnemery (@emontnemery)](https://github.com/emontnemery "11 total commits to the home-assistant organization, 11 commits to home-assistant")
- [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.io")
@@ -285,7 +284,7 @@ This page contains a list of people who have contributed in one way or another t
- [Eu (@covrig)](https://github.com/covrig "2 total commits to the home-assistant organization, 2 commits to home-assistant-polymer")
- [Eugenio Panadero (@azogue)](https://github.com/azogue "77 total commits to the home-assistant organization, 46 commits to home-assistant, 25 commits to home-assistant.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 "4972 total commits to the home-assistant organization, 3110 commits to home-assistant.io, 1723 commits to home-assistant, 33 commits to home-assistant-assets, 32 commits to home-assistant-notebooks, 15 commits to developers.home-assistant, 11 commits to home-assistant-polymer, 11 commits to hassio-build, 10 commits to netdisco, 7 commits to hassos, 6 commits to hassio, 6 commits to hassio-addons, 3 commits to hass-release, 2 commits to home-assistant-iOS, 1 commit to home-assistant-js-websocket, 1 commit to example-custom-config, 1 commit to ui-schema")
+- [Fabian Affolter (@fabaff)](https://github.com/fabaff "4991 total commits to the home-assistant organization, 3124 commits to home-assistant.io, 1724 commits to home-assistant, 33 commits to home-assistant-assets, 32 commits to home-assistant-notebooks, 19 commits to developers.home-assistant, 11 commits to home-assistant-polymer, 11 commits to hassio-build, 10 commits to netdisco, 7 commits to hassos, 6 commits to hassio-addons, 6 commits to hassio, 3 commits to hass-release, 2 commits to home-assistant-iOS, 1 commit to ui-schema, 1 commit to example-custom-config, 1 commit to home-assistant-js-websocket")
- [Fabian Fischer (@nodomain)](https://github.com/nodomain "1 total commits to the home-assistant organization, 1 commit to hassio-addons")
- [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 "4 total commits to the home-assistant organization, 3 commits to home-assistant, 1 commit to home-assistant-polymer")
@@ -300,7 +299,7 @@ This page contains a list of people who have contributed in one way or another t
- [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.io")
- [Fonta (@f0nt4)](https://github.com/f0nt4 "4 total commits to the home-assistant organization, 4 commits to home-assistant.io")
-- [Franck Nijhof (@frenck)](https://github.com/frenck "52 total commits to the home-assistant organization, 31 commits to home-assistant.io, 10 commits to hassio, 3 commits to hassio-addons, 3 commits to home-assistant, 2 commits to hassio-cli, 2 commits to home-assistant-polymer, 1 commit to appdaemon")
+- [Franck Nijhof (@frenck)](https://github.com/frenck "68 total commits to the home-assistant organization, 32 commits to home-assistant.io, 16 commits to hassio-cli, 10 commits to hassio, 4 commits to hassio-addons, 3 commits to home-assistant, 2 commits to home-assistant-polymer, 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 "17 total commits to the home-assistant organization, 9 commits to home-assistant, 4 commits to home-assistant.io, 3 commits to netdisco, 1 commit to home-assistant-js-websocket")
- [Frederic Hemberger (@fhemberger)](https://github.com/fhemberger "93 total commits to the home-assistant organization, 93 commits to home-assistant.io")
@@ -309,14 +308,14 @@ This page contains a list of people who have contributed in one way or another t
- [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.io")
- [Gabor SZOLLOSI (@szogi)](https://github.com/szogi "1 total commits to the home-assistant organization, 1 commit to appdaemon")
-- [Gabriel Oliveira (@gabrielboliveira)](https://github.com/gabrielboliveira "2 total commits to the home-assistant organization, 1 commit to hassos, 1 commit to hassio-addons")
+- [Gabriel Oliveira (@gabrielboliveira)](https://github.com/gabrielboliveira "2 total commits to the home-assistant organization, 1 commit to hassio-addons, 1 commit to hassos")
- [geekofweek (@geekofweek)](https://github.com/geekofweek "3 total commits to the home-assistant organization, 3 commits to home-assistant")
- [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 "6 total commits to the home-assistant organization, 6 commits to home-assistant.io")
- [Georgi Kirichkov (@kirichkov)](https://github.com/kirichkov "17 total commits to the home-assistant organization, 11 commits to home-assistant.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.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 "12 total commits to the home-assistant organization, 6 commits to home-assistant, 6 commits to home-assistant.io")
+- [Gerard (@gerard33)](https://github.com/gerard33 "14 total commits to the home-assistant organization, 8 commits to home-assistant, 6 commits to home-assistant.io")
- [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.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.io")
- [Giel Janssens (@gieljnssns)](https://github.com/gieljnssns "5 total commits to the home-assistant organization, 5 commits to home-assistant")
@@ -331,7 +330,7 @@ This page contains a list of people who have contributed in one way or another t
- [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 "80 total commits to the home-assistant organization, 75 commits to home-assistant.io, 5 commits to home-assistant")
- [Greg Dowling (@pavoni)](https://github.com/pavoni "209 total commits to the home-assistant organization, 183 commits to home-assistant, 25 commits to home-assistant.io, 1 commit to netdisco")
-- [Greg Laabs (@OverloadUT)](https://github.com/OverloadUT "22 total commits to the home-assistant organization, 18 commits to home-assistant, 4 commits to home-assistant.io")
+- [Greg Laabs (@OverloadUT)](https://github.com/OverloadUT "25 total commits to the home-assistant organization, 21 commits to home-assistant, 4 commits to home-assistant.io")
- [Greg MacLellan (@gregmac)](https://github.com/gregmac "1 total commits to the home-assistant organization, 1 commit to pi-gen")
- [Greg Stevenson (@gstevenson)](https://github.com/gstevenson "4 total commits to the home-assistant organization, 4 commits to home-assistant.io")
- [Gregory Benner (@Klathmon)](https://github.com/Klathmon "3 total commits to the home-assistant organization, 3 commits to home-assistant")
@@ -357,7 +356,7 @@ This page contains a list of people who have contributed in one way or another t
- [Hillary Fraley (@hillaryfraley)](https://github.com/hillaryfraley "12 total commits to the home-assistant organization, 12 commits to home-assistant.io")
- [Hmmbob (@hmmbob)](https://github.com/hmmbob "1 total commits to the home-assistant organization, 1 commit to home-assistant-polymer")
- [honcheng (@honcheng)](https://github.com/honcheng "2 total commits to the home-assistant organization, 2 commits to homebridge-homeassistant")
-- [huangyupeng (@huangyupeng)](https://github.com/huangyupeng "14 total commits to the home-assistant organization, 7 commits to home-assistant, 7 commits to home-assistant.io")
+- [huangyupeng (@huangyupeng)](https://github.com/huangyupeng "15 total commits to the home-assistant organization, 8 commits to home-assistant, 7 commits to home-assistant.io")
- [Hugo Dupras (@jabesq)](https://github.com/jabesq "29 total commits to the home-assistant organization, 21 commits to home-assistant, 8 commits to home-assistant.io")
- [Hugo Gresse (@HugoGresse)](https://github.com/HugoGresse "8 total commits to the home-assistant organization, 8 commits to home-assistant.io")
- [Hugo Hromic (@hhromic)](https://github.com/hhromic "4 total commits to the home-assistant organization, 4 commits to pi-gen")
@@ -369,12 +368,12 @@ This page contains a list of people who have contributed in one way or another t
- [icovada (@icovada)](https://github.com/icovada "6 total commits to the home-assistant organization, 3 commits to home-assistant, 3 commits to home-assistant.io")
- [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.io, 1 commit to home-assistant-polymer")
- [Ioan Loosley (@ioangogo)](https://github.com/ioangogo "15 total commits to the home-assistant organization, 12 commits to home-assistant.io, 3 commits to home-assistant")
-- [Isabella Gross Alström (@isabellaalstrom)](https://github.com/isabellaalstrom "3 total commits to the home-assistant organization, 3 commits to home-assistant.io")
+- [Isabella Gross Alström (@isabellaalstrom)](https://github.com/isabellaalstrom "4 total commits to the home-assistant organization, 4 commits to home-assistant.io")
- [Issac Kelly (@issackelly)](https://github.com/issackelly "3 total commits to the home-assistant organization, 3 commits to home-assistant")
- [Jaak Laineste (@jaakla)](https://github.com/jaakla "1 total commits to the home-assistant organization, 1 commit to home-assistant-polymer")
- [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.io")
- [Jack (@jackjohnsonuk)](https://github.com/jackjohnsonuk "6 total commits to the home-assistant organization, 6 commits to home-assistant.io")
+- [jack (@jackmakesthings)](https://github.com/jackmakesthings "3 total commits to the home-assistant organization, 3 commits to home-assistant.io")
- [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 "3 total commits to the home-assistant organization, 3 commits to home-assistant")
- [Jacob Siverskog (@jsiverskog)](https://github.com/jsiverskog "1 total commits to the home-assistant organization, 1 commit to pi-gen")
@@ -393,7 +392,7 @@ This page contains a list of people who have contributed in one way or another t
- [Janne Grunau (@jannau)](https://github.com/jannau "3 total commits to the home-assistant organization, 3 commits to home-assistant")
- [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.io")
- [Jason Hite (@jasonmhite)](https://github.com/jasonmhite "6 total commits to the home-assistant organization, 6 commits to appdaemon")
-- [Jason Hu (@awarecan)](https://github.com/awarecan "136 total commits to the home-assistant organization, 93 commits to home-assistant, 17 commits to home-assistant-polymer, 15 commits to home-assistant.io, 9 commits to developers.home-assistant, 1 commit to home-assistant-js-websocket, 1 commit to netdisco")
+- [Jason Hu (@awarecan)](https://github.com/awarecan "150 total commits to the home-assistant organization, 98 commits to home-assistant, 24 commits to home-assistant.io, 17 commits to home-assistant-polymer, 9 commits to developers.home-assistant, 1 commit to home-assistant-js-websocket, 1 commit to netdisco")
- [Jason Hunter (@hunterjm)](https://github.com/hunterjm "1 total commits to the home-assistant organization, 1 commit to home-assistant-polymer")
- [Jay Stevens (@Jay2645)](https://github.com/Jay2645 "3 total commits to the home-assistant organization, 3 commits to home-assistant.io")
- [JAYMAN-ATX (@JAYMAN-ATX)](https://github.com/JAYMAN-ATX "2 total commits to the home-assistant organization, 2 commits to homebridge-homeassistant")
@@ -404,7 +403,7 @@ This page contains a list of people who have contributed in one way or another t
- [Jeff Wilson (@jawilson)](https://github.com/jawilson "25 total commits to the home-assistant organization, 19 commits to home-assistant, 6 commits to home-assistant.io")
- [Jens (@jhoepken)](https://github.com/jhoepken "3 total commits to the home-assistant organization, 3 commits to home-assistant.io")
- [Jens Østergaard Nielsen (@dingusdk)](https://github.com/dingusdk "8 total commits to the home-assistant organization, 4 commits to home-assistant, 4 commits to home-assistant.io")
-- [Jerad Meisner (@jeradM)](https://github.com/jeradM "57 total commits to the home-assistant organization, 33 commits to home-assistant-polymer, 12 commits to home-assistant.io, 12 commits to home-assistant")
+- [Jerad Meisner (@jeradM)](https://github.com/jeradM "58 total commits to the home-assistant organization, 34 commits to home-assistant-polymer, 12 commits to home-assistant.io, 12 commits to home-assistant")
- [Jeremiah Wuenschel (@jer)](https://github.com/jer "3 total commits to the home-assistant organization, 3 commits to home-assistant.io")
- [Jeremy Williams (@jwillaz)](https://github.com/jwillaz "5 total commits to the home-assistant organization, 5 commits to home-assistant.io")
- [jeremysv (@jeremysv)](https://github.com/jeremysv "3 total commits to the home-assistant organization, 3 commits to home-assistant.io")
@@ -431,22 +430,22 @@ This page contains a list of people who have contributed in one way or another t
- [Johannes K\. (@roadrash2108)](https://github.com/roadrash2108 "4 total commits to the home-assistant organization, 4 commits to home-assistant.io")
- [Johannes Truschnigg (@jtru)](https://github.com/jtru "1 total commits to the home-assistant organization, 1 commit to hassos")
- [John (@J-C-B)](https://github.com/J-C-B "5 total commits to the home-assistant organization, 5 commits to home-assistant.io")
-- [John Arild Berentsen (@turbokongen)](https://github.com/turbokongen "221 total commits to the home-assistant organization, 156 commits to home-assistant, 42 commits to home-assistant.io, 23 commits to home-assistant-polymer")
+- [John Arild Berentsen (@turbokongen)](https://github.com/turbokongen "224 total commits to the home-assistant organization, 156 commits to home-assistant, 45 commits to home-assistant.io, 23 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 Mihalic (@mezz64)](https://github.com/mezz64 "51 total commits to the home-assistant organization, 37 commits to home-assistant, 12 commits to home-assistant.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.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 "14 total commits to the home-assistant organization, 13 commits to home-assistant.io, 1 commit to appdaemon")
+- [Jon Griffith (@arretx)](https://github.com/arretx "15 total commits to the home-assistant organization, 14 commits to home-assistant.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.io")
-- [Jonas Karlsson (@endor-force)](https://github.com/endor-force "11 total commits to the home-assistant organization, 5 commits to hassio-addons, 5 commits to home-assistant.io, 1 commit to hassio-build")
+- [Jonas Karlsson (@endor-force)](https://github.com/endor-force "12 total commits to the home-assistant organization, 6 commits to home-assistant.io, 5 commits to hassio-addons, 1 commit to hassio-build")
- [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.io")
- [Jonathan Weinberg (@jonathanweinberg)](https://github.com/jonathanweinberg "4 total commits to the home-assistant organization, 4 commits to home-assistant.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 "4 total commits to the home-assistant organization, 4 commits to home-assistant.io")
- [Jordy (@jbarrancos)](https://github.com/jbarrancos "40 total commits to the home-assistant organization, 40 commits to home-assistant")
-- [Jorim Tielemans (@tjorim)](https://github.com/tjorim "31 total commits to the home-assistant organization, 31 commits to home-assistant.io")
+- [Jorim Tielemans (@tjorim)](https://github.com/tjorim "34 total commits to the home-assistant organization, 31 commits to home-assistant.io, 2 commits to hassio-cli, 1 commit to hassio-addons")
- [Jose Juan Montes (@jjmontesl)](https://github.com/jjmontesl "9 total commits to the home-assistant organization, 6 commits to home-assistant, 3 commits to home-assistant.io")
- [Joseph Carter (@iKarith)](https://github.com/iKarith "9 total commits to the home-assistant organization, 9 commits to pi-gen")
- [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")
@@ -507,7 +506,7 @@ This page contains a list of people who have contributed in one way or another t
- [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.io")
+- [Ludovico de Nittis (@RyuzakiKK)](https://github.com/RyuzakiKK "4 total commits to the home-assistant organization, 4 commits to home-assistant.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.io")
- [Lukas Barth (@tinloaf)](https://github.com/tinloaf "37 total commits to the home-assistant organization, 23 commits to home-assistant, 12 commits to home-assistant.io, 2 commits 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")
@@ -520,8 +519,9 @@ This page contains a list of people who have contributed in one way or another t
- [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.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 "32 total commits to the home-assistant organization, 32 commits to home-assistant.io")
- [Mal Curtis (@snikch)](https://github.com/snikch "3 total commits to the home-assistant organization, 3 commits to home-assistant")
-- [Malte Franken (@exxamalte)](https://github.com/exxamalte "16 total commits to the home-assistant organization, 10 commits to home-assistant, 4 commits to home-assistant.io, 1 commit to developers.home-assistant, 1 commit to home-assistant-polymer")
+- [Malte Franken (@exxamalte)](https://github.com/exxamalte "18 total commits to the home-assistant organization, 11 commits to home-assistant, 5 commits to home-assistant.io, 1 commit to home-assistant-polymer, 1 commit to developers.home-assistant")
- [Marc Egli (@frog32)](https://github.com/frog32 "12 total commits to the home-assistant organization, 8 commits to home-assistant, 3 commits to home-assistant.io, 1 commit to hassio-addons-example")
- [Marc Forth (@mf-social)](https://github.com/mf-social "28 total commits to the home-assistant organization, 27 commits to home-assistant.io, 1 commit to fabric-home-assistant")
- [Marc Khouri (@ubnt-marc-khouri)](https://github.com/ubnt-marc-khouri "4 total commits to the home-assistant organization, 2 commits to home-assistant-polymer, 1 commit to hassio-build, 1 commit to developers.home-assistant")
@@ -529,7 +529,7 @@ This page contains a list of people who have contributed in one way or another t
- [Marc Plano\-Lesay (@Kernald)](https://github.com/Kernald "10 total commits to the home-assistant organization, 10 commits to home-assistant.io")
- [Marcel Hoppe (@hobbypunk90)](https://github.com/hobbypunk90 "12 total commits to the home-assistant organization, 6 commits to home-assistant.io, 6 commits to home-assistant")
- [Marcel030nl (@Marcel030nl)](https://github.com/Marcel030nl "5 total commits to the home-assistant organization, 5 commits to home-assistant.io")
-- [Marcelo Moreira de Mello (@tchellomello)](https://github.com/tchellomello "159 total commits to the home-assistant organization, 89 commits to home-assistant, 67 commits to home-assistant.io, 1 commit to home-assistant-assets, 1 commit to hassio-build, 1 commit to home-assistant-polymer")
+- [Marcelo Moreira de Mello (@tchellomello)](https://github.com/tchellomello "159 total commits to the home-assistant organization, 89 commits to home-assistant, 67 commits to home-assistant.io, 1 commit to home-assistant-assets, 1 commit to home-assistant-polymer, 1 commit to hassio-build")
- [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")
@@ -554,6 +554,7 @@ This page contains a list of people who have contributed in one way or another t
- [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.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.io")
- [Mathew Peterson (@mathewpeterson)](https://github.com/mathewpeterson "1 total commits to the home-assistant organization, 1 commit to homebridge-homeassistant")
+- [Matt D (@matt1)](https://github.com/matt1 "1 total commits to the home-assistant organization, 1 commit to hassio-cli")
- [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.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 "90 total commits to the home-assistant organization, 52 commits to homebridge-homeassistant, 21 commits to home-assistant, 12 commits to home-assistant.io, 3 commits to home-assistant-polymer, 2 commits to developers.home-assistant")
@@ -616,12 +617,13 @@ This page contains a list of people who have contributed in one way or another t
- [mountainsandcode (@mountainsandcode)](https://github.com/mountainsandcode "9 total commits to the home-assistant organization, 6 commits to home-assistant.io, 3 commits to home-assistant")
- [mueslo (@mueslo)](https://github.com/mueslo "5 total commits to the home-assistant organization, 5 commits to home-assistant.io")
- [mukundv (@mukundv)](https://github.com/mukundv "3 total commits to the home-assistant organization, 3 commits to home-assistant.io")
+- [mvn23 (@mvn23)](https://github.com/mvn23 "3 total commits to the home-assistant organization, 3 commits to home-assistant")
- [Myles Eftos (@madpilot)](https://github.com/madpilot "1 total commits to the home-assistant organization, 1 commit to appdaemon")
- [Mārtiņš Grunskis (@grunskis)](https://github.com/grunskis "1 total commits to the home-assistant organization, 1 commit to netdisco")
- [Nash Kaminski (@nkaminski)](https://github.com/nkaminski "1 total commits to the home-assistant organization, 1 commit to home-assistant-polymer")
- [Nate Clark (@heythisisnate)](https://github.com/heythisisnate "15 total commits to the home-assistant organization, 10 commits to home-assistant, 5 commits to home-assistant.io")
- [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 "22 total commits to the home-assistant organization, 10 commits to home-assistant, 8 commits to home-assistant.io, 2 commits to homebridge-homeassistant, 1 commit to appdaemon, 1 commit to home-assistant-polymer")
+- [Nathan Henrie (@n8henrie)](https://github.com/n8henrie "22 total commits to the home-assistant organization, 10 commits to home-assistant, 8 commits to home-assistant.io, 2 commits to homebridge-homeassistant, 1 commit to home-assistant-polymer, 1 commit to appdaemon")
- [Nathan Knotts (@nknotts)](https://github.com/nknotts "1 total commits to the home-assistant organization, 1 commit to home-assistant-polymer")
- [Neil Lathwood (@laf)](https://github.com/laf "3 total commits to the home-assistant organization, 3 commits to home-assistant.io")
- [Nelis Willers (@NelisW)](https://github.com/NelisW "1 total commits to the home-assistant organization, 1 commit to fabric-home-assistant")
@@ -630,7 +632,7 @@ This page contains a list of people who have contributed in one way or another t
- [Nicholas Griffin (@nicholasgriffintn)](https://github.com/nicholasgriffintn "6 total commits to the home-assistant organization, 6 commits to home-assistant.io")
- [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.io")
- [Nick Whyte (@nickw444)](https://github.com/nickw444 "3 total commits to the home-assistant organization, 3 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")
+- [Nicko van Someren (@nickovs)](https://github.com/nickovs "4 total commits to the home-assistant organization, 4 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")
- [Niels Mündler (@nielstron)](https://github.com/nielstron "21 total commits to the home-assistant organization, 16 commits to home-assistant, 3 commits to home-assistant.io, 2 commits to netdisco")
@@ -651,15 +653,15 @@ This page contains a list of people who have contributed in one way or another t
- [Oliv3rDog (@Oliv3rDog)](https://github.com/Oliv3rDog "3 total commits to the home-assistant organization, 3 commits to home-assistant.io")
- [Oliver (@scarface-4711)](https://github.com/scarface-4711 "28 total commits to the home-assistant organization, 18 commits to home-assistant, 9 commits to home-assistant.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")
-- [Oncleben31 (@oncleben31)](https://github.com/oncleben31 "4 total commits to the home-assistant organization, 4 commits to home-assistant.io")
+- [Oncleben31 (@oncleben31)](https://github.com/oncleben31 "5 total commits to the home-assistant organization, 5 commits to home-assistant.io")
- [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.io")
- [ottersen (@ottersen)](https://github.com/ottersen "11 total commits to the home-assistant organization, 11 commits to home-assistant.io")
-- [Otto Winter (@OttoWinter)](https://github.com/OttoWinter "70 total commits to the home-assistant organization, 54 commits to home-assistant, 13 commits to home-assistant.io, 3 commits to home-assistant-polymer")
+- [Otto Winter (@OttoWinter)](https://github.com/OttoWinter "74 total commits to the home-assistant organization, 58 commits to home-assistant, 13 commits to home-assistant.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.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 "3731 total commits to the home-assistant organization, 1314 commits to hassio, 676 commits to hassos, 479 commits to home-assistant, 465 commits to hassio-build, 371 commits to hassio-addons, 332 commits to home-assistant.io, 34 commits to hassio-homeassistant, 20 commits to developers.home-assistant, 17 commits to hassio-addons-example, 12 commits to hassio-cli, 7 commits to hassio-base, 2 commits to home-assistant-polymer, 1 commit to netdisco, 1 commit to home-assistant-js-websocket")
+- [Pascal Vizeli (@pvizeli)](https://github.com/pvizeli "3760 total commits to the home-assistant organization, 1321 commits to hassio, 677 commits to hassos, 479 commits to home-assistant, 467 commits to hassio-build, 373 commits to hassio-addons, 333 commits to home-assistant.io, 34 commits to hassio-homeassistant, 23 commits to developers.home-assistant, 20 commits to hassio-cli, 17 commits to hassio-addons-example, 9 commits to hassio-base, 3 commits to hassio-addons-development, 2 commits to home-assistant-polymer, 1 commit to netdisco, 1 commit to home-assistant-js-websocket")
- [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.io")
- [Patrick Easters (@patrickeasters)](https://github.com/patrickeasters "5 total commits to the home-assistant organization, 5 commits to home-assistant.io")
@@ -703,7 +705,7 @@ This page contains a list of people who have contributed in one way or another t
- [quthla (@quthla)](https://github.com/quthla "13 total commits to the home-assistant organization, 5 commits to home-assistant-polymer, 4 commits to home-assistant-iOS, 4 commits to home-assistant")
- [rafale77 (@rafale77)](https://github.com/rafale77 "4 total commits to the home-assistant organization, 4 commits to home-assistant.io")
- [Raiford (@raiford)](https://github.com/raiford "1 total commits to the home-assistant organization, 1 commit to hassio-addons")
-- [randellhodges (@randellhodges)](https://github.com/randellhodges "3 total commits to the home-assistant organization, 3 commits to home-assistant-polymer")
+- [randellhodges (@randellhodges)](https://github.com/randellhodges "6 total commits to the home-assistant organization, 3 commits to home-assistant-polymer, 3 commits to home-assistant")
- [rbflurry (@rbflurry)](https://github.com/rbflurry "17 total commits to the home-assistant organization, 14 commits to home-assistant.io, 3 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")
@@ -723,15 +725,15 @@ This page contains a list of people who have contributed in one way or another t
- [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.io")
- [Rob Slifka (@rslifka)](https://github.com/rslifka "5 total commits to the home-assistant organization, 5 commits to home-assistant.io")
-- [Robbie Trencheny (@robbiet480)](https://github.com/robbiet480 "1430 total commits to the home-assistant organization, 752 commits to home-assistant-iOS, 260 commits to home-assistant, 249 commits to home-assistant.io, 93 commits to homebridge-homeassistant, 15 commits to home-assistant-polymer, 14 commits to hubot-home-assistant, 8 commits to Analytics-Receiver, 6 commits to netdisco, 3 commits to organization, 3 commits to scenegen, 3 commits to appdaemon, 3 commits to home-assistant-js-websocket, 3 commits to hassbot, 3 commits to home-assistant-js, 3 commits to hadashboard, 2 commits to fabric-home-assistant, 2 commits to LabelBot, 2 commits to home-assistant-assets, 2 commits to micropython-home-assistant, 2 commits to lambda-home-assistant-github, 2 commits to home-assistant-notebooks")
+- [Robbie Trencheny (@robbiet480)](https://github.com/robbiet480 "1432 total commits to the home-assistant organization, 754 commits to home-assistant-iOS, 260 commits to home-assistant, 249 commits to home-assistant.io, 93 commits to homebridge-homeassistant, 15 commits to home-assistant-polymer, 14 commits to hubot-home-assistant, 8 commits to Analytics-Receiver, 6 commits to netdisco, 3 commits to scenegen, 3 commits to hadashboard, 3 commits to home-assistant-js, 3 commits to hassbot, 3 commits to appdaemon, 3 commits to organization, 3 commits to home-assistant-js-websocket, 2 commits to home-assistant-notebooks, 2 commits to LabelBot, 2 commits to fabric-home-assistant, 2 commits to micropython-home-assistant, 2 commits to lambda-home-assistant-github, 2 commits to home-assistant-assets")
- [Robert (@metbril)](https://github.com/metbril "8 total commits to the home-assistant organization, 8 commits to home-assistant.io")
- [Robert Accettura (@raccettura)](https://github.com/raccettura "1 total commits to the home-assistant organization, 1 commit to home-assistant-polymer")
- [Robert Schütz (@dotlambda)](https://github.com/dotlambda "3 total commits to the home-assistant organization, 2 commits to netdisco, 1 commit to appdaemon")
-- [Robert Svensson (@Kane610)](https://github.com/Kane610 "78 total commits to the home-assistant organization, 53 commits to home-assistant, 22 commits to home-assistant.io, 1 commit to netdisco, 1 commit to developers.home-assistant, 1 commit to home-assistant-polymer")
+- [Robert Svensson (@Kane610)](https://github.com/Kane610 "80 total commits to the home-assistant organization, 53 commits to home-assistant, 24 commits to home-assistant.io, 1 commit to netdisco, 1 commit to home-assistant-polymer, 1 commit to developers.home-assistant")
- [Robin (@robmarkcole)](https://github.com/robmarkcole "57 total commits to the home-assistant organization, 35 commits to home-assistant.io, 19 commits to home-assistant, 2 commits to home-assistant-assets, 1 commit to hassos")
- [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.io")
-- [Rohan Kapoor (@rohankapoorcom)](https://github.com/rohankapoorcom "6 total commits to the home-assistant organization, 6 commits to home-assistant")
+- [Rohan Kapoor (@rohankapoorcom)](https://github.com/rohankapoorcom "8 total commits to the home-assistant organization, 8 commits to home-assistant")
- [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")
- [Rolf Schäuble (@rschaeuble)](https://github.com/rschaeuble "1 total commits to the home-assistant organization, 1 commit to appdaemon")
@@ -739,7 +741,7 @@ This page contains a list of people who have contributed in one way or another t
- [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")
-- [rpitera (@rpitera)](https://github.com/rpitera "5 total commits to the home-assistant organization, 5 commits to home-assistant.io")
+- [rpitera (@rpitera)](https://github.com/rpitera "6 total commits to the home-assistant organization, 6 commits to home-assistant.io")
- [Rubens Panfili (@rpanfili)](https://github.com/rpanfili "1 total commits to the home-assistant organization, 1 commit to hassio-addons")
- [rubund (@rubund)](https://github.com/rubund "4 total commits to the home-assistant organization, 4 commits to home-assistant")
- [ruohan\.chen (@crhan)](https://github.com/crhan "3 total commits to the home-assistant organization, 3 commits to home-assistant")
@@ -752,14 +754,15 @@ This page contains a list of people who have contributed in one way or another t
- [Ryan Jarvis (@Cabalist)](https://github.com/Cabalist "1 total commits to the home-assistant organization, 1 commit to hassbian-scripts")
- [Ryan Kladar (@Kladar)](https://github.com/Kladar "1 total commits to the home-assistant organization, 1 commit to hassos")
- [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.io, 14 commits to home-assistant-polymer, 1 commit to home-assistant-notebooks")
-- [Ryan McLean (@ryanm101)](https://github.com/ryanm101 "97 total commits to the home-assistant organization, 75 commits to hassio-cli, 16 commits to home-assistant, 6 commits to home-assistant.io")
+- [Ryan McLean (@ryanm101)](https://github.com/ryanm101 "99 total commits to the home-assistant organization, 77 commits to hassio-cli, 16 commits to home-assistant, 6 commits to home-assistant.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")
- [Sacha Telgenhof (@stelgenhof)](https://github.com/stelgenhof "3 total commits to the home-assistant organization, 3 commits to home-assistant.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 "42 total commits to the home-assistant organization, 38 commits to home-assistant, 4 commits to home-assistant.io")
+- [sander76 (@sander76)](https://github.com/sander76 "43 total commits to the home-assistant organization, 39 commits to home-assistant, 4 commits to home-assistant.io")
- [sbYm (@GongT)](https://github.com/GongT "1 total commits to the home-assistant organization, 1 commit to home-assistant-polymer")
+- [schumpeter2 (@schumpeter2)](https://github.com/schumpeter2 "1 total commits to the home-assistant organization, 1 commit to home-assistant-polymer")
- [Scott (@lostage)](https://github.com/lostage "1 total commits to the home-assistant organization, 1 commit to developers.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.io")
@@ -801,14 +804,13 @@ This page contains a list of people who have contributed in one way or another t
- [Steven Looman (@StevenLooman)](https://github.com/StevenLooman "10 total commits to the home-assistant organization, 7 commits to home-assistant, 3 commits to netdisco")
- [Stu Gott (@stu-gott)](https://github.com/stu-gott "9 total commits to the home-assistant organization, 5 commits to home-assistant.io, 4 commits to home-assistant")
- [Stuart Williams (@stuwil)](https://github.com/stuwil "1 total commits to the home-assistant organization, 1 commit to netdisco")
-- [Suresh Kalavala (@skalavala)](https://github.com/skalavala "32 total commits to the home-assistant organization, 32 commits to home-assistant.io")
- [Sven\-Hendrik Haase (@svenstaro)](https://github.com/svenstaro "3 total commits to the home-assistant organization, 3 commits to home-assistant.io")
- [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.io")
- [Sytone (@sytone)](https://github.com/sytone "8 total commits to the home-assistant organization, 6 commits to home-assistant.io, 1 commit to hassio-build, 1 commit to developers.home-assistant")
- [Sören Oldag (@soldag)](https://github.com/soldag "16 total commits to the home-assistant organization, 8 commits to home-assistant, 8 commits to home-assistant.io")
- [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 "6 total commits to the home-assistant organization, 6 commits to home-assistant")
+- [tadly (@tadly)](https://github.com/tadly "7 total commits to the home-assistant organization, 7 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.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.io, 1 commit to home-assistant-js")
@@ -822,7 +824,7 @@ This page contains a list of people who have contributed in one way or another t
- [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")
- [thelittlefireman (@thelittlefireman)](https://github.com/thelittlefireman "3 total commits to the home-assistant organization, 3 commits to home-assistant")
-- [themanieldaniel (@themanieldaniel)](https://github.com/themanieldaniel "13 total commits to the home-assistant organization, 13 commits to home-assistant.io")
+- [themanieldaniel (@themanieldaniel)](https://github.com/themanieldaniel "14 total commits to the home-assistant organization, 14 commits to home-assistant.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 "4 total commits to the home-assistant organization, 4 commits to home-assistant")
- [Thibault Cohen (@titilambert)](https://github.com/titilambert "53 total commits to the home-assistant organization, 39 commits to home-assistant, 13 commits to home-assistant.io, 1 commit to home-assistant-polymer")
@@ -834,6 +836,7 @@ This page contains a list of people who have contributed in one way or another t
- [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")
+- [Thomas Redmer (@Skorfulose)](https://github.com/Skorfulose "1 total commits to the home-assistant organization, 1 commit to hassio-cli")
- [thrawnarn (@thrawnarn)](https://github.com/thrawnarn "10 total commits to the home-assistant organization, 5 commits to home-assistant, 4 commits to home-assistant.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.io")
- [tijuca (@tijuca)](https://github.com/tijuca "106 total commits to the home-assistant organization, 106 commits to libcoap")
@@ -852,7 +855,7 @@ This page contains a list of people who have contributed in one way or another t
- [Tom (@Qu3uk)](https://github.com/Qu3uk "4 total commits to the home-assistant organization, 4 commits to home-assistant.io")
- [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.io, 6 commits to home-assistant-polymer, 2 commits to netdisco")
-- [Tom Harris (@teharris1)](https://github.com/teharris1 "27 total commits to the home-assistant organization, 18 commits to home-assistant, 9 commits to home-assistant.io")
+- [Tom Harris (@teharris1)](https://github.com/teharris1 "28 total commits to the home-assistant organization, 18 commits to home-assistant, 10 commits to home-assistant.io")
- [Tom Hoover (@tomhoover)](https://github.com/tomhoover "3 total commits to the home-assistant organization, 3 commits to home-assistant.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.io")
- [Tom Usher (@tomusher)](https://github.com/tomusher "1 total commits to the home-assistant organization, 1 commit to netdisco")
@@ -873,6 +876,7 @@ This page contains a list of people who have contributed in one way or another t
- [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 "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.io")
+- [ultratoto14 (@ultratoto14)](https://github.com/ultratoto14 "1 total commits to the home-assistant organization, 1 commit to netdisco")
- [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")
- [User5981 (@User5981)](https://github.com/User5981 "1 total commits to the home-assistant organization, 1 commit to home-assistant-polymer")
@@ -881,7 +885,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 "11 total commits to the home-assistant organization, 7 commits to home-assistant, 4 commits to home-assistant.io")
-- [Ville Skyttä (@scop)](https://github.com/scop "106 total commits to the home-assistant organization, 70 commits to home-assistant, 11 commits to netdisco, 11 commits to home-assistant.io, 4 commits to hassio-addons, 3 commits to hassio-cli, 2 commits to hassio-build, 2 commits to developers.home-assistant, 2 commits to home-assistant-polymer, 1 commit to hassio")
+- [Ville Skyttä (@scop)](https://github.com/scop "109 total commits to the home-assistant organization, 71 commits to home-assistant, 13 commits to home-assistant.io, 11 commits to netdisco, 4 commits to hassio-addons, 3 commits to hassio-cli, 2 commits to home-assistant-polymer, 2 commits to hassio-build, 2 commits to developers.home-assistant, 1 commit to hassio")
- [Villányi Bálint (@villanyibalint)](https://github.com/villanyibalint "1 total commits to the home-assistant organization, 1 commit to home-assistant-polymer")
- [Vincent Van Den Berghe (@vandenberghev)](https://github.com/vandenberghev "3 total commits to the home-assistant organization, 3 commits to home-assistant")
- [viswa-swami (@viswa-swami)](https://github.com/viswa-swami "9 total commits to the home-assistant organization, 9 commits to home-assistant")
@@ -918,4 +922,4 @@ This page contains a list of people who have contributed in one way or another t
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 Friday, September 21st 2018, 7:49:45 pm UTC.
+This page was last updated Friday, September 28th 2018, 8:02:13 pm UTC.
diff --git a/source/getting-started/use.markdown b/source/getting-started/use.markdown
index 1b6da436ab7..941d78e02df 100644
--- a/source/getting-started/use.markdown
+++ b/source/getting-started/use.markdown
@@ -11,7 +11,9 @@ footer: true
If you are using Hassbian, browse to [http://hassbian.local:8123](http://hassbian.local:8123) to open the Home Assistant frontend.
-To reload your configuration, go to **Configuration** in your side panel, and choose "CHECK CONFIG" and "RELOAD CORE":
+To reload your configuration, go to **Configuration** in your side panel and choose "CHECK CONFIG".
+
+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.
diff --git a/source/images/blog/2018-09-hacktoberfest/hacktoberfest-2018.png b/source/images/blog/2018-09-hacktoberfest/hacktoberfest-2018.png
new file mode 100644
index 00000000000..dfa20a16e4f
Binary files /dev/null and b/source/images/blog/2018-09-hacktoberfest/hacktoberfest-2018.png differ
diff --git a/source/images/screenshots/configuration-validation.png b/source/images/screenshots/configuration-validation.png
index eb68b660183..ba6022b9006 100644
Binary files a/source/images/screenshots/configuration-validation.png and b/source/images/screenshots/configuration-validation.png differ
diff --git a/source/lovelace/index.markdown b/source/lovelace/index.markdown
index 0588126e2df..848cfeef188 100644
--- a/source/lovelace/index.markdown
+++ b/source/lovelace/index.markdown
@@ -116,7 +116,7 @@ views:
Now restart Home Assistant, navigate to `