Merge branch 'current' into next

_config.yml

@@ -142,8 +142,8 @@ social:
 # Home Assistant release details
 current_major_version: 0
 current_minor_version: 84
-current_patch_version: 3
-date_released: 2018-12-17
+current_patch_version: 6
+date_released: 2018-12-21
 
 # Either # or the anchor link to latest release notes in the blog post.
 # Must be prefixed with a # and have double quotes around it.

sass/custom/_paulus.scss

@@ -458,7 +458,7 @@ a code {
   color: $primary-color;
 }
 
-twitterwidget {
+twitter-widget {
   margin-left: auto;
   margin-right: auto;
 }

source/_components/binary_sensor.ihc.markdown

@@ -29,7 +29,7 @@ be found in the IHC project and setup as binary sensors:
 
 ## {% linkable_title Manual configuration %}
 
-To manually configure IHC Binary Sensors insert the "binary_sensors" section in your IHC configuration:
+To manually configure IHC Binary Sensors insert the "binary_sensor" section in your IHC configuration:
 
 ```yaml
 # Example configuration.yaml entry
@@ -38,7 +38,7 @@ ihc:
     username: YOUR_USERNAME
     password: YOUR_PASSWORD
     info: true
-    binary_sensors:
+    binary_sensor:
       - id: 12345
         name: switch_front_door
         inverting: false
@@ -48,7 +48,7 @@ ihc:
 ```
 
 {% configuration %}
-binary_sensors:
+binary_sensor:
   description: List of binary sensors to setup manually.
   required: false
   type: map

source/_components/camera.mjpeg.markdown

@@ -72,3 +72,15 @@ camera:
     still_image_url: http://IP/image.jpg
     mjpeg_url: http://IP/video/mjpg.cgi
 ```
+
+Example of integrating Blue Iris Cameras from a Blue Iris server.
+
+```yaml
+camera:
+  - platform: mjpeg
+    name: Livingroom Camera
+    mjpeg_url: http://IP:PORT/mjpg/CAMERASHORTNAME/video.mjpeg
+    username: BLUE_IRIS_USERNAME
+    password: BLUE_IRIS_PASSWORD
+    authentication: basic
+```

source/_components/camera.onvif.markdown

@@ -34,14 +34,17 @@ name:
   description: Override the name of your camera.
   required: false
   type: string
+  default: ONVIF Camera
 username:
   description: The username for the camera.
   required: false
   type: string
+  default: admin
 password:
   description: The password for the camera.
   required: false
   type: string
+  default: 888888
 port:
   description: The port for the camera.
   required: false
@@ -56,6 +59,7 @@ extra_arguments:
   description: "Extra options to pass to `ffmpeg`, e.g., image quality or video filter options. More details in [`ffmpeg` component](/components/ffmpeg)."
   required: false
   type: string
+  default: -q:v 2
 {% endconfiguration %}
 
 Most of the ONVIF cameras support more than one audio/video profile. Each profile provides different image quality. Usually, the first profile has the highest quality and it is the profile used by default. However, you may want to use a lower quality image. One of the reasons may be that your hardware isn't able to render the highest quality image in real-time, especially when running on Raspberry Pi. Therefore you can choose which profile do you want to use by setting in config `profile` variable.

source/_components/climate.honeywell.markdown

@@ -16,13 +16,7 @@ ha_iot_class: "Cloud Polling"
 
 The `honeywell` climate platform let you control Honeywell Connected thermostats from Home Assistant.
 
-<p class='note'>
-This platform is actually a hybrid combination of two distinct climate systems based upon either [somecomfort](https://github.com/kk7ds/somecomfort) (for US-based systems), or [evohome-client](https://github.com/watchforstock/evohome-client) (for international/EU systems) - see the `region` parameter, below. Before you proceed, please be clear which client library is appropriate to your system.
-</p>
-
-Although both regions remain supported here, the `evohome-client`-based systems have a new [component](/components/evohome/) available that may suit your needs better.
-
-To set up this climate platform, add the following information to your `configuration.yaml` file:
+To set it up, add the following information to your `configuration.yaml` file:
 
 ```yaml
 climate:

source/_components/climate.knx.markdown

@@ -47,6 +47,25 @@ climate:
     operation_mode_comfort_address: '5/1/7'
 ```
 
+If you want to overwrite the supported operation modes use:
+
+```yaml
+# Example configuration.yaml entry
+climate:
+  - platform: knx
+    name: HASS-Kitchen.Temperature
+    temperature_address: '5/1/1'
+    setpoint_shift_address: '5/1/2'
+    setpoint_shift_state_address: '5/1/3'
+    target_temperature_address: '5/1/4'
+    operation_mode_frost_protection_address: '5/1/5'
+    operation_mode_comfort_address: '5/1/7'
+    override_supported_operation_modes:
+      - "Night"
+      - "Standby"
+      - "Comfort"
+```
+
 {% configuration %}
 name:
   description: A name for this device used within Home Assistant.
@@ -112,6 +131,41 @@ operation_mode_comfort_address:
   description: KNX address for switching on/off comfort mode.
   required: false
   type: string
+override_supported_operation_modes:
+  description: Defines the supported operation modes.
+  required: false
+  type: array
+on_off_address:
+  description: KNX address for switching the device on/off.
+  required: false
+  type: string
+on_off_state_address:
+  description: Explicit KNX address for reading the current on/off status.
+  required: false
+  type: string
 {% endconfiguration %}
 
 `operation_mode_frost_protection_address` / `operation_mode_night_address` / `operation_mode_comfort_address` are not necessary if `operation_mode_address` is specified.
+
+`override_supported_operation_modes` is an array that can contain any of the following values:
+
+- Auto
+- Comfort
+- Standby
+- Night
+- Frost Protection
+- Heat
+- Morning Warmup
+- Cool
+- Night Purge
+- Precool
+- Off
+- Test
+- Emergency Heat
+- Fan only
+- Ice
+- Dry
+- NoDem
+
+Also check [this](https://github.com/XKNX/xknx/blob/master/xknx/knx/dpt_hvac_mode.py#L13-L30) page for more information.
+

source/_components/discovery.markdown

@@ -85,6 +85,7 @@ Valid values for ignore are:
  * `ikea_tradfri`: IKEA Trådfri (Tradfri)
  * `logitech_mediaserver`: Logitech media server (Squeezebox)
  * `netgear_router`: Netgear routers
+ * `octoprint`: Octoprint
  * `openhome`: Linn / Openhome
  * `panasonic_viera`: Panasonic Viera
  * `philips_hue`: Philips Hue

source/_components/fritzbox.markdown

@@ -20,7 +20,7 @@ The [AVM](https://en.avm.de) Fritzbox component for Home Assistant allows you to
 - [FRITZ!Box 6490 Cable](https://en.avm.de/products/fritzbox/fritzbox-6490-cable/)
 - [FRITZ!Box 7590](https://en.avm.de/products/fritzbox/fritzbox-7590/)
 - [FRITZ!DECT 200](https://en.avm.de/products/fritzdect/fritzdect-200/)
-- [Eurotronic Comet DECT](https://www.eurotronic.org/en/products/comet-dect.html)
+- [Eurotronic Comet DECT](https://eurotronic.org/produkte/elektronische-heizkoerperthermostate/sparmatic-comet/)
 
 
 ## {% linkable_title Setup %}

source/_components/geo_location.usgs_earthquakes_feed.markdown

@@ -52,7 +52,7 @@ radius:
   description: The distance in kilometers around Home Assistant's coordinates in which seismic events are included.
   required: false
   type: float
-  default: 50km
+  default: 50
 latitude:
   description: Latitude of the coordinates around which events are considered.
   required: false
@@ -107,3 +107,17 @@ The following state attributes are available for each entity in addition to the
 | updated            | Date and time when this event was most recently updated. |
 | status             | Indicates whether the event has been reviewed by a human: "automatic", "reviewed", "deleted" |
 | type               | Type of seismic event: "earthquake" or "quarry". |
+
+
+## {% linkable_title Full Configuration %}
+
+```yaml
+# Example configuration.yaml entry
+geo_location:
+  - platform: usgs_earthquakes_feed
+    feed_type: 'past_month_all_earthquakes'
+    radius: 50
+    minimum_magnitude: 0.0
+    latitude: 35.899722
+    longitude: -120.432778
+```

source/_components/homematic.markdown

@@ -10,6 +10,7 @@ footer: true
 logo: homematic.png
 ha_category: Hub
 ha_iot_class: "Local Push"
+ha_release: 0.23
 featured: false
 ---
 
@@ -92,7 +93,7 @@ jsonport:
   required: false
   type: integer
 username:
-  description: When fetching names via JSON-RPC, you need to specify a user with guest-access to the CCU.
+  description: When fetching names via JSON-RPC, you need to specify a user with guest-access to the CCU. Admin-access is required if you work with variables on the CCU.
   required: false
   type: string
 password:
@@ -161,7 +162,7 @@ homematic:
 We use three approaches to fetch the names of devices. Each assumes you have properly named your devices in your existing Homematic setup. As a general advice: Use ASCII for your devices names. Home Assistant won't include non-ASCII characters in entity-names.
 
 1. `json`: The CCU allows to fetch details of the paired devices via JSON-RPC. For this to work you need to add valid credentials to your component-configuration. Guest-access is sufficient to query for device names.
-2. `xml`: If you use a CCU, there is an add-on called the "XML-API". With it installed, you are able to fetch all kinds of information from you CCU using XML-RPC. We can leverage this and fetch the names of devices set within the CCU. We don't support authentication with this method.
+2. `xml`: If you use a CCU, there is an add-on called the "XML-API". With it installed, you are able to fetch all kinds of information from you CCU using XML-RPC. We can leverage this and fetch the names of devices set within the CCU. We don't support authentication with this method. The `json` method should be preferred over `xml`. Support for the XML-API is only available for downwards compatibility and may be disabled in a future release.
 3. `metadata`: Homegear provides device-names through the metadata devices internally have. When using an HM-CFG-LAN interface, you typically use a configuration software ("HomeMatic-Komponenten konfigurieren" is the name of the shortcut on your desktop by default) to pair and configure your devices. If you have paired devices, you'll see them listed in a table. The leftmost column (Name) is prefilled with default names. You can click such a name and enter whatever you like.
 
 Resolving names can take some time. So when you start Home Assistant you won't see you devices at first. For a setup with 20+ devices it can take up to a minute until all devices show up in the UI.
@@ -188,7 +189,7 @@ sensor:
 
 ### {% linkable_title Variables %}
 
-It is possible to read and set values of system variables you have setup on the CCU/Homegear. The supported types for setting values are float- and bool-variables.
+It is possible to read and set values of system variables you have setup on the CCU/Homegear. The supported types for setting values are float- and bool-variables. With the CCU a user with Admin-access is required.
 The states of the variables are available through the attributes of your hub entity (e.g., `homematic.ccu2`). Use templates (as mentioned above) to make your variables available to automations or as entities.
 The values of variables are polled from the CCU/Homegear in an interval of 30 seconds. Setting the value of a variable happens instantly and is directly pushed.
 

source/_components/http.markdown

@@ -137,7 +137,7 @@ terminology used around Home Assistant. Home Assistant's
 ## {% linkable_title HTTP sensors %}
 
 To use those kind of [sensors](/components/sensor.http/) or
-[binary sensors](components/binary_sensor.http/) in your installation no
+[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.

source/_components/lifx.markdown

@@ -82,7 +82,7 @@ Run a flash effect by changing to a color and then back.
 | `brightness` | Integer between 0 and 255 for how bright the color should be.
 | `period` | The duration of a single pulse (in seconds).
 | `cycles` | The total number of pulses.
-| `mode` | The way to change between colors. Valid modes: `blink` (default - direct transition to new color for 'period' time with original color between cycles), `breathe` (color fade transition to new color and back to original), `ping` (short pulse of new color), `strobe` (ligth turns off between color changes), `solid`(light does not return to original color beween cycles).
+| `mode` | The way to change between colors. Valid modes: `blink` (default - direct transition to new color for 'period' time with original color between cycles), `breathe` (color fade transition to new color and back to original), `ping` (short pulse of new color), `strobe` (light turns off between color changes), `solid`(light does not return to original color between cycles).
 | `power_on` | Set this to False to skip the effect on lights that are turned off (defaults to True).
 
 ### {% linkable_title Service `light.lifx_effect_colorloop` %}

source/_components/light.ihc.markdown

@@ -27,7 +27,7 @@ project and setup as light devices:
 - Wireless mobile dimmer
 - Dataline lamp outlet
 
-To manually configure IHC lights insert the "lights" section in 
+To manually configure IHC lights insert the "light" section in 
 your IHC configuration:
 
 ```yaml
@@ -36,14 +36,14 @@ ihc:
     username: YOUR_USERNAME2
     password: YOUR_PASSWORD2
     info: true 
-    lights:
+    light:
       - id: 12345
         name: tablelight
       - id: 23432
 ```
 
 {% configuration %}
-lights:
+light:
   description: List of lights to setup manually
   required: false
   type: map

source/_components/light.mqtt.markdown

@@ -182,6 +182,11 @@ white_value_command_topic:
   description: "The MQTT topic to publish commands to change the light's white value."
   required: false
   type: string
+white_value_scale:
+  description: "Defines the maximum white value (i.e. 100%) of the MQTT device."
+  required: false
+  type: integer
+  default: 255
 white_value_state_topic:
   description: The MQTT topic subscribed to receive white value updates.
   required: false
@@ -712,7 +717,7 @@ For a JSON payload with the format `{"state": "on", "brightness": 255, "color":
 ```yaml
 # Example configuration.yaml entry
 light:
-  - platform: mqtt_template
+  - platform: mqtt
     schema: template
     effect_list:
       - rainbow

source/_components/media_player.plex.markdown

@@ -15,7 +15,7 @@ ha_iot_class: "Local Polling"
 ---
 
 
-The `plex` platform allows you to connect a [Plex Media Server](https://plex.tv) to Home Assistant. It will allow you to control media playback and see the current playing item.
+The `plex` platform allows you to connect to a [Plex Media Server](https://plex.tv). Once connected, [Plex Clients](https://www.plex.tv/apps-devices/) playing media from the connected Plex Media Server will show up as [Media Players](https://www.home-assistant.io/components/media_player/) in Home Assistant. It will allow you to control media playback and see the current playing item.
 
 ## {% linkable_title Setup %}
 

source/_components/proximity.markdown

@@ -33,6 +33,11 @@ The Proximity entity which is created has the following values:
   - 'unknown'
   - 'stationary'
 - `dist_to_zone`: Distance from the monitored zone (in km)
+- `unit_of_measurement`: Measurement of distance. Values are:
+  - 'km'
+  - 'm'
+  - 'mi'
+  - 'ft'
 
 To enable this component in your installation, add the following to your `configuration.yaml` file:
 

source/_components/recorder.markdown

@@ -142,8 +142,8 @@ Purging does not necessarily remove all entries before a given date. For example
 | SQLite          | `sqlite:////PATH/TO/DB_NAME`                             |
 | MariaDB         | `mysql+pymysql://SERVER_IP/DB_NAME?charset=utf8`                 |
 | MariaDB         | `mysql+pymysql://user:password@SERVER_IP/DB_NAME?charset=utf8`   |
-| MySQL           | `mysql+pymysql://SERVER_IP/DB_NAME?charset=utf8`         |
-| MySQL           | `mysql+pymysql://user:password@SERVER_IP/DB_NAME?charset=utf8` |
+| MySQL           | `mysql://SERVER_IP/DB_NAME?charset=utf8`         |
+| MySQL           | `mysql://user:password@SERVER_IP/DB_NAME?charset=utf8` |
 | PostgreSQL      | `postgresql://SERVER_IP/DB_NAME`                         |
 | PostgreSQL      | `postgresql://user:password@SERVER_IP/DB_NAME`             |
 | PostgreSQL (Socket)     | `postgresql://@/DB_NAME`                         |

source/_components/sensor.dwd_weather_warnings.markdown

@@ -59,7 +59,7 @@ name:
 | `region_id` | Region ID assigned by DWD. |
 | `warning_count` | *(int)* Number of issued warnings. There can be more than one warning issued at once. |
 | `warning_<x>_level` | *(int)* Issued warning level between 0 and 4. <br/>0 == Keine Warnungen, <br/>1 ==  Wetterwarnungen, <br/>2 == Warnungen vor markantem Wetter, <br/>3 == Unwetterwarnungen, <br/>4 == Warnungen vor extremem Unwetter |
-| `warning_<x>_type` | *(int)* Issued warning type. <br/>0 == ?, <br/>1 ==  ?, <br/>2 ==  ?, <br/>3 ==  ?, <br/>4 ==  ?,<br/>5 ==  Frost, <br/>6 == Glätte |
+| `warning_<x>_type` | *(int)* Issued warning type. <br/>0 == ?, <br/>1 == Windböen, <br/>2 ==  ?, <br/>3 ==  Schneefall, <br/>4 ==  Nebel,<br/>5 ==  Frost, <br/>6 == Glätte or Glatteis<br/>Please be aware that the type numbers represent more like a category than an exact number-to-string match. For example Type `6` can mean `GLÄTTE` or `GLATTEIS` or similar. |
 | `warning_<x>_name` | This name correlates with the warning type and indicates it in short as a string. |
 | `warning_<x>_headline` | Official headline the weather warning. |
 | `warning_<x>_start` | Starting time and date of the issued warning. |

source/_components/sensor.ihc.markdown

@@ -23,7 +23,7 @@ project and setup as 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 the "sensors"
+To manually configure IHC sensors insert the "sensor"
 section in your IHC configuration:
 
 ```yaml
@@ -32,7 +32,7 @@ ihc:
     username: YOUR_USERNAME2
     password: YOUR_PASSWORD2
     info: true 
-    sensors:
+    sensor:
       - id: 12345
         name: Temperatur_living_room
         unit_of_measurement: '°C'
@@ -43,7 +43,7 @@ ihc:
 ```
 
 {% configuration %}
-sensors:
+sensor:
   description: List of sensors to setup manually.
   required: false
   type: map

source/_components/sensor.ruter.markdown

@@ -13,6 +13,11 @@ ha_iot_class: "Cloud Polling"
 ha_release: 0.83
 ---
 
+<p class='note warning'>
+The API used for this sensor is shutting down soon, you should consider starting to use the [`entur_public_transport`](https://www.home-assistant.io/components/sensor.entur_public_transport/) sensor before that happen.
+To read the deprecation warning visit [ruter.no/labs](https://ruter.no/labs/),
+</p>
+
 The `ruter` sensor will provide you departure information for the larger Oslo area in Norway from the [Ruter][ruter] public transportation service.
 
 This platform is using the [Ruter reisapi API][ruter-api] to gather the information.