The Home Assistant Cloud is currently in open beta and will become part of the upcoming Community Support Package. [Learn more](/blog/2017/12/17/introducing-home-assistant-cloud/)
+
+The Home Assistant Cloud allows you to quickly integrate your local Home Assistant with various cloud services like Amazon Alexa.
+
+The following integrations are currently available:
+
+ - [Amazon Alexa (Amazon Echo)](/components/cloud.alexa/)
+
+
+
+### {% linkable_title How does it work? %}
+
+The Home Assistant Cloud has been designed with security in mind. When you activate the Cloud component, your instance will create a secure connection to the Home Assistant Cloud. There is no need for any further configuration or to expose your instance to the internet.
+
+Integrations like Alexa will deliver messages to our cloud which we will forward to your local instance for processing. We just forward the response back to Alexa. This means that we do not have to store the state of your house in our cloud, we’re just the messenger!
+
+You can find a list of frequently asked questions (and their answers) in [this blog post](/blog/2017/12/17/introducing-home-assistant-cloud/#faq).
+
+### {% linkable_title Enabling the cloud %}
+
+The Home Assistant Cloud is enabled by default. If not, add this to your configuration:
```yaml
# Example configuration.yaml entry to enable the cloud component
cloud:
```
-Once activated, go to the configuration panel in Home Assistant and create an account and log in. There is no need to configure your router or expose your instance to the internet in any other way.
-
-If you are not seeing the **Configuration** panel, make sure you have the following option enabled in your configuration.yaml` file.
+Once activated, go to the configuration panel in Home Assistant and create an account and log in. If you are not seeing the **Configuration** panel, make sure you have the following option enabled in your configuration.yaml` file.
```yaml
config:
```
-
-### {% linkable_title Amazon Alexa %}
-
-The Alexa integration allows users to control the entities via the [Home Assistant Smart Home skill for Alexa][alexa skill]. This means that you can say things like "Alexa, turn on the kitchen light" to control your local instance.
-
-```yaml
-# Example configuration.yaml entry configuring Alexa
-cloud:
- alexa:
- filter:
- include_entities:
- - light.kitchen
- include_domains:
- - switch
- exclude_entities:
- - light.living_room
- exclude_domains:
- - script
-```
-
-{% configuration %}
-alexa:
- description: Configuration options for the Amazon Alexa integration.
- required: false
- type: map
- keys:
- filter:
- description: Filters for entities to include/exclude from Alexa.
- required: false
- type: map
- keys:
- include_entities:
- description: Entity IDs to include.
- required: false
- type: list
- include_domains:
- description: Domains to include.
- required: false
- type: list
- exclude_entities:
- description: Entity IDs to exclude.
- required: false
- type: list
- exclude_domains:
- description: Domains to exclude.
- required: false
- type: list
-{% endconfiguration %}
-
-### {% linkable_title Possible values for customize %}
-
-| Attribute | Description |
-| --------- | ----------- |
-| `alexa_hidden` | Hide the entity from the Alexa smart home devices.
-| `alexa_name` | Defines name of the entity for a Alexa smart home device. Useful if you have an entity with a friendly name in a local language that you want to access using an English sounding name.
-| `alexa_description` | The description of the device in the Alexa smart home device list.
-| `alexa_display_categories` | Set displayCategories, useful for things like media_player (TV/SPEAKERS) or scene (ACTIVITY_TRIGGER/SCENE_TRIGGER). More info can be found [here](https://developer.amazon.com/docs/device-apis/alexa-discovery.html#display-categories).
-
-### {% linkable_title Available domains %}
-Currently, the following domains are available to be used with Alexa:
-- alert
-- automation (enables/disables)
-- cover
-- fan (supports on/off and set speed)
-- group
-- input_boolean
-- light
-- lock (lock and unlock, but unlock is untested as Amazon has disabled unlock for now)
-- media_player (play, pause, stop, set volume, adjust volume, next track and previous track)
-- scene
-- script (enables/disables)
-- switch
-
-[alexa skill]: https://alexa.amazon.com/spa/index.html#skills/dp/B0772J1QKB/?ref=skill_dsk_skb_sr_2
-
-### {% linkable_title Frequently Asked Questions %}
-
-You can find a list of frequently asked questions (and their answers) in [this blog post](https://home-assistant.io/blog/2017/12/17/introducing-home-assistant-cloud/#faq).
diff --git a/source/_components/coinbase.markdown b/source/_components/coinbase.markdown
new file mode 100644
index 00000000000..d39e34e3a73
--- /dev/null
+++ b/source/_components/coinbase.markdown
@@ -0,0 +1,47 @@
+---
+layout: page
+title: "coinbase"
+description: "Instructions for how to add Coinbase sensors to Home Assistant."
+date: 2017-12-08 17:54
+sidebar: true
+comments: false
+sharing: true
+footer: true
+logo: coinbase.png
+ha_release: 0.61
+ha_iot_class: "Cloud Polling"
+---
+
+
+The `coinbase` component lets you access account balances and exchange rates from [coinbase](https://coinbase.com).
+
+You will need to obtain an API key from coinbase's [developer site](https://www.coinbase.com/settings/api) to use this component. You need to give read access to `wallet:accounts` in order for the component to access relevant data.
+
+To set it up, add the following information to your `configuration.yaml` file:
+
+```yaml
+# Example configuration.yaml entry
+coinbase:
+ api_key: asdfghjklqwertyuiopzxcvbnm
+ api_secret: nkjnewncfghjklqwertyuiopzxcvbnm
+ exchange_rate_currencies:
+ - BTC
+ - ETH
+ - LTC
+=======
+```
+
+{% configuration %}
+api_key:
+ description: Your API key to access coinbase.
+ required: true
+ type: string
+api_secret:
+ description: Your API secret to access coinbase.
+ required: true
+ type: string
+exchange_rate_currencies:
+ description: List of currencies to create exchange rate sensors for.
+ required: false
+ type: list
+{% endconfiguration %}
diff --git a/source/_components/cover.mqtt.markdown b/source/_components/cover.mqtt.markdown
index e466514cadd..94cc013f787 100755
--- a/source/_components/cover.mqtt.markdown
+++ b/source/_components/cover.mqtt.markdown
@@ -35,33 +35,125 @@ cover:
command_topic: "home-assistant/cover/set"
```
-Configuration variables:
-
-- **name** (*Optional*): The name of the sensor. Default is `MQTT Cover`.
-- **command_topic** (*Optional*): The MQTT topic to publish commands to control the cover.
-- **payload_open** (*Optional*): The payload that opens the cover. Default is `OPEN`.
-- **payload_close** (*Optional*): The payload that closes the cover. Default is `CLOSE`.
-- **payload_stop** (*Optional*): The payload that stops the cover. default is `STOP`.
-- **state_topic** (*Optional*): The MQTT topic subscribed to receive cover state messages.
-- **state_open** (*Optional*): The payload that represents the open state. Default is `open`.
-- **state_closed** (*Optional*): The payload that represents the closed state. Default is `closed`.
-- **availability_topic** (*Optional*): The MQTT topic subscribed to to receive birth and LWT messages from the MQTT cover device. If `availability_topic` is not defined, the cover availability state will always be "available". If `availability_topic` is defined, the cover availability state will be "unavailable" by default.
-- **payload_available** (*Optional*): The payload that represents the online state. Default is `online`.
-- **payload_not_available** (*Optional*): The payload that represents the offline state. Default is `offline`.
-- **optimistic** (*Optional*): Flag that defines if switch works in optimistic mode. Default is `true` if no state topic defined, else `false`.
-- **qos** (*Optional*): The maximum QoS level to be used when receiving and publishing messages. Default is `0`.
-- **retain** (*Optional*): Defines if published messages should have the retain flag set. Default is `false`.
-- **value_template** (*Optional*): Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract a value from the payload.
-- **set_position_topic** (*Optional*): The MQTT topic to publish position commands to.
-- **set_position_template** (*Optional*): Defines a [template](/topics/templating/) to define the position to be sent to the `set_position_topic` topic. Incoming position value is available for use in the template `{{position}}`. If no template is defined, the numeric position (0-100) will be written directly to the topic.
-- **tilt_command_topic** (*Optional*): The MQTT topic to publish commands to control the cover tilt.
-- **tilt_status_topic** (*Optional*): The MQTT topic subscribed to receive tilt status update values.
-- **tilt_min** (*Optional*): The minimum tilt value. Default is `0`
-- **tilt_max** (*Optional*): The maximum tilt value. Default is `100`
-- **tilt_closed_value** (*Optional*): The value that will be sent on a `close_cover_tilt` command. Default is `0`
-- **tilt_opened_value** (*Optional*): The value that will be sent on an `open_cover_tilt` command. Default is `100`
-- **tilt_status_optimistic** (*Optional*): Flag that determines if tilt works in optimistic mode. Default is `true` if `tilt_status_topic` is not defined, else `false`
-- **tilt_invert_state** (*Optional*): Flag that determines if open/close are flipped; higher values toward closed and lower values toward open. Default is `False`
+{% configuration %}
+name:
+ description: The name of the cover.
+ required: false
+ type: string
+ default: MQTT Cover
+command_topic:
+ description: The MQTT topic to publish commands to control the cover.
+ required: false
+ type: string
+payload_open:
+ description: The command payload that opens the cover.
+ required: false
+ type: string
+ default: OPEN
+payload_close:
+ description: The command payload that closes the cover.
+ required: false
+ type: string
+ default: CLOSE
+payload_stop:
+ description: The command payload that stops the cover.
+ required: false
+ type: string
+ default: STOP
+state_topic:
+ description: The MQTT topic subscribed to receive cover state messages.
+ required: false
+ type: string
+state_open:
+ description: The payload that represents the open state.
+ required: false
+ type: string
+ default: open
+state_closed:
+ description: The payload that represents the closed state.
+ required: false
+ type: string
+ default: closed
+availability_topic:
+ description: "The MQTT topic subscribed to to receive birth and LWT messages from the MQTT cover device. If `availability_topic` is not defined, the cover availability state will always be `available`. If `availability_topic` is defined, the cover availability state will be `unavailable` by default."
+ required: false
+ type: string
+payload_available:
+ description: The payload that represents the online state.
+ required: false
+ type: string
+ default: online
+payload_not_available:
+ description: The payload that represents the offline state.
+ required: false
+ type: string
+ default: offline
+optimistic:
+ description: Flag that defines if switch works in optimistic mode.
+ required: false
+ type: string
+ default: "`true` if no state topic defined, else `false`."
+qos:
+ description: The maximum QoS level to be used when receiving and publishing messages.
+ required: false
+ type: integer
+ default: 0
+retain:
+ description: Defines if published messages should have the retain flag set.
+ required: false
+ type: boolean
+ default: false
+value_template:
+ description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract a value from the payload."
+ required: false
+ type: string
+set_position_topic:
+ description: The MQTT topic to publish position commands to.
+ required: false
+ type: string
+set_position_template:
+ description: " Defines a [template](/topics/templating/) to define the position to be sent to the `set_position_topic` topic. Incoming position value is available for use in the template `{{position}}`. If no template is defined, the numeric position (0-100) will be written directly to the topic."
+ required: false
+ type: string
+tilt_command_topic:
+ description: The MQTT topic to publish commands to control the cover tilt.
+ required: false
+ type: string
+tilt_status_topic:
+ description: The MQTT topic subscribed to receive tilt status update values.
+ required: false
+ type: string
+tilt_min:
+ description: The minimum tilt value.
+ required: false
+ type: integer
+ default: 0
+tilt_max:
+ description: The maximum tilt value
+ required: false
+ type: integer
+ default: 100
+tilt_closed_value:
+ description: The value that will be sent on an `close_cover_tilt` command.
+ required: false
+ type: integer
+ default: 0
+tilt_opened_value:
+ description: The value that will be sent on an `open_cover_tilt` command.
+ required: false
+ type: integer
+ default: 0
+tilt_status_optimistic:
+ description: Flag that determines if tilt works in optimistic mode.
+ required: false
+ type: boolean
+ default: "`true` if `tilt_status_topic` is not defined, else `false`"
+tilt_invert_state:
+ description: Flag that determines if open/close are flipped; higher values toward closed and lower values toward open.
+ required: false
+ type: boolean
+ default: false
+{% endconfiguration %}
## {% linkable_title Examples %}
@@ -78,7 +170,7 @@ cover:
name: "MQTT Cover"
command_topic: "home-assistant/cover/set"
state_topic: "home-assistant/cover/state"
- availability_topic: "home-assistant/cover/availability"
+ availability_topic: "home-assistant/cover/availability"
qos: 0
retain: true
payload_open: "OPEN"
diff --git a/source/_components/daikin.markdown b/source/_components/daikin.markdown
new file mode 100644
index 00000000000..548c05ec313
--- /dev/null
+++ b/source/_components/daikin.markdown
@@ -0,0 +1,63 @@
+---
+layout: page
+title: "Daikin AC"
+description: "Instructions on how to integrate Hive devices with Home Assistant."
+date: 2017-12-10 21:00
+sidebar: false
+comments: false
+sharing: true
+footer: true
+logo: N/A
+ha_category: Climate
+ha_release: 0.59
+ha_iot_class: "Local Polling"
+---
+
+### Description ###
+
+The component integrates Daikin air conditioning systems into Home Assistant.
+
+To automatically add all your Daikin devices (ACs and associated sensors) into your Home Assistant installation, add the following to your 'configuration.yaml' file:
+
+
+ Please note, the Daikin platform integrates **ONLY the european versions of Daikin ACs (models BRP069A41, 42, 43, 45)** into Home Assistant
+
+
+```yaml
+# Example configuration.yaml entry
+daikin:
+ hosts:
+ - 192.168.4.161
+
+ monitored_conditions:
+ - inside_temperature
+ - outside_temperature
+
+```
+
+{% configuration %}
+hosts:
+ description: List of IP addresses or hostnames.
+ required: true
+ type: array
+monitored_conditions:
+ description: List of items you want to monitor for each device.
+ required: false
+ detault: All conditions
+ type: list
+ keys:
+ inside_temperature:
+ description: The current temperature measured inside the house.
+ outside_temperature:
+ description: The current temperature measured outside the house.
+{% endconfiguration %}
+
+
+ Please note that some AC devices may report outside temperature only when they are turned on.
+
+
+
+The Daikin Home Assistant platform currently supports the following Hive devices:
+
+- [Climate](/components/climate.daikin)
+- [Sensor](/components/sensor.daikin)
diff --git a/source/_components/deconz.markdown b/source/_components/deconz.markdown
new file mode 100644
index 00000000000..8d050e7d43d
--- /dev/null
+++ b/source/_components/deconz.markdown
@@ -0,0 +1,148 @@
+---
+layout: page
+title: "deCONZ"
+description: "Instructions on how to setup Conbee/Raspbee devices with deCONZ from Dresden Elektronik within Home Assistant."
+date: 2017-11-12 16:30
+sidebar: true
+comments: false
+sharing: true
+footer: true
+logo: deconz.jpeg
+ha_category: Hub
+ha_release: "0.61"
+ha_iot_class: "Local Push"
+---
+
+[deCONZ](https://www.dresden-elektronik.de/funktechnik/products/software/pc/deconz/) by [Dresden Elektronik](https://www.dresden-elektronik.de) is a software that communicates with Conbee/Raspbee Zigbee gateways and exposes Zigbee devices that are connected to the gateway.
+
+[deCONZ REST API](http://dresden-elektronik.github.io/deconz-rest-doc/).
+
+Home Assistant will automatically discover deCONZ presence on your network, if `discovery:` is present in your `configuration.yaml` file.
+
+If you don't have the API key, you can generate an API key for deCONZ by using the one-click functionality similar to Philips Hue. Go to Menu->Settings->Unlock Gateway in deCONZ and then use the deCONZ configurator in Home Assistant GUI to create an API key. When you've generated the API key from Home Assistant, the API key will be stored in deconz.conf inside the home-assistant folder.
+
+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
+```
+
+#### {% linkable_title Supported Device types %}
+
+- [Zigbee Lights](/components/light/deconz/)
+- [Humidity Sensors](/components/sensor/deconz/)
+- [Light Level Sensors](/components/sensor/deconz/)
+- [OpenClose Detectors](/components/binary_sensor/deconz/)
+- [Presence Detectors](/components/binary_sensor/deconz/)
+- [Pressure Sensors](/components/sensor/deconz/)
+- [Switches (Remote Controls)](/components/sensor/deconz/)
+- [Temperature Sensors](/components/sensor/deconz/)
+
+{% configuration %}
+host:
+ description: The IP address of your deCONZ web server.
+ 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
+```
+
+## {% linkable_title Device services %}
+Available services: `configure`.
+
+#### {% linkable_title Service `deconz/configure` %}
+Set attribute of device in Deconz using [Rest API](http://dresden-elektronik.github.io/deconz-rest-doc/rest/).
+
+| Service data attribute | Optional | Description |
+|-----------|----------|-------------|
+| `field` | No | String representing a specific device in deCONZ. |
+| `data` | No | Data is a JSON object with what data you want to alter. |
+
+{ "field": "/lights/1", "data": {"name": "light2"} }
+
+{ "field": "/config", "data": {"permitjoin": 60} }
+
+## {% linkable_title Remote control devices%}
+
+Remote controls (ZHASwitch category) will be not be exposed as a regular entity, but as events named 'deconz_event' with a payload of 'id' and 'event'. Id will be the device name from deCONZ and Event will be the momentary state of the switch. However, a sensor entity will be created that shows the battery level of the switch as reported by deCONZ, named sensor.device_name_battery_level.
+
+Typical values for switches, the event codes are 4 numbers where the first and last number are of interest here.
+
+| Switch code | Description |
+|-------------|-------------|
+| 1XXX | Button #1 up to #8 |
+| XXX1 | Button hold |
+| XXX2 | Button short release |
+| XXX3 | Button long release |
+
+Where for example on a Philips Hue Dimmer, 2001 would be holding the dim up button.
+
+## {% linkable_title Examples %}
+
+### {% linkable_title Step up and step down input number with wireless dimmer %}
+
+```yaml
+automation:
+ - alias: 'Toggle lamp from dimmer'
+ initial_state: 'on'
+ trigger:
+ platform: event
+ event_type: deconz_event
+ event_data:
+ id: remote_control_1
+ event: 1002
+ action:
+ service: light.toggle
+ entity_id: light.lamp
+
+ - alias: 'Increase brightness of lamp from dimmer'
+ initial_state: 'on'
+ trigger:
+ platform: event
+ event_type: deconz_event
+ event_data:
+ id: remote_control_1
+ event: 2002
+ action:
+ - service: light.turn_on
+ data_template:
+ entity_id: light.lamp
+ brightness: {% raw %}>
+ {% set bri = states.light.lamp.attributes.brightness | int %}
+ {{ [bri+30, 249] | min }}{% endraw %}
+
+ - alias: 'Decrease brightness of lamp from dimmer'
+ initial_state: 'on'
+ trigger:
+ platform: event
+ event_type: deconz_event
+ event_data:
+ id: remote_control_1
+ event: 3002
+ action:
+ - service: light.turn_on
+ data_template:
+ entity_id: light.lamp
+ brightness: {% raw %}>
+ {% set bri = states.light.lamp.attributes.brightness | int %}
+ {{ [bri-30, 0] | max }}{% endraw %}
+```
diff --git a/source/_components/device_tracker.gpslogger.markdown b/source/_components/device_tracker.gpslogger.markdown
index 6b6a439cdee..994b8c2989a 100644
--- a/source/_components/device_tracker.gpslogger.markdown
+++ b/source/_components/device_tracker.gpslogger.markdown
@@ -19,7 +19,14 @@ To integrate GPSLogger in Home Assistant, add the following section to your `con
# Example configuration.yaml entry
device_tracker:
- platform: gpslogger
+ password: !secret gpslogger_password
```
+{% configuration %}
+password:
+ description: Separate password for GPS Logger endpoint. If provided using regular API password to contact endpoint will result in 401 response.
+ required: false
+ type: string
+{% endconfiguration %}
## {% linkable_title Setup on your smartphone %}
diff --git a/source/_components/device_tracker.owntracks.markdown b/source/_components/device_tracker.owntracks.markdown
index 20cf68ab97a..f23457ad8d6 100644
--- a/source/_components/device_tracker.owntracks.markdown
+++ b/source/_components/device_tracker.owntracks.markdown
@@ -32,6 +32,9 @@ Configuration variables:
- **waypoints** (*Optional*): Owntracks users can define [waypoints](http://owntracks.org/booklet/features/waypoints/) (a.k.a regions) which are similar in spirit to Home Assistant zones. If this configuration variable is `True`, the Owntracks users who are in `waypoint_whitelist` can export waypoints from the device and Home Assistant will import them as zone definitions. Defaults to `True`.
- **waypoint_whitelist** (*Optional*): A list of user names (as defined for [Owntracks](/components/device_tracker.owntracks/)) who can export their waypoints from Owntracks to Home Assistant. This would be the `username` portion of the Base Topic Name, (e.g. owntracks/**username**/iPhone). Defaults to all users who are connected to Home Assistant via Owntracks.
- **secret** (*Optional*): [Payload encryption key](http://owntracks.org/booklet/features/encrypt/). This is usable when communicating with a third-party untrusted server or a public server (where anybody can subscribe to any topic). By default the payload is assumed to be unencrypted (although the communication between Home Assistant and the server might still be encrypted). This feature requires the `libsodium` library to be present.
+- **mqtt_topic** (*Optional*): The topic to subscribe for Owntracks updates on your MQTT instance (defaults to `owntracks/#`).
+- **events_only** (*Optional*): Home Assistant will ignore all location updates and rely solely on geofence enter/leave events.
+- **region_mapping** (*Optional*): Dictionary to remap names of regions as configured in the Owntracks app to Home Assistant zones. Use this if you have multiple homes or Home Assistant instances and want to map a different label to 'home'. `key: value` maps Owntracks region `key` to Home Assistant zone `value`.
A full sample configuration for the `owntracks` platform is shown below:
@@ -41,9 +44,14 @@ device_tracker:
- platform: owntracks
max_gps_accuracy: 200
waypoints: True
+ mqtt_topic: "owntracks/#"
+ events_only: True
waypoint_whitelist:
- jon
- ram
+ region_mapping:
+ cabin: home
+ office: work
```
### {% linkable_title Using Owntracks with other device trackers %}
diff --git a/source/_components/device_tracker.tile.markdown b/source/_components/device_tracker.tile.markdown
index 7dc534339f4..63ba3d693c8 100644
--- a/source/_components/device_tracker.tile.markdown
+++ b/source/_components/device_tracker.tile.markdown
@@ -25,9 +25,6 @@ device_tracker:
- platform: tile
username: email@address.com
password: MY_PASSWORD_123
- monitored_variables:
- - TILE
- - PHONE
```
{% configuration %}
@@ -43,4 +40,8 @@ device_tracker:
description: the Tile types to monitor; valid values are `TILE` and `PHONE` (default is for all types to be included)
required: false
type: list
+ show_inactive:
+ description: whether to show expired/disabled Tiles
+ required: false
+ type: boolean
{% endconfiguration %}
diff --git a/source/_components/doorbird.markdown b/source/_components/doorbird.markdown
index 0b7f1e4120a..4ce686ec640 100644
--- a/source/_components/doorbird.markdown
+++ b/source/_components/doorbird.markdown
@@ -30,3 +30,8 @@ Configuration variables:
- **host** (*Required*): The LAN IP address or hostname of your device. You can find this by going to the [DoorBird Online check](http://www.doorbird.com/checkonline) and entering the information from the paper that was included in the box.
- **username** (*Required*): The username of a non-administrator user account on the device.
- **password** (*Required*): The password for the user specified.
+- **doorbell_events** (*Optional*): Setting this to `true` this will register a callback URL with the device so that events can be published to the event bus when the doorbell rings.
+
+
+Enabling `doorbell_events` will delete all other registered push notification services with the device every time Home Assistant starts. This will not affect notifications delivered by the DoorBird mobile app.
+
diff --git a/source/_components/fan.insteon_local.markdown b/source/_components/fan.insteon_local.markdown
index 8476fc43d06..359f099477b 100644
--- a/source/_components/fan.insteon_local.markdown
+++ b/source/_components/fan.insteon_local.markdown
@@ -14,21 +14,4 @@ ha_version: 0.48
The `insteon_local` fan component lets you control your fan connected to an [Insteon Hub](http://www.insteon.com/insteon-hub/) with Home Assistant.
-To integrate add a fan, configure your hub Insteon(local) with Home Assistant, add the following section to your `configuration.yaml` file:
-
-```yaml
-# Example configuration.yaml platform entry
-insteon_local:
- host: YOUR HUB IP
- username: YOUR HUB USERNAME
- password: YOUR HUB PASSWORD
- timeout: 10
- port: 25105
-```
-
-To add fans to your set-up, add the platform to your light configuration:
-```yaml
-fan:
- - platform: insteon_local
-```
-
+To get your insteon fans working with Home Assistant, follow the instructions for the general [Insteon local component](/components/insteon_local/). The fans will be automatically disovered and added to Home Assistant. The device names will be the Insteon address of the fans.
diff --git a/source/_components/fan.mqtt.markdown b/source/_components/fan.mqtt.markdown
index 82c5193ba30..1a0329404f8 100644
--- a/source/_components/fan.mqtt.markdown
+++ b/source/_components/fan.mqtt.markdown
@@ -30,30 +30,117 @@ fan:
command_topic: "bedroom_fan/on/set"
```
-Configuration variables:
-
-- **command_topic** (*Required*): The MQTT topic to publish commands to change the fan state.
-- **state_topic** (*Optional*): The MQTT topic subscribed to receive state updates.
-- **name** (*Optional*): The name of the fan. Default is 'MQTT Fan'.
-- **state_topic** (*Optional*): The MQTT topic subscribed to receive state updates.
-- **payload_on** (*Optional*): The payload that represents the running state. Default is "ON".
-- **payload_off** (*Optional*): The payload that represents the stop state. Default is "OFF".
-- **state_value_template** (*Optional*): Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract a value from the state.
-- **qos** (*Optional*): The maximum QoS level of the state topic. Default is 0 and will also be used to publishing messages.
-- **optimistic** (*Optional*): Flag that defines if lock works in optimistic mode. Default is `true` if no state topic defined, else `false`.
-- **retain** (*Optional*): If the published message should have the retain flag on or not.
-- **oscillation_state_topic** (*Optional*): The MQTT topic subscribed to receive oscillation state updates.
-- **oscillation_command_topic** (*Optional*): The MQTT topic to publish commands to change the oscillation state.
-- **payload_oscillation_on** (*Optional*): The payload that represents the oscillation on state. Default is "oscillate_on".
-- **payload_oscillation_off** (*Optional*): The payload that presents the oscillation off state. Default is "oscillate_off".
-- **oscillation_value_template** (*Optional*): Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract a value from the oscillation.
-- **speed_state_topic** (*Optional*): The MQTT topic subscribed to receive speed state updates.
-- **speed_command_topic** (*Optional*): The MQTT topic to publish commands to change speed state.
-- **payload_low_speed** (*Optional*): The payload that represents the fan's low speed.
-- **payload_medium_speed** (*Optional*): The payload that represents the fan's medium speed.
-- **payload_high_speed** (*Optional*): The payload that represents the fan's high speed.
-- **speed_value_template** (*Optional*): Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract a value from the speed payload.
-- **speeds** array (*Optional*): Valid entries for the list are `off`, `low`, `medium`, and `high`.
+{% configuration %}
+name:
+ description: The name of the fan.
+ required: false
+ type: string
+ default: MQTT Fan
+command_topic:
+ description: The MQTT topic to publish commands to change the fan state.
+ required: true
+ type: string
+state_topic:
+ description: The MQTT topic subscribed to receive state updates.
+ required: false
+ type: string
+payload_on:
+ description: The payload that represents the running state.
+ required: false
+ type: string
+ default: ON
+payload_off:
+ description: The payload that represents the stop state.
+ required: false
+ type: string
+ default: OFF
+state_value_template:
+ description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract a value from the state."
+ required: false
+ type: string
+qos:
+ description: The maximum QoS level of the state topic.
+ required: false
+ type: integer
+ default: 0
+optimistic:
+ description: Flag that defines if lock works in optimistic mode
+ required: false
+ type: boolean
+ default: "`true` if no state topic defined, else `false`."
+retain:
+ description: If the published message should have the retain flag on or not.
+ required: false
+ type: boolean
+ default: true
+oscillation_state_topic:
+ description: The MQTT topic subscribed to receive oscillation state updates.
+ required: false
+ type: string
+oscillation_command_topic:
+ description: The MQTT topic to publish commands to change the oscillation state.
+ required: false
+ type: string
+payload_oscillation_on:
+ description: The payload that represents the oscillation on state.
+ required: false
+ type: string
+ default: oscillate_on
+payload_oscillation_off:
+ description: The payload that represents the oscillation off state.
+ required: false
+ type: string
+ default: oscillate_off
+oscillation_value_template:
+ description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract a value from the oscillation."
+ required: false
+ type: string
+speed_state_topic:
+ description: The MQTT topic subscribed to receive speed state updates.
+ required: false
+ type: string
+speed_command_topic:
+ description: The MQTT topic to publish commands to change speed state.
+ required: false
+ type: string
+payload_low_speed:
+ description: The payload that represents the fan's low speed.
+ required: false
+ type: string
+ default: low
+payload_medium_speed:
+ description: The payload that represents the fan's medium speed.
+ required: false
+ type: string
+ default: medium
+payload_high_speed:
+ description: The payload that represents the fan's high speed.
+ required: false
+ type: string
+ default: high
+speed_value_template:
+ description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract a value from the speed payload."
+ required: false
+ type: string
+speeds:
+ description: "List of speeds this fan is capable of running at. Valid entries are `off`, `low`, `medium`, and `high`."
+ required: false
+ type: string list
+availability_topic:
+ description: The MQTT topic subscribed to receive availability (online/offline) updates.
+ required: false
+ type: string
+payload_available:
+ description: The payload that represents the available state.
+ required: false
+ type: string
+ default: online
+payload_not_available:
+ description: The payload that represents the unavailable state.
+ required: false
+ type: string
+ default: offline
+{% endconfiguration %}
Make sure that your topics match exactly. `some-topic/` and `some-topic` are different topics.
diff --git a/source/_components/google_assistant.markdown b/source/_components/google_assistant.markdown
index ea966d4f4aa..3b28d438f59 100644
--- a/source/_components/google_assistant.markdown
+++ b/source/_components/google_assistant.markdown
@@ -18,7 +18,7 @@ The `google_assistant` component allows you to control things via Google Assista
The Google Assistant component requires a bit more setup than most due to the way Google requires Assistant Apps to be set up.
-To use Google Assistant your Home Assistant configuration has to be externally accessible, with a hostname and SSL certificate. If you haven't already configured that you should do so before continuing.
+To use Google Assistant, your Home Assistant configuration has to be externally accessible, with a hostname and SSL certificate. If you haven't already configured that you should do so before continuing.
To enable this, add the following lines to your `configuration.yaml` file:
@@ -35,26 +35,77 @@ google_assistant:
- switch
- light
- group
+ entity_config:
+ switch.kitchen:
+ name: Custom Name for Alexa
+ aliases:
+ - bright lights
+ - entry lights
+ type: 'action.devices.types.LIGHT'
+ light.living_room:
+ expose: false
```
Configuration variables:
-- **expose_by_default** (*Optional*): Expose devices in all supported domains by default.
-- **project_id** (*Required*): Project ID from the Google Developer console (looks like `words-2ab12`)
-- **client_id** (*Required*): A long random URL safe string (no spaces or special characters) that will be used for Implicit OAuth.
-- **access_token** (*Required*): Another different long random URL safe string.
-- **agent_user_id** (*Optional*): A string to identify the user, e.g., email address. If not provided, the component will generate one.
-- **api_key** (*Optional*): A Homegraph API Key generated for the project from [Google Console](https://console.cloud.google.com/apis/api/homegraph.googleapis.com/overview) which allows you to update devices without unlinking and relinking an account (see setup below). If not provided then the request_sync service is not exposed.
-- **exposed_domains** (*Optional*): An array of Home Assistant domains to expose to Google Assistant. Options include:
- - `switch`
- - `light`
- - `cover`
- - `media_player`
- - `group`
- - `fan`
- - `scene`
- - `script`
- - `climate`
+{% configuration %}
+
+project_id:
+ description: Project ID from the Google Developer console (looks like `words-2ab12`)
+ required: true
+ type: string
+client_id:
+ description: A long random URL safe string (no spaces or special characters) that will be used for Implicit OAuth (example `aBcDeFgHiJkLmNoP`)
+ required: true
+ type: string
+access_token:
+ description: Another different long random URL safe string (example `aBcDeFgHiJkLmNoP`)
+ required: true
+ type: string
+agent_user_id:
+ description: A string to identify the user, e.g., email address. If not provided, the component will generate one.
+ required: false
+ type: string
+api_key:
+ description: An API Key generated for the project from [Google Console](https://console.cloud.google.com/apis/api/homegraph.googleapis.com/overview) which allows you to update devices without unlinking and relinking an account (see setup below). If not provided then the request_sync service is not exposed.
+ required: false
+ type: string
+expose_by_default:
+ description: Expose devices in all supported domains by default.
+ required: false
+ default: True
+ type: boolean
+exposed_domains:
+ description: List of entity domains to expose to Google Assistant.
+ required: false
+ type: list
+entity_config:
+ description: Entity specific configuration for Google Assistant
+ required: false
+ type: map
+ keys:
+ '``':
+ description: Entity to configure
+ required: false
+ type: map
+ keys:
+ name:
+ description: Name of the entity to show in Google Assistant
+ required: false
+ type: string
+ expose:
+ description: Force an entity to be exposed/excluded.
+ required: false
+ type: boolean
+ aliases:
+ description: Aliases that can also be used to refer to this entity
+ required: false
+ type: list
+ type:
+ description: Override the type of the entity in Google Assistant. [List of available types](https://developers.google.com/actions/smarthome/guides/)
+ required: false
+ type: string
+{% endconfiguration %}
It's very important that you use very long strings for `client_id` and `access_token`. Those are essentially the credentials to your Home Assistant instance. You can generate them with the following command:
@@ -64,31 +115,6 @@ $ cat /dev/urandom | fold -w 120 | head -n 1 | base64 -w 0 | tr -dc '0-9A-Za-z'
If you're not using Linux, you can use sites such as [this one](https://www.browserling.com/tools/random-string) to generate a random string (containing mixed case letters and numbers) of up to 80 characters.
-
-You can also customize your devices similar to other components by adding keys to entities:
-
-```yaml
-homeassistant:
- customize:
- master_bedroom_light:
- google_assistant: true
- google_assistant_name: bedroom light
- bedroom_blinds:
- aliases:
- - bedroom shades
- - bedroom covers
- hallway_ceiling_switch:
- google_assistant: true
- google_assistant_type: light
-```
-
-Entity Customization Keys:
-
-- **google_assistant**: True exposes entity, false will hide it.
-- **google_assistant_name**: Can be used to override the primary name of an entity. By default the `friendly_name` of an entity is used.
-- **google_assistant_type**: Can be used to override the domain/type of an entity. For example a switch can be treated as a light
-- **aliases**: Provides "nicknames" to Google Assistant. These function as alternate names for an entity that Assistant will understand when spoken.
-
### {% linkable_title Setup %}
1. Download the [gactions CLI](https://developers.google.com/actions/tools/gactions-cli) (you'll use this later) - you can download and run this anywhere and on any machine, just remember where you put it for later (and don't forget to run `chmod +x gactions`to make it executable on mac or linux)
@@ -132,8 +158,8 @@ Entity Customization Keys:
8. If you haven't already added the component configuration to `configuration.yaml` and restarted Home Assistant, you'll be unable to continue until you have.
8. Open the Google Assistant app and go into `Settings > Home Control`
9. Click the `+` sign, and near the bottom, you should have `[test] your app name`. Selecting that should lead to you the screen where you can set rooms for your devices or nicknames for your devices.
-10. If you want to allow other houshold users to control the devices:
- 1. Go to the developer console using address from point 4.
+10. If you want to allow other household users to control the devices:
+ 1. Go to the developer console using the address from point 4.
2. Under the gear icon, click `Permissions`
3. Click `Add`, type the new user's e-mail address and choose `Project -> Editor` role
4. Have the new user go to [developer console](https://console.actions.google.com/) and repeat steps starting from point 7.
@@ -143,11 +169,14 @@ Entity Customization Keys:
3. Go to Credentials and select API Key from Create Credentials
4. Note down the generated API Key and use this in the configuration
-*Note:* The request_sync service requires that the initial sync from Google includes the agent_user_id. If not, the service will log an error that reads something like "Request contains an invalid argument". If this happens, then [unlink the account](https://support.google.com/googlehome/answer/7506443?hl=en-GB) from Home Control and relink.
+### {% linkable_title Troubleshooting the request_sync service %}
-*Note:* The request_sync service may fail with a 404 if the project_id of the Homegraph API differs from the project_id of the Actions SDK found in the preferences of your project on [developer console](https://console.actions.google.com). Resolve this by:
- 1. Removing your project on the [developer console](https://console.actions.google.com).
- 2. Add a new project in the [cloud console](https://console.cloud.google.com). Here you get a new project_id.
- 3. Enable Homegraph API to the new project.
- 4. Generete a new API key.
- 5. Again create a new project in the [developer console](https://console.actions.google.com/). Described above. But at the step 'Build under the Actions SDK box' choose your newly created project. By this they share the same project_id.
+The request_sync service requires that the initial sync from Google includes the agent_user_id. If not, the service will log an error that reads something like "Request contains an invalid argument". If this happens, then [unlink the account](https://support.google.com/googlehome/answer/7506443?hl=en-GB) from Home Control and relink.
+
+The request_sync service may fail with a 404 if the project_id of the Homegraph API differs from the project_id of the Actions SDK found in the preferences of your project on [developer console](https://console.actions.google.com). Resolve this by:
+
+ 1. Removing your project from the [developer console](https://console.actions.google.com).
+ 2. Add a new project to the [cloud console](https://console.cloud.google.com). Here you get a new project_id.
+ 3. Enable Homegraph API to the new project.
+ 4. Generate a new API key.
+ 5. Again create a new project in the [developer console](https://console.actions.google.com/). Described above. But at the step 'Build under the Actions SDK box' choose your newly created project. By this, they share the same project_id.
diff --git a/source/_components/history.markdown b/source/_components/history.markdown
index b7cd506edd5..4bddad4fbba 100644
--- a/source/_components/history.markdown
+++ b/source/_components/history.markdown
@@ -71,7 +71,7 @@ history:
- media_player
```
-Use the `include` list to define the domains/entities to display, and exclude some of them with in 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.
+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
diff --git a/source/_components/hive.markdown b/source/_components/hive.markdown
index 7c3d47a3c9f..8f760b08c76 100644
--- a/source/_components/hive.markdown
+++ b/source/_components/hive.markdown
@@ -49,6 +49,7 @@ The Hive Home Assistant platform currently supports the following Hive devices:
- Hive Active Heating (including hot water and Hive Multizone)
- Hive Active Light Dimmable
- Hive Active Light Cool to Warm White
+- Hive Active Light Colour Changing
- Hive Active Plug
- Hive Window or Door Sensor
- Hive Motion Sensor
diff --git a/source/_components/insteon_local.markdown b/source/_components/insteon_local.markdown
index 96a339f0f03..fba10871713 100644
--- a/source/_components/insteon_local.markdown
+++ b/source/_components/insteon_local.markdown
@@ -33,9 +33,9 @@ Configuration variables:
- **timeout** (*Optional*): Timeout to wait for connections. Defaults to 10 seconds.
- **port** (*Optional*): The port your hub is configured to listen to. Defaults to `25105`.
-### {% linkable_title Full configuration %}
+### {% linkable_title Full configuration %}
-The `insteon_local` component currently supports both lights (dimmers) and switches. A full configuration may look like so:
+The `insteon_local` component currently supports lights (dimmers), switches and fans.
```yaml
insteon_local:
@@ -44,14 +44,4 @@ insteon_local:
password: YOUR HUB PASSWORD
timeout: 10
port: 25105
-
-light:
- - platform: insteon_local
-
-switch:
- - platform: insteon_local
-
-fan:
- - platform: insteon_local
```
-
diff --git a/source/_components/isy994.markdown b/source/_components/isy994.markdown
index 0b59c64b24e..558765a764b 100644
--- a/source/_components/isy994.markdown
+++ b/source/_components/isy994.markdown
@@ -35,7 +35,8 @@ Configuration variables:
- **username** (*Required*): The username that used to access the ISY interface.
- **password** (*Required*): The password that used to access the ISY interface.
- **sensor_string** (*Optional*): This is the string that is used to identify which devices are to be assumed to be sensors instead of lights of switches. By default, this string is 'sensor'. If this string is found in the device name or folder, Home Assistant will assume it is as a sensor or binary sensor (if the device has on/off or true/false states). This is only necessary for nodes that are not automatically detected as sensors by Home Assistant. Insteon door, window, motion and leak sensors should all be detected automatically.
-- **hidden_string** (*Optional*): The HIDDEN_STRING is a string that is used to identify which devices are to be hidden on Home Assistant's front page. This string will be stripped from the device's name before being used. By default, this value is '{HIDE ME}'.
+- **ignore_string** (*Optional*): Any devices that contain this string in their name (or folder path) will be ignored by Home Assistant. They will not become entities at all. The default value is `{IGNORE ME}`.
+- **enable_climate** (*Optional*): When enabled, climate measurements from the optional climate module in the ISY994 will show up in Home Assistant as sensors. The default value is `True`.
- **tls** (*Optional*): This entry should reflect the version of TLS that the ISY controller is using for HTTPS encryption. This value can be either 1.1 or 1.2. If this value is not set, it is assumed to be version 1.1. This is the default for most users. ISY994 Pro users may likely be using 1.2. When using HTTPS in the host entry, it is best practice to set this value.
Once the ISY controller is configured, it will automatically import any binary sensors, covers, fans, lights, locks, sensors and switches it can locate.
diff --git a/source/_components/light.deconz.markdown b/source/_components/light.deconz.markdown
new file mode 100644
index 00000000000..7ee2d591950
--- /dev/null
+++ b/source/_components/light.deconz.markdown
@@ -0,0 +1,29 @@
+---
+layout: page
+title: "deCONZ lights"
+description: "Instructions on how to integrate Zigbee lights from deCONZ into Home Assistant."
+date: 2017-11-12 16:30
+sidebar: true
+comments: false
+sharing: true
+footer: true
+logo: deconz.jpeg
+ha_category: Light
+ha_release: "0.61"
+ha_iot_class: "Local Push"
+---
+
+See the [deCONZ main component](/components/deconz/) for configuration instructions.
+
+Entity Ids names will be light.device_name, where device_name is defined in deCONZ. Light groups created in deCONZ will be created in Home Assistant as lights named light.group_name_in_deconz, allowing the user to control groups of lights with only a single API call to deCONZ.
+
+#### {% linkable_title Verified to be supported sensors %}
+
+- IKEA Trådfri bulb E14 WS opal 400lm
+- IKEA Trådfri Bulb E27 WS Opal 980lm
+- IKEA Trådfri Bulb E27 WS Opal 1000lm
+- IKEA Trådfri Bulb GU10 W 400lm
+- OSRAM Flex RGBW
+- OSRAM Gardenpole RGBW
+- Philips Hue White A19
+- Philips Hue White Ambiance A19
diff --git a/source/_components/light.greenwave.markdown b/source/_components/light.greenwave.markdown
new file mode 100644
index 00000000000..a0cba942d4c
--- /dev/null
+++ b/source/_components/light.greenwave.markdown
@@ -0,0 +1,41 @@
+---
+layout: page
+title: Greenwave Reality (TCP Connected) Lights
+description: "Instructions on how to set up Greenwave Reality lights within Home Assistant."
+date: 2017-11-17 18:50
+sidebar: true
+comments: false
+sharing: true
+footer: true
+logo: greenwavereality.png
+ha_category: Light
+ha_release: 0.61
+ha_iot_class: "Local Polling"
+---
+
+This component communicates with the Greenwave Reality (TCP Connected) Gateway to allow control of all lights and fixtures registered to the gateway. Bulbs and Fixtures can be created and modified inside the TCP Lighting App for Android and iOS.
+
+This component has been tested on firmware revisions:
+
+- 2.0.105
+
+To configure the connection to the gateway, add the following to your `configuration.yaml` file:
+
+```yaml
+light:
+ - platform: greenwave
+ host: XXX.XXX.XXX.XXX
+ version: 3
+```
+The version option is the major revision of your firmware, which should be 2 or 3. If you are running Version 2, there are no extra steps. If you are running Version 3, you must press the Sync button on the gateway prior to the first launch of Home Assistant, so a token can be grabbed. Once home assistant has started, you can either press the Sync button again or wait for it to time out manually.
+
+{% configuration %}
+host:
+ description: The IP Address of your Gateway
+ required: true
+ type: string
+version:
+ description: Major version of the gateway firmware
+ required: true
+ type: integer
+{% endconfiguration %}
diff --git a/source/_components/light.hive.markdown b/source/_components/light.hive.markdown
index 7b9038ae169..89f55459fb0 100644
--- a/source/_components/light.hive.markdown
+++ b/source/_components/light.hive.markdown
@@ -19,6 +19,7 @@ The 'hive' light component integrates your Hive lights into Home Assistant, enab
The Hive light component supports the following Hive products:
- **Hive Active Light Dimmable**
- **Hive Active Light Cool to Warm White**
+- **Hive Active Light Colour Changing**
diff --git a/source/_components/light.iglo.markdown b/source/_components/light.iglo.markdown
new file mode 100644
index 00000000000..5bc12ba1d64
--- /dev/null
+++ b/source/_components/light.iglo.markdown
@@ -0,0 +1,42 @@
+---
+layout: page
+title: "iGlo"
+description: "Instructions on how to integrate iGlo lights into Home Assistant."
+date: 2017-12-17 08:00
+sidebar: true
+comments: false
+sharing: true
+footer: true
+logo: iglo.png
+ha_category: Light
+ha_iot_class: "Local Polling"
+ha_release: 0.61
+---
+
+The `iglo` platform allows you to integrate your [iGlo Lights](https://www.youtube.com/watch?v=oHTS9ji_v-s) into Home Assistant.
+
+To use your iGlo light in your installation, add the following to your `configuration.yaml` file:
+
+```yaml
+# Example configuration.yaml entry
+light:
+ - platform: iglo
+ host: 192.168.1.10
+```
+
+{% configuration %}
+host:
+ required: true
+ description: The IP address for connecting to the light.
+ type: string
+name:
+ required: false
+ description: The name for this light.
+ default: iGlo Light
+ type: string
+port:
+ required: false
+ description: The port used to connect to the light.
+ default: 8080
+ type: integer
+{% endconfiguration %}
diff --git a/source/_components/light.insteon_local.markdown b/source/_components/light.insteon_local.markdown
index 14f91598c91..06af902dfd7 100644
--- a/source/_components/light.insteon_local.markdown
+++ b/source/_components/light.insteon_local.markdown
@@ -15,22 +15,4 @@ ha_iot_class: "Local Push"
The `insteon_local` light component lets you control your lights connected to an [Insteon Hub](http://www.insteon.com/insteon-hub/) with Home Assistant.
-To integrate add a light, configure your hub Insteon(local) with Home Assistant, add the following section to your `configuration.yaml` file:
-
-```yaml
-# Example configuration.yaml platform entry
-insteon_local:
- host: YOUR HUB IP
- username: YOUR HUB USERNAME
- password: YOUR HUB PASSWORD
- timeout: 10
- port: 25105
-```
-
-To add lights (dimmers) to your set-up, add the platform to your light configuration:
-
-```yaml
-light:
- - platform: insteon_local
-```
-
+To get your insteon lights working with Home Assistant, follow the instructions for the general [Insteon local component](/components/insteon_local/). The lights will be automatically disovered and added to Home Assistant. The device names will be the Insteon address of the lights.
diff --git a/source/_components/light.mqtt.markdown b/source/_components/light.mqtt.markdown
index 86e2c933a81..33f76eb5cc1 100644
--- a/source/_components/light.mqtt.markdown
+++ b/source/_components/light.mqtt.markdown
@@ -27,39 +27,153 @@ light:
command_topic: "office/rgb1/light/switch"
```
-Configuration variables:
-
-- **command_topic** (*Required*): The MQTT topic to publish commands to change the light's state.
-- **brightness_command_topic** (*Optional*): The MQTT topic to publish commands to change the light's brightness.
-- **brightness_scale** (*Optional*): Defines the maximum brightness value (i.e. 100%) of the MQTT device (defaults to 255).
-- **brightness_state_topic** (*Optional*): The MQTT topic subscribed to receive brightness state updates.
-- **brightness_value_template** (*Optional*): Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract the brightness value.
-- **color_temp_command_topic** (*Optional*): The MQTT topic to publish commands to change the light's color temperature state. The color temperature command slider has a range of 157 to 500 mireds (micro reciprocal degrees).
-- **color_temp_state_topic** (*Optional*): The MQTT topic subscribed to receive color temperature state updates.
-- **color_temp_value_template** (*Optional*): Defines a [template](/topics/templating/) to extract the color temperature value.
-- **effect_command_topic** (*Optional*): The MQTT topic to publish commands to change the light's effect state.
-- **effect_state_topic** (*Optional*): The MQTT topic subscribed to receive effect state updates.
-- **effect_value_template** (*Optional*): Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract the effect value.
-- **effect_list** (*Optional*): The list of effects the light supports.
-- **name** (*Optional*): The name of the switch. Default is 'MQTT Switch'.
-- **on_command_type** (*Optional*): Defines when on the payload_on is sent. Using `last` (the default) will send any style (brightness, color, etc) topics first and then a `payload_on` to the `command_topic`. Using `first` will send the `payload_on` and then any style topics. Using `brightness` will only send brightness commands instead of the `payload_on` to turn the light on.
-- **optimistic** (*Optional*): Flag that defines if switch works in optimistic mode. Default is true if no state topic defined, else false.
-- **payload_off** (*Optional*): The payload that represents disabled state. Default is "OFF".
-- **payload_on** (*Optional*): The payload that represents enabled state. Default is "ON".
-- **qos** (*Optional*): The maximum QoS level of the state topic. Default is 0 and will also be used to publishing messages.
-- **retain** (*Optional*): If the published message should have the retain flag on or not.
-- **rgb_command_template** (*Optional*): Defines a [template](/docs/configuration/templating/#processing-incoming-data) to compose message which will be sent to `rgb_command_topic`. Available variables: `red`, `green` and `blue`.
-- **rgb_command_topic** (*Optional*): The MQTT topic to publish commands to change the light's RGB state.
-- **rgb_state_topic** (*Optional*): The MQTT topic subscribed to receive RGB state updates.
-- **rgb_value_template** (*Optional*): Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract the RGB value.
-- **state_topic** (*Optional*): The MQTT topic subscribed to receive state updates.
-- **state_value_template** (*Optional*): Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract the state value. The template should match the payload "on" and "off" values, so if your light uses "power on" to turn on, your `state_value_template` string should return "power on" when the switch is on. For example if the message is just "on", your `state_value_template` should be `power {{ value }}`.
-- **white_value_command_topic** (*Optional*): The MQTT topic to publish commands to change the light's white value.
-- **white_value_state_topic** (*Optional*): The MQTT topic subscribed to receive white value updates.
-- **white_value_value_template** (*Optional*): Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract the white value.
-- **xy_command_topic** (*Optional*): The MQTT topic to publish commands to change the light's XY state.
-- **xy_state_topic** (*Optional*): The MQTT topic subscribed to receive XY state updates.
-- **xy_value_template** (*Optional*): Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract the XY value.
+{% configuration %}
+name:
+ description: The name of the light.
+ required: false
+ type: string
+ default: MQTT Light
+command_topic:
+ description: The MQTT topic to publish commands to change the switch state.
+ required: true
+ type: string
+brightness_command_topic:
+ description: The MQTT topic to publish commands to change the light’s brightness.
+ required: false
+ type: string
+brightness_scale:
+ description: "Defines the maximum brightness value (i.e. 100%) of the MQTT device."
+ required: false
+ type: integer
+ default: 255
+brightness_state_topic:
+ description: The MQTT topic subscribed to receive brightness state updates.
+ required: false
+ type: string
+brightness_value_template:
+ description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract the brightness value."
+ required: false
+ type: string
+color_temp_command_topic:
+ description: The MQTT topic to publish commands to change the light’s color temperature state. The color temperature command slider has a range of 157 to 500 mireds (micro reciprocal degrees).
+ required: false
+ type: string
+color_temp_state_topic:
+ description: The MQTT topic subscribed to receive color temperature state updates.
+ required: false
+ type: string
+color_temp_value_template:
+ description: "Defines a [template](/topics/templating/) to extract the color temperature value."
+ required: false
+ type: string
+effect_command_topic:
+ description: "The MQTT topic to publish commands to change the light's effect state."
+ required: false
+ type: string
+effect_state_topic:
+ description: The MQTT topic subscribed to receive effect state updates.
+ required: false
+ type: string
+effect_value_template:
+ description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract the effect value."
+ required: false
+ type: string
+effect_list:
+ description: The list of effects the light supports.
+ required: false
+ type: string list
+on_command_type:
+ description: "Defines when on the payload_on is sent. Using `last` (the default) will send any style (brightness, color, etc) topics first and then a `payload_on` to the `command_topic`. Using `first` will send the `payload_on` and then any style topics. Using `brightness` will only send brightness commands instead of the `payload_on` to turn the light on."
+ required: false
+ type: string
+optimistic:
+ description: Flag that defines if switch works in optimistic mode.
+ required: false
+ type: boolean
+ default: "`true` if no state topic defined, else `false`."
+payload_on:
+ description: The payload that represents enabled state.
+ required: false
+ type: string
+ default: ON
+payload_off:
+ description: The payload that represents disabled state.
+ required: false
+ type: string
+ default: OFF
+qos:
+ description: The maximum QoS level of the state topic.
+ required: false
+ type: integer
+ default: 0
+retain:
+ description: If the published message should have the retain flag on or not.
+ required: false
+ type: boolean
+ default: false
+rgb_command_template:
+ description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to compose message which will be sent to `rgb_command_topic`. Available variables: `red`, `green` and `blue`."
+ required: false
+ type: string
+rgb_command_topic:
+ description: "The MQTT topic to publish commands to change the light's RGB state."
+ required: false
+ type: string
+rgb_state_topic:
+ description: The MQTT topic subscribed to receive RGB state updates.
+ required: false
+ type: string
+rgb_value_template:
+ description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract the RGB value."
+ required: false
+ type: string
+state_topic:
+ description: The MQTT topic subscribed to receive state updates.
+ required: false
+ type: string
+state_value_template:
+ description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract the state value. The template should match the payload `on` and `off` values, so if your light uses `power on` to turn on, your `state_value_template` string should return `power on` when the switch is on. For example if the message is just `on`, your `state_value_template` should be `power {{ value }}`."
+ required: false
+ type: string
+white_value_command_topic:
+ description: "The MQTT topic to publish commands to change the light's white value."
+ required: false
+ type: string
+white_value_state_topic:
+ description: The MQTT topic subscribed to receive white value updates.
+ required: false
+ type: string
+white_value_value_template:
+ description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract the white value."
+ required: false
+ type: string
+xy_command_topic:
+ description: "The MQTT topic to publish commands to change the light's XY state."
+ required: false
+ type: string
+xy_state_topic:
+ description: The MQTT topic subscribed to receive XY state updates.
+ required: false
+ type: string
+xy_value_template:
+ description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract the XY value."
+ required: false
+ type: string
+availability_topic:
+ description: The MQTT topic subscribed to receive availability (online/offline) updates.
+ required: false
+ type: string
+payload_available:
+ description: The payload that represents the available state.
+ required: false
+ type: string
+ default: online
+payload_not_available:
+ description: The payload that represents the unavailable state.
+ required: false
+ type: string
+ default: offline
+{% endconfiguration %}
Make sure that your topics match exactly. `some-topic/` and `some-topic` are different topics.
diff --git a/source/_components/light.mqtt_json.markdown b/source/_components/light.mqtt_json.markdown
index 54732fe5bff..d6ba5ad07d0 100644
--- a/source/_components/light.mqtt_json.markdown
+++ b/source/_components/light.mqtt_json.markdown
@@ -48,23 +48,94 @@ light:
command_topic: "home/rgb1/set"
```
-Configuration variables:
-
-- **command_topic** (*Required*): The MQTT topic to publish commands to change the light's state.
-- **brightness** (*Optional*): Flag that defines if the light supports brightness. Default is false.
-- **color_temp** (*Optional*): Flag that defines if the light supports color temperature. Default is false.
-- **effect** (*Optional*): Flag that defines if the light supports effects. Default is false.
-- **effect_list** (*Optional*): The list of effects the light supports.
-- **flash_time_long** (*Optional*): The duration, in seconds, of a "long" flash. Default is 10.
-- **flash_time_short** (*Optional*): The duration, in seconds, of a "short" flash. Default is 2.
-- **name** (*Optional*): The name of the light. Default is "MQTT JSON Light."
-- **optimistic** (*Optional*): Flag that defines if the light works in optimistic mode. Default is true if no state topic defined, else false.
-- **qos** (*Optional*): The maximum QoS level of the state topic. Default is 0 and will also be used to publishing messages.
-- **retain** (*Optional*): If the published message should have the retain flag on or not.
-- **rgb** (*Optional*): Flag that defines if the light supports RGB colors. Default is false.
-- **state_topic** (*Optional*): The MQTT topic subscribed to receive state updates.
-- **white_value** (*Optional*): Flag that defines if the light supports white values. Default is false.
-- **xy** (*Optional*): Flag that defines if the light supports XY colors. Default is false.
+{% configuration %}
+name:
+ description: The name of the light.
+ required: false
+ type: string
+ default: MQTT JSON Light
+command_topic:
+ description: The MQTT topic to publish commands to change the light’s state.
+ required: true
+ type: string
+brightness:
+ description: Flag that defines if the light supports brightness.
+ required: false
+ type: boolean
+ default: false
+color_temp:
+ description: Flag that defines if the light supports color temperature.
+ required: false
+ type: boolean
+ default: false
+effect:
+ description: Flag that defines if the light supports effects.
+ required: false
+ type: boolean
+ default: false
+effect_list:
+ description: The list of effects the light supports.
+ required: false
+ type: string list
+flash_time_long:
+ description: The duration, in seconds, of a “long” flash.
+ required: false
+ type: integer
+ default: 10
+flash_time_short:
+ description: The duration, in seconds, of a “short” flash.
+ required: false
+ type: integer
+ default: 2
+optimistic:
+ description: Flag that defines if the light works in optimistic mode.
+ required: false
+ type: boolean
+ default: "`true` if no state topic defined, else `false`."
+qos:
+ description: The maximum QoS level of the state topic.
+ required: false
+ type: integer
+ default: 0
+retain:
+ description: If the published message should have the retain flag on or not.
+ required: false
+ type: boolean
+ default: false
+rgb:
+ description: Flag that defines if the light supports RGB colors.
+ required: false
+ type: boolean
+ default: false
+state_topic:
+ description: The MQTT topic subscribed to receive state updates.
+ required: false
+ type: string
+white_value:
+ description: Flag that defines if the light supports white values.
+ required: false
+ type: boolean
+ default: false
+xy:
+ description: Flag that defines if the light supports XY colors.
+ required: false
+ type: boolean
+ default: false
+availability_topic:
+ description: The MQTT topic subscribed to receive availability (online/offline) updates.
+ required: false
+ type: string
+payload_available:
+ description: The payload that represents the available state.
+ required: false
+ type: string
+ default: online
+payload_not_available:
+ description: The payload that represents the unavailable state.
+ required: false
+ type: string
+ default: offline
+{% endconfiguration %}
Make sure that your topics match exact. `some-topic/` and `some-topic` are different topics.
diff --git a/source/_components/light.mqtt_template.markdown b/source/_components/light.mqtt_template.markdown
index 3eed0fa3445..5a13ea9dfb6 100644
--- a/source/_components/light.mqtt_template.markdown
+++ b/source/_components/light.mqtt_template.markdown
@@ -33,24 +33,89 @@ light:
command_off_template: "off"
```
-Configuration variables:
-
-- **name** (*Optional*): The name of the light. Default is "MQTT Template Light."
-- **effect_list** (*Optional*): List of possible effects.
-- **command_topic** (*Required*): The MQTT topic to publish commands to change the light's state.
-- **state_topic** (*Optional*): The MQTT topic subscribed to receive state updates.
-- **command_on_template** (*Required*): The [template](/docs/configuration/templating/#processing-incoming-data) for *on* state changes. Available variables: `state`, `brightness`, `red`, `green`, `blue`, `flash`, `transition` and `effect`.
-- **command_off_template** (*Required*): The [template](/docs/configuration/templating/#processing-incoming-data) for *off* state changes. Available variables: `state` and `transition`.
-- **state_template** (*Optional*): [Template](/docs/configuration/templating/#processing-incoming-data) to extract state from the state payload value.
-- **brightness_template** (*Optional*): [Template](/docs/configuration/templating/#processing-incoming-data) to extract brightness from the state payload value.
-- **red_template** (*Optional*): [Template](/docs/configuration/templating/#processing-incoming-data) to extract red color from the state payload value.
-- **green_template** (*Optional*): [Template](/docs/configuration/templating/#processing-incoming-data) to extract green color from the state payload value.
-- **blue_template** (*Optional*): [Template](/docs/configuration/templating/#processing-incoming-data) to extract blue color from the state payload value.
-- **color_temp_template** (*Optional*): [Template](/docs/configuration/templating/#processing-incoming-data) to extract color temperature from the state payload value.
-- **effect_template** (*Optional*): [Template](/docs/configuration/templating/#processing-incoming-data) to extract effect from the state payload value.
-- **white_value_template** (*Optional*): [Template](/docs/configuration/templating/#processing-incoming-data) to extract white value from the state payload value.
-- **optimistic** (*Optional*): Flag that defines if the light works in optimistic mode. Default is true if no state topic or state template is defined, else false.
-- **qos** (*Optional*): The maximum QoS level of the state topic. Default is 0 and will also be used to publishing messages.
+{% configuration %}
+name:
+ description: The name of the light.
+ required: false
+ type: string
+ default: MQTT Template Light
+effect_list:
+ description: List of possible effects.
+ required: false
+ type: string list
+command_topic:
+ description: The MQTT topic to publish commands to change the light’s state.
+ required: true
+ type: string
+state_topic:
+ description: The MQTT topic subscribed to receive state updates.
+ required: false
+ type: string
+command_on_template:
+ description: "The [template](/docs/configuration/templating/#processing-incoming-data) for *on* state changes. Available variables: `state`, `brightness`, `red`, `green`, `blue`, `flash`, `transition` and `effect`."
+ required: true
+ type: string
+command_off_template:
+ description: "The [template](/docs/configuration/templating/#processing-incoming-data) for *off* state changes. Available variables: `state` and `transition`."
+ required: true
+ type: string
+state_template:
+ description: "[Template](/docs/configuration/templating/#processing-incoming-data) to extract state from the state payload value."
+ required: false
+ type: string
+brightness_template:
+ description: "[Template](/docs/configuration/templating/#processing-incoming-data) to extract brightness from the state payload value."
+ required: false
+ type: string
+red_template:
+ description: "[Template](/docs/configuration/templating/#processing-incoming-data) to extract red color from the state payload value."
+ required: false
+ type: string
+green_template:
+ description: "[Template](/docs/configuration/templating/#processing-incoming-data) to extract green color from the state payload value."
+ required: false
+ type: string
+blue_template:
+ description: "[Template](/docs/configuration/templating/#processing-incoming-data) to extract blue color from the state payload value."
+ required: false
+ type: string
+color_temp_template:
+ description: "[Template](/docs/configuration/templating/#processing-incoming-data) to extract color temperature from the state payload value."
+ required: false
+ type: string
+effect_template:
+ description: "[Template](/docs/configuration/templating/#processing-incoming-data) to extract effect from the state payload value."
+ required: false
+ type: string
+white_value_template:
+ description: "[Template](/docs/configuration/templating/#processing-incoming-data) to extract white value from the state payload value."
+ required: false
+ type: string
+optimistic:
+ description: Flag that defines if the light works in optimistic mode.
+ required: false
+ type: string
+ default: "`true` if no state topic or state template is defined, else `false`."
+qos:
+ description: The maximum QoS level of the state topic.
+ required: false
+ type: integer
+ default: 0
+availability_topic:
+ description: The MQTT topic subscribed to receive availability (online/offline) updates.
+ required: false
+ type: string
+payload_available:
+ description: The payload that represents the available state.
+ required: false
+ type: string
+ default: online
+payload_not_available:
+ description: The payload that represents the unavailable state.
+ required: false
+ type: string
+ default: offline
+{% endconfiguration %}
Make sure that your topics match exact. `some-topic/` and `some-topic` are different topics.
diff --git a/source/_components/light.tplink.markdown b/source/_components/light.tplink.markdown
index 68fff983950..71fc4e97171 100644
--- a/source/_components/light.tplink.markdown
+++ b/source/_components/light.tplink.markdown
@@ -1,7 +1,7 @@
---
layout: page
-title: "TPLink Bulb"
-description: "Instructions how to integrate TPLink bulbs into Home Assistant."
+title: "TP-Link Bulb"
+description: "Instructions how to integrate TP-Link bulbs into Home Assistant."
date: 2017-07-25 08:00
sidebar: true
comments: false
@@ -14,7 +14,7 @@ ha_release: "0.50"
---
-The `tplink` light platform allows you to control the state of your [TPLink smart bulb](http://www.tp-link.com/en/products/list-5609.html).
+The `tplink` light platform allows you to control the state of your [TP-Link smart bulb](http://www.tp-link.com/en/products/list-5609.html).
Supported units:
@@ -23,7 +23,7 @@ Supported units:
- LB120
- LB130
-To use your TPLink light in your installation, add the following to your `configuration.yaml` file:
+To use your TP-Link light in your installation, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
@@ -32,9 +32,15 @@ light:
host: IP_ADDRESS
```
-Configuration variables:
-
-- **host** (*Required*): The IP address of your TP-Link bulb, eg. `192.168.1.32`.
-- **name** (*Optional*): The name to use when displaying this bulb.
-
+{% configuration %}
+name:
+ description: The name to use when displaying this bulb.
+ required: false
+ type: string
+ default: TP-Link Light
+host:
+ description: "The IP address of your TP-Link bulb, eg. `192.168.1.32`."
+ required: true
+ type: string
+{% endconfiguration %}
diff --git a/source/_components/lock.mqtt.markdown b/source/_components/lock.mqtt.markdown
index 6f91de7d133..8ed47ccf4ab 100644
--- a/source/_components/lock.mqtt.markdown
+++ b/source/_components/lock.mqtt.markdown
@@ -30,17 +30,64 @@ lock:
command_topic: "home/frontdoor/set"
```
-Configuration variables:
-
-- **command_topic** (*Required*): The MQTT topic to publish commands to change the lock state.
-- **name** (*Optional*): The name of the lock. Default is 'MQTT Lock'.
-- **state_topic** (*Optional*): The MQTT topic subscribed to receive state updates.
-- **payload_lock** (*Optional*): The payload that represents enabled/locked state. Default is "LOCK".
-- **payload_unlock** (*Optional*): The payload that represents disabled/unlocked state. Default is "UNLOCK".
-- **optimistic** (*Optional*): Flag that defines if lock works in optimistic mode. Default is `true` if no `state_topic` defined, else `false`.
-- **qos** (*Optional*): The maximum QoS level of the state topic. Default is 0 and will also be used to publishing messages.
-- **retain** (*Optional*): If the published message should have the retain flag on or not.
-- **value_template** (*Optional*): Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract a value from the payload.
+{% configuration %}
+name:
+ description: The name of the lock.
+ required: false
+ type: string
+ default: MQTT Lock
+command_topic:
+ description: The MQTT topic to publish commands to change the lock state.
+ required: true
+ type: string
+state_topic:
+ description: The MQTT topic subscribed to receive state updates.
+ required: false
+ type: string
+payload_lock:
+ description: The payload that represents enabled/locked state.
+ required: false
+ type: string
+ default: LOCK
+payload_unlock:
+ description: The payload that represents disabled/unlocked state.
+ required: false
+ type: string
+ default: UNLOCK
+optimistic:
+ description: Flag that defines if lock works in optimistic mode.
+ required: false
+ type: string
+ default: "`true` if no `state_topic` defined, else `false`."
+qos:
+ description: The maximum QoS level of the state topic.
+ required: false
+ type: integer
+ default: 0
+retain:
+ description: If the published message should have the retain flag on or not.
+ required: false
+ type: boolean
+ default: false
+value_template:
+ description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract a value from the payload."
+ required: false
+ type: string
+availability_topic:
+ description: The MQTT topic subscribed to receive availability (online/offline) updates.
+ required: false
+ type: string
+payload_available:
+ description: The payload that represents the available state.
+ required: false
+ type: string
+ default: online
+payload_not_available:
+ description: The payload that represents the unavailable state.
+ required: false
+ type: string
+ default: offline
+{% endconfiguration %}
Make sure that your topics match exactly. `some-topic/` and `some-topic` are different topics.
@@ -58,7 +105,7 @@ The example below shows a full configuration for a MQTT lock.
# Example configuration.yml entry
lock:
- platform: mqtt
- name: Frontdoor
+ name: Frontdoor
state_topic: "home-assistant/frontdoor/"
command_topic: "home-assistant/frontdoor/set"
payload_lock: "LOCK"
@@ -69,7 +116,7 @@ lock:
value_template: '{% raw %}{{ value.x }}{% endraw %}'
```
-Keep an eye on retaining messages to keep the state as you don't want to unlock your door by accident when you restart something.
+Keep an eye on retaining messages to keep the state as you don't want to unlock your door by accident when you restart something.
For a check you can use the command line tools `mosquitto_pub` shipped with `mosquitto` to send MQTT messages. This allows you to operate your lock manually:
diff --git a/source/_components/media_player.markdown b/source/_components/media_player.markdown
index 18350ce1326..5e19cf34e9c 100644
--- a/source/_components/media_player.markdown
+++ b/source/_components/media_player.markdown
@@ -58,7 +58,7 @@ Available services: `turn_on`, `turn_off`, `toggle`, `volume_up`, `volume_down`,
#### {% linkable_title Service `media_player/shuffle_set` %}
-Currently only supported on [Spotify](/components/media_player.spotify/), [MPD](/components/media_player.mpd/), [Kodi](/components/media_player.kodi/), and [Universal](/components/media_player.universal/).
+Currently only supported on [Spotify](/components/media_player.spotify/), [MPD](/components/media_player.mpd/), [Kodi](/components/media_player.kodi/), [Squeezebox](/components/media_player.squeezebox/) and [Universal](/components/media_player.universal/).
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ---------------------------------------------------- |
diff --git a/source/_components/media_player.monoprice.markdown b/source/_components/media_player.monoprice.markdown
index 7487e75b1e8..75e41d9b631 100644
--- a/source/_components/media_player.monoprice.markdown
+++ b/source/_components/media_player.monoprice.markdown
@@ -47,3 +47,25 @@ Configuration variables:
- **port** (*Required*): The serial port to which Monoprice amplifier is connected
- **zones** (*Required*): This is the list of zones available. Valid zones are 11,12,13,14,15,16. In case multiple Monoprice devices are stacked together the list of valid zones is extended by 21,22,23,24,25,26 for the second device and 31,32,33,34,35,36 for the third device. Each zone must have a name assigned to it.
- **sources** (*Required*): The list of sources available. Valid source numbers are 1,2,3,4,5,6. Each source number corresponds to the input number on the Monoprice amplifier. Similar to zones, each source must have a name assigned to it.
+
+### {% linkable_title Service `snapshot` %}
+
+Take a snapshot of one or more zones' states. This service, and the following one are useful if you want to play a doorbell or notification sound and resume playback afterward. If no `entity_id` is provided, all zones are snapshotted.
+
+The following attributes are stored in a snapshot:
+- Power status (On/Off)
+- Mute status (On/Off)
+- Volume level
+- Source
+
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | ----------- |
+| `entity_id` | yes | String or list of strings that point at `entity_id`s of zones.
+
+### {% linkable_title Service `restore` %}
+
+Restore a previously taken snapshot of one or more speakers. If no `entity_id` is provided, all zones are restored.
+
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | ----------- |
+| `entity_id` | yes | String or list of strings that point at `entity_id`s of zones.
diff --git a/source/_components/media_player.squeezebox.markdown b/source/_components/media_player.squeezebox.markdown
index d091d13b6d9..b226960e31b 100644
--- a/source/_components/media_player.squeezebox.markdown
+++ b/source/_components/media_player.squeezebox.markdown
@@ -33,3 +33,25 @@ Configuration variables:
- **password** (*Optional*): The password, if password protection is enabled.
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.
+
+### {% linkable_title Service `squeezebox_call_method` %}
+
+Call a custom Squeezebox JSONRPC API.
+
+See documentation for this interface on http://HOST:PORT/html/docs/cli-api.html?player= where HOST and PORT are the host name and port for your Logitech Media Server.
+
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | ----------- |
+| `entity_id` | no | Name(s) of the Squeezebox entities where to run the API method.
+| `command` | no | Command to pass to Logitech Media Server (p0 in the CLI documentation).
+| `parameters` | yes | Array of additional parameters to pass to Logitech Media Server (p1, ..., pN in the CLI documentation).
+
+This service can be used to integrate any Squeezebox action to an automation.
+
+It can also be used to target a Squeezebox from IFTT (or DialogFlow, Alexa...).
+
+For example, to play an album from your collection, create an IFTT applet like this:
+- Trigger: Google assistant, with sentence: `I want to listen to album $`
+- Action: JSON post query with such JSON body:
+`{ "entity_id": "media_player.squeezebox_radio", "command": "playlist", "parameters": ["loadtracks", "album.titlesearch={{TextField}}"] }`
+This can work with title search and basically any thing. The same wouldn't have worked by calling directly Squeezebox server as IFTT cannot escape the text field.
diff --git a/source/_components/media_player.yamaha.markdown b/source/_components/media_player.yamaha.markdown
index 8ab1d511144..c958aa1466c 100644
--- a/source/_components/media_player.yamaha.markdown
+++ b/source/_components/media_player.yamaha.markdown
@@ -36,7 +36,9 @@ Configuration variables:
default name (often model number) that is returned by the device.
- **host** (*Optional*): IP address or hostname of the device
- **source_ignore** (*Optional*): List of sources to hide in the front-end
-- **source_names** (*Optional*): Mapping of internal AVR source names to custom ones, allowing to rename e.g. `HDMI1` to `ChromeCast`
+- **source_names** (*Optional*): Mapping of internal AVR source names to custom ones, allowing one to rename e.g. `HDMI1` to `ChromeCast`
+- **zone_ignore** (*Optional*): List of zones to hide in the front-end
+- **zone_names** (*Optional*): Mapping of zone names to custom ones, allowing one to rename e.g. `Main_Zone` to `Family Room`
### {% linkable_title Discovery notes %}
@@ -76,6 +78,10 @@ media_player:
source_names:
HDMI1: "ChromeCast"
AV4: "Vinyl"
+ zone_ignore:
+ - "Zone_2"
+ zone_names:
+ Main_Zone: "Family Room"
```
### {% linkable_title Example `play_media` script %}
diff --git a/source/_components/modbus.markdown b/source/_components/modbus.markdown
index f673298d82e..9d560058290 100644
--- a/source/_components/modbus.markdown
+++ b/source/_components/modbus.markdown
@@ -30,7 +30,10 @@ modbus:
Configuration variables:
-- **type** (*Required*): Type of the connection to Modbus.
+- **type** (*Required*): Type of the connection to Modbus. Possible values are:
+ - *tcp*: Modbus TCP protocol according to "MODBUS Messaging Implementation Guide version 1.0b" provided by Schneider Automation,
+ - *udp*: Modbus TCP form, but using UDP for transport (removes the overheads required for TCP),
+ - *rtuovertcp*: Modbus RTU message transmitted with a TCP/IP wrapper and sent over a network instead of serial lines.
- **host** (*Required*): The IP address of your Modbus device, eg. 192.168.1.1.
- **port** (*Required*): The port for the communication.
- **timeout** (*Optional*): Timeout for slave response in seconds. (default: 3)
@@ -51,7 +54,7 @@ modbus:
Configuration variables:
-- **type** (*Required*): Type of the connection to Modebus.
+- **type** (*Required*): Type of the connection to Modbus.
- **method** (*Required*): Method of the connection to Modbus.
- **port** (*Required*): The port where your Modbus device is connected to your Home Assistant host.
- **baudrate** (*Required*): The speed for the serial connection.
diff --git a/source/_components/notify.pushsafer.markdown b/source/_components/notify.pushsafer.markdown
index 4b003d97d82..a62e213e747 100644
--- a/source/_components/notify.pushsafer.markdown
+++ b/source/_components/notify.pushsafer.markdown
@@ -2,7 +2,7 @@
layout: page
title: "Pushsafer"
description: "Instructions how to add Pushsafer notifications to Home Assistant."
-date: 2017-02-17 20:46
+date: 2018-01-05 11:15
sidebar: true
comments: false
sharing: true
@@ -27,11 +27,78 @@ notify:
private_key: ABCDEFGHJKLMNOPQRSTUVXYZ
```
-Configuration variables:
+**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`.
- **private_key** (*Required*): Your private or alias key. Private key = send the notification to all devices with standard params, alias key send the notification to the devices stored in the alias with predefined params.
+### {% linkable_title Examples %}
+
+Message to two devices with formated text.
+
+```json
+{
+ "title": "Test to 2 devices",
+ "message": "Attention [b]bold[/b] text[br][url=https://www.pushsafer.com]Link to Pushsafer[/url]",
+ "target": ["1111", "2222"],
+ "data": {
+ "icon": "2",
+ "iconcolor": "#FF0000",
+ "sound": "2",
+ "vibration": "1",
+ "url": "https://home-assistant.io/",
+ "urltitle": "Open Home Assistant",
+ "time2live": "0"
+ }
+}
+```
+
+Message to one device with formated text and image from an external URL.
+
+```json
+{
+ "title": "Test to 1 device with image from an url",
+ "message": "Attention [i]italic[/i] Text[br][url=https://home-assistant.io/]Testlink[/url]",
+ "target": ["1111"],
+ "data": {
+ "icon": "14",
+ "iconcolor": "#FFFF00",
+ "sound": "22",
+ "vibration": "3",
+ "url": "https://home-assistant.io/",
+ "urltitle": "Open Home Assistant",
+ "time2live": "60",
+ "picture1": {
+ "url":"https://home-assistant.io/images/components/alexa/alexa-512x512.png"
+ }
+ }
+}
+```
+
+Message to two devices and one device group with formated text and local image.
+
+```json
+{
+ "title": "Test to 3 devices with local image",
+ "message": "Attention [i]italic[/i] Text[br][url=https://home-assistant.io/]Testlink[/url]",
+ "target": ["1111","2222","gs3333"],
+ "data": {
+ "icon": "20",
+ "iconcolor": "#FF00FF",
+ "sound": "33",
+ "vibration": "0",
+ "url": "https://home-assistant.io/",
+ "urltitle": "Open Home Assistant",
+ "time2live": "10",
+ "picture1": {
+ "path":"C:\\Users\\Kevin\\AppData\\Roaming\\.homeassistant\\image-760-testimage.jpg"
+ }
+ }
+}
+```
+
+To customize your push-notification you can take a look at the [Pushsafer API description](https://www.pushsafer.com/en/pushapi).
+
When setting up the application you can use this [icon](https://home-assistant.io/images/favicon-192x192.png).
To use notifications, please see the [getting started with automation page](/getting-started/automation/).
diff --git a/source/_components/notify.webostv.markdown b/source/_components/notify.webostv.markdown
index 408c31eef02..8064c8fbf85 100644
--- a/source/_components/notify.webostv.markdown
+++ b/source/_components/notify.webostv.markdown
@@ -33,7 +33,7 @@ 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. If provided, this image will override the Home Assistant logo.
+- **icon** (*Optional*): The path to an image file to use as the icon in notifications.
A possible automation could be:
diff --git a/source/_components/nuheat.markdown b/source/_components/nuheat.markdown
new file mode 100644
index 00000000000..a261aececba
--- /dev/null
+++ b/source/_components/nuheat.markdown
@@ -0,0 +1,51 @@
+---
+layout: page
+title: "NuHeat"
+description: "Instructions how to integrate your NuHeat Signature thermostats within Home Assistant."
+date: 2017-11-11 18:00
+sidebar: true
+comments: false
+sharing: true
+footer: true
+logo: nuheat.png
+ha_category: Hub
+ha_release: 0.61
+ha_iot_class: "Cloud Polling"
+---
+
+The `nuheat` component lets you control connected floor heating thermostats from [NuHeat](http://www.nuheat.com/).
+
+First, you will need to obtain your thermostat's numeric serial number or ID by logging into [MyNuHeat.com](https://mynuheat.com/) and selecting your thermostat(s).
+
+Once you have the Thermostat ID(s), add the following information to your `configuration.yaml` file:
+
+```yaml
+# Example configuration.yaml entry
+nuheat:
+ username: you@example.com
+ password: very-secure-password
+ devices: 12345
+
+# Example configuration.yaml entry with multiple thermostats
+nuheat:
+ username: you@example.com
+ password: very-secure-password
+ devices:
+ - 12345
+ - 67890
+```
+
+{% configuration %}
+username:
+ description: The username for accessing your MyNuHeat account.
+ required: true
+ type: string
+password:
+ description: The password for accessing your MyNuHeat account.
+ required: true
+ type: string
+devices:
+ description: The serial number/ID of each thermostat you would like to integrate.
+ required: true
+ type: [string, int]
+{% endconfiguration %}
diff --git a/source/_components/rainbird.markdown b/source/_components/rainbird.markdown
new file mode 100644
index 00000000000..4257826b7d4
--- /dev/null
+++ b/source/_components/rainbird.markdown
@@ -0,0 +1,33 @@
+---
+layout: page
+title: "Rain Bird"
+description: "Instructions on how to integrate your Rain Bird LNK WiFi Module within Home Assistant."
+date: 2017-12-07 12:00
+sidebar: true
+comments: false
+sharing: true
+footer: true
+logo: rainbird.png
+ha_category: Hub
+ha_release: 0.61
+ha_iot_class: "Local Polling"
+---
+
+This `rainbird` component allows interacting with [LNK WiFi](http://www.rainbird.com/landscape/products/controllers/LNK-WiFi.htm) module of the Rain Bird Irrigation system in Home Assistant.
+
+To enable it, add the following to your `configuration.yaml` file:
+
+```yaml
+rainbird:
+ host: '1.1.1.1'
+ password: 'XXXXXXX'
+```
+
+Configuration variables:
+
+- **host** (*Required*): The IP address of your LNK WiFi Module.
+- **password** (*Required*): The password for accessing the module.
+
+Finish its configuration by visiting the [Rain Bird sensor](/components/sensor.rainbird/) and [Rain Bird switch](/components/switch.rainbird/) documentation.
+
+Please note that due to the implementation of the API within the LNK Module, there is a concurrency issue. For example, the Rain Bird app will give connection issues (like already a connection active).
diff --git a/source/_components/remember_the_milk.markdown b/source/_components/remember_the_milk.markdown
index d4cc22fa10d..1c3169028b1 100644
--- a/source/_components/remember_the_milk.markdown
+++ b/source/_components/remember_the_milk.markdown
@@ -59,12 +59,61 @@ If the registration was successful, the Configuration panel will disappear from
In the background Home Assistant downloaded a "token" from the Remember The Milk server which is stored in the `remember_the_milk.conf` file locally. So you only need to register once. After that the token is used to authenticate with the server.
-## {% linkable_title Creating tasks %}
+## {% linkable_title Creating/updating tasks with service ```create_task```%}
-This component offers a new service domain ```remember_the_milk``` with the service ```create_task```. You can call this service with the argument ```name``` to create a new task in your Remember The Milk account. You can call this service from your usual automations.
+This component offers a new service domain ```remember_the_milk``` with the services ```_create_task```. You can call this service with the argument ```name``` and the optional parameter ```id``` to create a new task in your Remember The Milk account. You can call this service from your usual automations.
+
+If you set an ```id``` and a task with that id exists already, the existing task is updated, rather than creating a new task. This way you can change the name of the task. If you do not set an ```id```, a new task is created with every call. If you're using this from an automation, you could use the name of your automation as id or the entity that triggered the task to be created. This way you can later on update or complete this task.
The task creation supports the "smart syntax", so to create a task with the tag "from_hass" which is due today you can create a task with the name ```test task created in Home Assistant ^today #from_hass```. More info about the smart syntax is available on the [Remember The Milk documentation](https://www.rememberthemilk.com/help/answer/basics-smartadd-howdoiuse).
+**Note:**
+At the moment, smart syntax is *not* supported when updating tasks. All smart syntax commands are ignored during the update and will end up as normal text in the name of the task.
+
+|Service data attribute | Optional | Description | Example |
+|-----------------------|----------|-------------|---------|
+| name | no | Name of the new task, you can use the smart syntax here. | "do this ^today #from_hass" |
+| id | yes | Identifier for the task you're creating, can be used to update or complete the task later on | "myid" |
+
+## {% linkable_title Completing tasks with service ```complete_task```%}
+
+Complete a tasks that was privously created from Home Assistant. You can not complete tasks that were created outside of Home Assistant.
+
+If you have created your task with an ```id```, calling ```_complete_task``` with the parameter ```id``` will then complete your task.
+
+|Service data attribute | Optional | Description | Example |
+|-----------------------|----------|-------------|---------|
+| id | no | Identifier that was defined when creating the task | "myid" |
+
+## {% linkable_title Automation example %}
+
+Here's an example for an automation that creates a new task whenever ```sensor.mysensor``` is ```on``` and completes it when the sensor reports ```off```. This way it reminds you to switch it off. By using the ```entity_id``` as id for the task, you can use the same rule also for multiple sensors.
+
+
+```yaml
+- id: mysensor_on
+ trigger:
+ platform: state
+ entity_id: sensor.mysensor
+ to: on
+ action:
+ - service: remember_the_milk.myaccount_create_task
+ data_template:
+ name: "Please switch of {{trigger.entity_id}}"
+ id: "{{trigger.entity_id}}"
+- id: mysensor_off
+ trigger:
+ platform: state
+ entity_id: sensor.mysensor
+ to: off
+ action:
+ - service: remember_the_milk.myaccount_complete_task
+ data_template:
+ id: "{{trigger.entity_id}}"
+
+```
+
+
## {% linkable_title Disclaimer %}
This product uses the Remember The Milk API but is not endorsed or certified by Remember The Milk.
diff --git a/source/_components/scene.deconz.markdown b/source/_components/scene.deconz.markdown
new file mode 100644
index 00000000000..b5fdf7fa7fe
--- /dev/null
+++ b/source/_components/scene.deconz.markdown
@@ -0,0 +1,18 @@
+---
+layout: page
+title: "deCONZ scenes"
+description: "Instructions on how to integrate deCONZ scenes into Home Assistant."
+date: 2017-11-19 20:00
+sidebar: true
+comments: false
+sharing: true
+footer: true
+logo: deconz.jpeg
+ha_category: Scene
+ha_release: "0.61"
+ha_iot_class: "Local Push"
+---
+
+See the [deCONZ main component](/components/deconz/) for configuration instructions.
+
+Entity Ids will be scene.group_scene_name, where group is which group the scene belongs to and the name of the scene, both group and name are defined in deCONZ.
\ No newline at end of file
diff --git a/source/_components/sensor.alpha_vantage.markdown b/source/_components/sensor.alpha_vantage.markdown
index 3e78232b24b..29712a8d0c9 100644
--- a/source/_components/sensor.alpha_vantage.markdown
+++ b/source/_components/sensor.alpha_vantage.markdown
@@ -33,21 +33,58 @@ api_key:
symbols:
description: List of stock market symbols for given companies.
required: false
- type: string, list
default: GOOGL
+ type: map
+ keys:
+ name:
+ description: The name of the sensor to use for the frontend.
+ required: false
+ type: string
+ currency:
+ description: The name of the sensor to use for the frontend.
+ required: false
+ type: string
+ default: USD
+ symbol:
+ description: The stock market symbol for the given company.
+ required: required
+ type: string
+foreign_exchange:
+ description: List of currencies.
+ type: map
+ required: false
+ keys:
+ name:
+ description: The name of the sensor to use for the frontend.
+ required: false
+ type: string
+ from:
+ description: The source currency.
+ required: required
+ type: string
+ to:
+ description: The target currency.
+ required: required
+ type: string
{% endconfiguration %}
## {% linkable_title Examples %}
In this section you find some real life examples of how to use this sensor.
-### {% linkable_title Red Hat and Google %}
+### {% linkable_title Google and the exchange rate for Bitcoin %}
```yaml
sensor:
- platform: alpha_vantage
+ api_key: YOUR_API_KEY
symbols:
- - RHT
- - GOOGL
+ - name: Google
+ currency: USD
+ symbol: GOOGL
+ foreign_exchange:
+ - from: BTC
+ to: USD
+ name: Bitcoin
```
diff --git a/source/_components/sensor.coinbase.markdown b/source/_components/sensor.coinbase.markdown
new file mode 100644
index 00000000000..89c06fc6f35
--- /dev/null
+++ b/source/_components/sensor.coinbase.markdown
@@ -0,0 +1,15 @@
+---
+layout: page
+title: "Coinbase Sensor"
+description: "Instructions how to setup Coinbase sensors within Home Assistant."
+date: 2017-12-08 18:00
+sidebar: true
+comments: false
+sharing: true
+footer: true
+logo: coinbase.png
+ha_category: Sensor
+ha_release: 0.61
+---
+
+To get your coinbase sensors working with Home Assistant, follow the instructions for the general [Coinbase component](/components/coinbase/).
diff --git a/source/_components/sensor.daikin.markdown b/source/_components/sensor.daikin.markdown
new file mode 100644
index 00000000000..dfb69786405
--- /dev/null
+++ b/source/_components/sensor.daikin.markdown
@@ -0,0 +1,61 @@
+---
+layout: page
+title: "Daikin AC"
+description: "Instructions on how to integrate Daikin AC(s) with Home Assistant."
+date: 2017-12-03 05:00
+sidebar: false
+comments: false
+sharing: true
+footer: true
+logo: N/A
+ha_category: Climate
+ha_release: 0.59
+ha_iot_class: "Local Polling"
+---
+
+### Description ###
+
+The sensor component integrates Daikin air conditioning systems into Home Assistant, enabling displaying the following parameters:
+- **inside temperature**
+- **outside temperature**
+
+
+ Please note, the `daikin` platform integrates **ONLY the european versions of Daikin ACs (models BRP069A41, 42, 43, 45)** into Home Assistant
+
+
+### Configuration ###
+
+Manual configuration and customization is possible by using the sample configuration from below:
+
+```yaml
+# Example configuration.yaml entry
+sensor:
+ - platform: daikin
+ host: 10.0.0.1
+ name: optional name
+ monitored_conditions:
+ - inside_temperature
+ - outside_temperature
+
+```
+
+{% configuration %}
+host:
+ description: IP or hostname of the device.
+ required: true
+ type: string
+monitored_conditions:
+ description: List of items you want to monitor for each device.
+ required: false
+ detault: All conditions
+ type: list
+ keys:
+ inside_temperature:
+ description: The current temperature measured inside the house.
+ outside_temperature:
+ description: The current temperature measured outside the house.
+{% endconfiguration %}
+
+
+ Please note that some AC devices may report outside temperature only when they are turned on.
+
diff --git a/source/_components/sensor.darksky.markdown b/source/_components/sensor.darksky.markdown
index ee366dfa66e..427d5afb683 100644
--- a/source/_components/sensor.darksky.markdown
+++ b/source/_components/sensor.darksky.markdown
@@ -1,6 +1,6 @@
---
layout: page
-title: "Dark Sky"
+title: "Dark Sky Sensor"
description: "How to integrate Dark Sky within Home Assistant."
date: 2016-09-26 08:00
sidebar: true
@@ -20,7 +20,7 @@ The `darksky` platform uses the [Dark Sky](https://darksky.net/) web service as
You need an API key which is free but requires [registration](https://darksky.net/dev/register). You can make up to 1000 calls per day for free which means that you could make one approximately every 86 seconds.
-[Dark Sky](https://darksky.net/) will charge you $0.0001 per API call if you enter your credit card details and create more than 1000 calls per day.
+[Dark Sky](https://darksky.net/dev/) will charge you $0.0001 per API call if you enter your credit card details and create more than 1000 calls per day.
To add Dark Sky to your installation, add the following to your `configuration.yaml` file:
@@ -67,7 +67,7 @@ Configuration variables:
- **apparent_temperature_min**: Today's expected apparent low temperature.
- **precip_intensity_max**: Today's expected maximum intensity of precipitation.
- **uv_index**: The current UV index.
-- **units** (*Optional*): Specify the unit system. Default to `si` or `us` based on the temperature preference in Home Assistant. Other options are `auto`, `us`, `si`, `ca`, and `uk2`.
+- **units** (*Optional*): Specify the unit system. Default to `si` or `us` based on the temperature preference in Home Assistant. Other options are `auto`, `us`, `si`, `ca`, `uk` and `uk2`.
`auto` will let Dark Sky decide the unit system based on location.
- **update_interval** (*Optional*): Minimum time interval between updates. Default is 2 minutes. Supported formats:
- `update_interval: 'HH:MM:SS'`
diff --git a/source/_components/sensor.deconz.markdown b/source/_components/sensor.deconz.markdown
new file mode 100644
index 00000000000..6844c88d833
--- /dev/null
+++ b/source/_components/sensor.deconz.markdown
@@ -0,0 +1,45 @@
+---
+layout: page
+title: deCONZ Sensor
+description: "Instructions on how to integrate Zigbee sensors from deCONZ into Home Assistant."
+date: 2017-11-12 16:30
+sidebar: true
+comments: false
+sharing: true
+footer: true
+logo: deconz.jpeg
+ha_category: Sensor
+ha_release: "0.61"
+ha_iot_class: "Local Push"
+---
+
+See the [deCONZ main component](/components/deconz/) for configuration instructions.
+
+The following sensor types are supported:
+
+ * Humidity sensor
+ * Light level sensor
+ * Pressure sensor
+ * Switches
+ * Temperature sensor
+
+Entity ids will be sensor.device_name, where device_name is defined in deCONZ. Switches aren't exposed as ordinary entities, see the [deCONZ main component](/components/deconz/) for more details.
+
+#### {% linkable_title Verified to be supported sensors %}
+
+- Humidity Sensor
+ - Xiaomi Aqara Humidity/Temperature Sensor
+ - Xiaomi MiJia Smart Temperature & Humidity Sensor
+- Light Level Sensor
+- Pressure Sensor
+- Switches
+ - IKEA Trådfri Wireless Dimmer
+ - Philips Hue Motion Sensor
+ - IKEA Trådfri Remote
+ - Philips Hue Dimmer Switch
+ - Xiaomi Cube
+ - Xiaomi Aqara Smart Light Switch
+ - Xiaomi Aqara Smart Wireless Switch
+ - Xiaomi Smart Home Wireless Switch
+- Temperature Sensor
+ - Xiaomi Temperature/Humidity Sensor
diff --git a/source/_components/sensor.discogs.markdown b/source/_components/sensor.discogs.markdown
new file mode 100644
index 00000000000..281852abc79
--- /dev/null
+++ b/source/_components/sensor.discogs.markdown
@@ -0,0 +1,40 @@
+---
+layout: page
+title: Discogs Sensor
+description: "Instructions on how to set up Discogs sensors within Home Assistant."
+date: 2017-12-04 22:00
+sidebar: true
+comments: false
+sharing: true
+footer: true
+logo: https://www.magneticmag.com/.image/t_share/MTQ5OTE1NzU4NTczMzk3OTYw/discogs-vinyl-record-mark.png
+ha_category: Sensor
+ha_release: 0.61
+logo: discogs.png
+ha_iot_class: "Cloud Polling"
+---
+
+The `discogs` platform allows you to see the current amount of records in your [Discogs](https://discogs.com) collection.
+
+First, you'll need to get a personal access token from your Discogs account.
+You can generate a token from your profile's [Developer settings](https://www.discogs.com/settings/developers).
+
+To enable this sensor, add the following lines to your `configuration.yaml`:
+
+```yaml
+# Example configuration.yaml entry
+sensor:
+ - platform: discogs
+ token: YOUR_TOKEN
+```
+
+{% configuration %}
+token:
+ description: The Discogs API token to use as identification to get your collection.
+ required: true
+ type: string
+name:
+ description: Name to use in the frontend.
+ required: false
+ type: string
+{% endconfiguration %}
diff --git a/source/_components/sensor.eliqonline.markdown b/source/_components/sensor.eliqonline.markdown
index 7d8452595fc..87dd5ac8fd6 100644
--- a/source/_components/sensor.eliqonline.markdown
+++ b/source/_components/sensor.eliqonline.markdown
@@ -14,7 +14,7 @@ ha_iot_class: "Cloud Polling"
---
-Integrate your [ELIQ Online](http://eliq.se) smart meter information into Home Assistant. To get an [access token](https://my.eliq.se/user/settings/api) and the [Channel ID](https://my.eliq.se/user/settings/data), log in to your account.
+Integrate your [ELIQ Online](http://eliq.io) smart meter information into Home Assistant. To get an [access token](https://my.eliq.io/user/settings/api) and the [Channel ID](https://my.eliq.io/user/settings/locations), log in to your account.
To enable this sensor in your installation, add the following to your `configuration.yaml` file:
@@ -23,6 +23,7 @@ To enable this sensor in your installation, add the following to your `configura
sensor:
- platform: eliqonline
access_token: ACCESS_TOKEN
+ channel_id: CHANNEL_ID
```
Configuration variables:
@@ -31,5 +32,5 @@ Configuration variables:
- **channel_id** (*Required*): Channel ID (as integer) of your device.
- **name** (*Optional*): The name of the sensor, eg. the city.
-For details please check the [API documentation](https://my.eliq.se/knowledge/sv-SE/49-eliq-online/299-eliq-online-api).
+For details please check the [API documentation](https://eliq.zendesk.com/hc/en-us/articles/115002708449-API-Eliq-Online).
diff --git a/source/_components/sensor.imap_email_content.markdown b/source/_components/sensor.imap_email_content.markdown
index cb639b436cf..35f9d2d694a 100644
--- a/source/_components/sensor.imap_email_content.markdown
+++ b/source/_components/sensor.imap_email_content.markdown
@@ -38,7 +38,7 @@ Configuration variables:
- **username** (*Required*): Username for the IMAP server.
- **password** (*Required*): Password for the IMAP server.
- **senders** (*Required*): A list of sender email addresses that are allowed to report state via email. Only emails received from these addresses will be processed.
-- **value_template** (*Optional*): If specified this template will be used to render the state of sensor. If a template is not supplied the raw message body will be used for the sensor value. The following attributes will be supplied to the template:
+- **value_template** (*Optional*): If specified this template will be used to render the state of the sensor. If a template is not supplied the message subject will be used for the sensor value. The following attributes will be supplied to the template:
* **from**: The from address of the email
* **body**: The body of the email
diff --git a/source/_components/sensor.metoffice.markdown b/source/_components/sensor.metoffice.markdown
index 8a327524c0e..ff622357718 100644
--- a/source/_components/sensor.metoffice.markdown
+++ b/source/_components/sensor.metoffice.markdown
@@ -15,8 +15,8 @@ ha_iot_class: "Cloud Polling"
The `metoffice` sensor platform uses the Met Office's [DataPoint API][datapoint] for weather data.
-- Each sensor will be given the `device_id` of "Met Office [condition]"
-- The sensor checks for new data every minute, starting 30 minutes after the timestamp of the most recent data as the data is updated every half-hour.
+- Each sensor will be given the `device_id` of "Met Office [condition]" if `name:` is not set.
+- The sensor checks for new data every minute, starting 30 minutes after the timestamp of the most recent data as the data is updated every half hour.
To add the Met Office weather to your installation you'll need to register for a free api key at the link above and then add the following to your `configuration.yaml` file:
@@ -24,7 +24,7 @@ To add the Met Office weather to your installation you'll need to register for a
# Example configuration.yaml entry
sensor:
- platform: metoffice
- api_key: "my-api-key"
+ api_key: YOUR_API_KEY
monitored_conditions:
- weather
- temperature
@@ -43,12 +43,25 @@ Your location will be detected from your home `latitude` and `longitude` setting
Configuration variables:
-- **api_key** (*Required*): Your personal API key from the [Datapoint website][datapoint].
-- **name** (*Optional*): Name to use in the frontend, will be the prefix.
+- **api_key** (*Required*): Your personal API key from the [Datapoint website](http://www.metoffice.gov.uk/datapoint).
+- **name** (*Optional*): Additional name for the sensors. Default to platform name.
+- **latitude** (*Optional*): Latitude coordinate to monitor weather of (required if **longitude** is specified), defaults to coordinates defined in your `configuration.yaml`.
+- **longitude** (*Optional*): Longitude coordinate to monitor weather of (required if **latitude** is specified), defaults to coordinates defined in your `configuration.yaml`.
+- **monitored_conditions** array (*Required*): Conditions to display in the frontend.
+ - **weather**: A human-readable text summary of the current conditions.
+ - **temperature**: The current temperature.
+ - **feels_like_temperature**: A numerical value representing the apparent (or "feels like") temperature.
+ - **wind_speed**: The wind speed.
+ - **wind_direction**: Where the wind is coming from.
+ - **wind_gust**: If there are wind gusts.
+ - **visibility**: The average visibility.
+ - **visibility_distance**: The visibility distance.
+ - **uv**: The UV index.
+ - **precipitation**: The average expected intensity of precipitation occurring.
+ - **humidity**: The relative humidity.
This sensor is an alternative to the [`metoffice`](/components/weather.metoffice/) weather platform.
The weather platform is easier to configure but less customizable.
-[datapoint]: http://www.metoffice.gov.uk/datapoint
diff --git a/source/_components/sensor.mqtt.markdown b/source/_components/sensor.mqtt.markdown
index 0fb3ab1175f..2f80c563b15 100644
--- a/source/_components/sensor.mqtt.markdown
+++ b/source/_components/sensor.mqtt.markdown
@@ -58,6 +58,24 @@ force_update:
reqired: false
type: boolean
default: False
+availability_topic:
+ description: The MQTT topic subscribed to receive availability (online/offline) updates.
+ required: false
+ type: string
+payload_available:
+ description: The payload that represents the available state.
+ required: false
+ type: string
+ default: online
+payload_not_available:
+ description: The payload that represents the unavailable state.
+ required: false
+ type: string
+ default: offline
+json_attributes:
+ description: A list of keys to extract values from a JSON dictionary payload and then set as sensor attributes.
+ reqired: false
+ type: list, string
{% endconfiguration %}
## {% linkable_title Examples %}
diff --git a/source/_components/sensor.plex.markdown b/source/_components/sensor.plex.markdown
index f3dcd7affae..34781716237 100644
--- a/source/_components/sensor.plex.markdown
+++ b/source/_components/sensor.plex.markdown
@@ -36,3 +36,4 @@ Configuration variables:
- **password** (*Optional*): The password for your given account on the remote Plex server.
- **server** (*Optional*): The name of your remote Plex server.
- **token** (*Optional*): X-Plex-Token of your remote Plex server.
+- **ssl** (*Optional*): Use HTTPS to connect to Plex server, *NOTE* host *must not* be an IP when this option is enabled. Defaults to "False"
diff --git a/source/_components/sensor.rainbird.markdown b/source/_components/sensor.rainbird.markdown
new file mode 100644
index 00000000000..aebb59be073
--- /dev/null
+++ b/source/_components/sensor.rainbird.markdown
@@ -0,0 +1,32 @@
+---
+layout: page
+title: "Rain Bird Sensor"
+description: "Instructions on how to integrate your Rain Bird LNK WiFi Module rain sensor within Home Assistant."
+date: 2017-08-25 12:00
+sidebar: true
+comments: false
+sharing: true
+footer: true
+logo: rainbird.png
+ha_category: Hub
+ha_release: 0.61
+ha_iot_class: "Local Polling"
+---
+
+This `rainbird` sensor allows interacting with [LNK WiFi](http://www.rainbird.com/landscape/products/controllers/LNK-WiFi.htm) module of the Rain Bird Irrigation system in Home Assistant.
+
+Once you have enabled the [Rain Bird component](/components/rainburd), add the following to your `configuration.yaml` file to enable the rain sensor:
+
+```yaml
+# Example configuration.yaml entry
+sensor:
+ - platform: rainbird
+ monitored_conditions:
+ - rainsensor
+```
+
+Configuration variables:
+
+- **monitored_conditions**: Currently only rainsensor is supported. Returns the sensor level.
+
+Please note that due to the implementation of the API within the LNK Module, there is a concurrency issue. For example, the Rain Bird app will give connection issues (like already a connection active).
diff --git a/source/_components/sensor.sochain.markdown b/source/_components/sensor.sochain.markdown
new file mode 100644
index 00000000000..77bf1c78364
--- /dev/null
+++ b/source/_components/sensor.sochain.markdown
@@ -0,0 +1,50 @@
+---
+layout: page
+title: "SoChain"
+description: "Instructions how to integrate chain.so data within Home Assistant."
+date: 2017-06-01 16:20
+sidebar: true
+comments: false
+sharing: true
+footer: true
+logo: sochain.png
+ha_category: Finance
+ha_release: 0.61
+ha_iot_class: "Cloud Polling"
+---
+
+
+The `SoChain` sensor platform displays supported cryptocurrency wallet balances from [SoChain](https://chain.so).
+
+To add the SoChain sensor to your installation, specify a network and address to watch in the `configuration.yaml` file:
+
+```yaml
+# Example configuration.yaml entry
+sensor:
+ - platform: sochain
+ network: LTC
+ address: 'M9m37h3dVkLDS13wYK7vcs7ck6MMMX6yhK'
+```
+
+{% configuration %}
+network:
+ description: The network or blockchain of the cryptocurrency to watch.
+ required: true
+ type: string
+address:
+ description: Cryptocurrency wallet address to watch.
+ required: true
+ type: string
+name:
+ description: The name of the sensor used in the frontend. (recommended)
+ required: false
+ type: string
+ default: Crypto Balance
+{% endconfiguration %}
+
+Supported networks (which can also be found [here](https://chain.so/api#networks-supported)) are:
+
+* BTC
+* LTC
+* DOGE
+* DASH
diff --git a/source/_components/sensor.zoneminder.markdown b/source/_components/sensor.zoneminder.markdown
index 5ab384d0020..e60e2742058 100644
--- a/source/_components/sensor.zoneminder.markdown
+++ b/source/_components/sensor.zoneminder.markdown
@@ -32,3 +32,10 @@ sensor:
Configuration variables:
- **include_archived** (*Optional*): Whether to include archived ZoneMinder events in event counts. Default is `false`.
+- **monitored_conditions** array (*Optional*): Event count sensors to display in the frontend. Default is 'all'.
+ - **all**: All events.
+ - **month**: Events in the last month.
+ - **week**: Events in the last week.
+ - **day**: Events in the last day.
+ - **hour**: Events in the last hour.
+
diff --git a/source/_components/switch.insteon_local.markdown b/source/_components/switch.insteon_local.markdown
index 0200b5cd439..0d8c71aa8d8 100644
--- a/source/_components/switch.insteon_local.markdown
+++ b/source/_components/switch.insteon_local.markdown
@@ -14,20 +14,4 @@ ha_version: 0.36
The `insteon_local` switch component lets you control your switches connected to an [Insteon Hub](http://www.insteon.com/insteon-hub/) with Home Assistant.
-To integrate add a switch, configure your hub Insteon(local) with Home Assistant, add the following section to your `configuration.yaml` file:
-```yaml
-# Example configuration.yaml platform entry
-insteon_local:
- host: YOUR HUB IP
- username: YOUR HUB USERNAME
- password: YOUR HUB PASSWORD
- timeout: 10
- port: 25105
-```
-
-To add switches to your set-up, add the platform to your light configuration:
-```yaml
-switch:
- - platform: insteon_local
-```
-
+To get your insteon switches working with Home Assistant, follow the instructions for the general [Insteon local component](/components/insteon_local/). The switches will be automatically disovered and added to Home Assistant. The device names will be the Insteon address of the switch.
diff --git a/source/_components/switch.mqtt.markdown b/source/_components/switch.mqtt.markdown
index 4ad0a6c1f87..3804130cc61 100644
--- a/source/_components/switch.mqtt.markdown
+++ b/source/_components/switch.mqtt.markdown
@@ -30,20 +30,64 @@ switch:
command_topic: "home/bedroom/switch1/set"
```
-Configuration variables:
-
-- **name** (*Optional*): The name of the switch. Default is 'MQTT Switch'.
-- **state_topic** (*Optional*): The MQTT topic subscribed to receive state updates.
-- **command_topic** (*Required*): The MQTT topic to publish commands to change the switch state.
-- **availability_topic** (*Optional*): The MQTT topic subscribed to receive availability (online/offline) updates.
-- **payload_on** (*Optional*): The payload that represents enabled state. Default is "ON".
-- **payload_off** (*Optional*): The payload that represents disabled state. Default is "OFF".
-- **payload_available** (*Optional*): The payload that represents the available state, e.g. 'online'. Default is "ON".
-- **payload_not_available** (*Optional*): The payload that represents the unavailable state, e.g. 'offline'. Default is "OFF".
-- **optimistic** (*Optional*): Flag that defines if switch works in optimistic mode. Default is `true` if no `state_topic` defined, else `false`.
-- **qos** (*Optional*): The maximum QoS level of the state topic. Default is 0 and will also be used to publishing messages.
-- **retain** (*Optional*): If the published message should have the retain flag on or not.
-- **value_template** (*Optional*): Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract a value from the payload.
+{% configuration %}
+name:
+ description: The name to use when displaying this switch.
+ required: false
+ type: string
+ default: MQTT Switch
+state_topic:
+ description: The MQTT topic subscribed to receive state updates.
+ required: false
+ type: string
+command_topic:
+ description: The MQTT topic to publish commands to change the switch state.
+ required: false
+ type: string
+availability_topic:
+ description: The MQTT topic subscribed to receive availability (online/offline) updates.
+ required: false
+ type: string
+payload_on:
+ description: The payload that represents enabled state.
+ required: false
+ type: string
+ default: ON
+payload_off:
+ description: The payload that represents disabled state.
+ required: false
+ type: string
+ default: OFF
+payload_available:
+ description: The payload that represents the available state.
+ required: false
+ type: string
+ default: online
+payload_not_available:
+ description: The payload that represents the unavailable state.
+ required: false
+ type: string
+ default: offline
+optimistic:
+ description: Flag that defines if switch works in optimistic mode.
+ required: false
+ type: boolean
+ default: "`true` if no `state_topic` defined, else `false`."
+qos:
+ description: The maximum QoS level of the state topic. Default is 0 and will also be used to publishing messages.
+ required: false
+ type: integer
+ default: 0
+retain:
+ description: If the published message should have the retain flag on or not.
+ required: false
+ type: boolean
+ default: false
+value_template:
+ description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract a value from the payload."
+ required: false
+ type: string
+{% endconfiguration %}
Make sure that your topic matches exactly. `some-topic/` and `some-topic` are different topics.
diff --git a/source/_components/switch.rainbird.markdown b/source/_components/switch.rainbird.markdown
index 5a8598c3021..eee1d471b9e 100644
--- a/source/_components/switch.rainbird.markdown
+++ b/source/_components/switch.rainbird.markdown
@@ -15,13 +15,10 @@ ha_iot_class: "Local Polling"
This `rainbird` switch platform allows interacting with [LNK WiFi](http://www.rainbird.com/landscape/products/controllers/LNK-WiFi.htm) module of the Rain Bird Irrigation system in Home Assistant.
-To enable stations as switches inside Home Assistant, add the following to your `configuration.yaml` file:
+Once you have enabled the [Rain Bird component](/components/rainbird), add the following to your `configuration.yaml` file:
```yaml
switch:
- platform: rainbird
- host: '1.1.1.1'
- password: 'secretpassword'
sprinkler_1:
zone: 1
friendly_name: "Front sprinklers"
@@ -36,8 +33,6 @@ switch:
Configuration variables:
-- **stickip** (*Required*): The IP address of your LNK WiFi Module.
-- **password** (*Required*): The password for accessing the module.
- **zone** (*Required*): Station zone identifier.
- **friendly_name** (*Optional*): Just a friendly name for the station.
- **trigger_time** (*Required*): The default duration to sprinkle the zone.
diff --git a/source/_components/switch.tplink.markdown b/source/_components/switch.tplink.markdown
index ee56f356880..5839ff2cef0 100644
--- a/source/_components/switch.tplink.markdown
+++ b/source/_components/switch.tplink.markdown
@@ -1,7 +1,7 @@
---
layout: page
-title: "TPLink Switch"
-description: "Instructions how to integrate TPLink switches into Home Assistant."
+title: "TP-Link Switch"
+description: "Instructions how to integrate TP-Link switches into Home Assistant."
date: 2016-07-13 08:00
sidebar: true
comments: false
@@ -14,7 +14,7 @@ ha_release: "0.24"
---
-The `tplink` switch platform allows you to control the state of your [TPLink smart switch](http://www.tp-link.com/en/products/list-5258.html).
+The `tplink` switch platform allows you to control the state of your [TP-Link smart switch](http://www.tp-link.com/en/products/list-5258.html).
Supported units:
@@ -23,7 +23,7 @@ Supported units:
- HS110
- HS200
-To use your TPLink switch in your installation, add the following to your `configuration.yaml` file:
+To use your TP-Link switch in your installation, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
@@ -37,7 +37,7 @@ name:
description: The name to use when displaying this switch.
required: false
type: string
- default: Random Sensor
+ default: TP-Link Switch
host:
description: "The IP address of your TP-Link switch, eg. `192.168.1.32`."
required: true
@@ -46,8 +46,5 @@ enable_leds:
description: If the LEDs on the switch (WiFi and power) should be lit.
required: false
type: boolean
- default: true
{% endconfiguration %}
-
-
diff --git a/source/_components/vacuum.mqtt.markdown b/source/_components/vacuum.mqtt.markdown
index df5a01a8cf8..65ed9679cef 100644
--- a/source/_components/vacuum.mqtt.markdown
+++ b/source/_components/vacuum.mqtt.markdown
@@ -53,36 +53,133 @@ vacuum:
send_command_topic: 'vacuum/send_command'
```
-Basic Configuration variables:
-
-- **name** (*Optional*): The name of the vacuum. Defaults to `MQTT Vacuum`.
-- **supported_features** (*Optional*): List of features that the vacuum supports (possible values are `turn_on`, `turn_off`, `pause`, `stop`, `return_home`, `battery`, `status`, `locate`, `clean_spot`, `fan_speed`, `send_command`). Defaults to `turn_on`, `turn_off`, `stop`, `return_home`, `status`, `battery`, `clean_spot`.
-- **command_topic** (*Optional*): The MQTT topic to publish commands to control the vacuum.
-
-Advanced Configuration variables:
-
-- **qos** (*Optional*): The maximum QoS level of the state topic. Defaults to `0`. Will also be used when publishing messages.
-- **retain** (*Optional*): If the published message should have the retain flag on or not. Defaults to `false`.
-- **payload_turn_on** (*Optional*): The payload to send to the `command_topic` to begin the cleaning cycle. Defaults to `turn_on`.
-- **payload_turn_off** (*Optional*): The payload to send to the `command_topic` to turn the vacuum off. Defaults to `turn_off`.
-- **payload_return_to_base** (*Optional*): The payload to send to the `command_topic` to tell the vacuum to return to base. Defaults to `return_to_base`.
-- **payload_stop** (*Optional*): The payload to send to the `command_topic` to stop the vacuum. Defaults to `stop`.
-- **payload_clean_spot** (*Optional*): The payload to send to the `command_topic` to begin a spot cleaning cycle. Defaults to `clean_spot`.
-- **payload_locate** (*Optional*): The payload to send to the `command_topic` to locate the vacuum (typically plays a song). Defaults to `locate`.
-- **payload_start_pause** (*Optional*): The payload to send to the `command_topic` to start or pause the vacuum. Defaults to `start_pause`.
-- **battery_level_topic** (*Optional*): The MQTT topic subscribed to receive battery level values from the vacuum.
-- **battery_level_template** (*Optional*): Defines a [template](/topics/templating/) to define the battery level of the vacuum.
-- **charging_topic** (*Optional*): The MQTT topic subscribed to receive charging state values from the vacuum.
-- **charging_template** (*Optional*): Defines a [template](/topics/templating/) to define the charging state of the vacuum.
-- **cleaning_topic** (*Optional*): The MQTT topic subscribed to receive cleaning state values from the vacuum.
-- **cleaning_template** (*Optional*): Defines a [template](/topics/templating/) to define the cleaning state of the vacuum.
-- **docked_topic** (*Optional*): The MQTT topic subscribed to receive docked state values from the vacuum.
-- **docked_template** (*Optional*): Defines a [template](/topics/templating/) to define the docked state of the vacuum.
-- **fan_speed_topic** (*Optional*): The MQTT topic subscribed to receive fan speed values from the vacuum.
-- **fan_speed_template** (*Optional*): Defines a [template](/topics/templating/) to define the fan speed of the vacuum.
-- **set_fan_speed_topic** (*Optional*): The MQTT topic to publish commands to control the vacuum's fan speed.
-- **fan_speed_list** (*Optional*): List of possible fan speeds for the vacuum.
-- **send_command_topic** (*Optional*): The MQTT topic to publish custom commands to the vacuum.
+{% configuration %}
+name:
+ description: The name of the vacuum.
+ required: false
+ type: string
+ default: MQTT Vacuum
+supported_features:
+ description: "List of features that the vacuum supports (possible values are `turn_on`, `turn_off`, `pause`, `stop`, `return_home`, `battery`, `status`, `locate`, `clean_spot`, `fan_speed`, `send_command`)."
+ required: false
+ type: string list
+ default: "`turn_on`, `turn_off`, `stop`, `return_home`, `status`, `battery`, `clean_spot`"
+command_topic:
+ description: The MQTT topic to publish commands to control the vacuum.
+ required: false
+ type: string
+qos:
+ description: The maximum QoS level of the state topic.
+ required: false
+ type: integer
+ default: 0
+retain:
+ description: If the published message should have the retain flag on or not.
+ required: false
+ type: boolean
+ default: false
+payload_turn_on:
+ description: "The payload to send to the `command_topic` to begin the cleaning cycle."
+ required: false
+ type: string
+ default: turn_on
+payload_turn_off:
+ description: "The payload to send to the `command_topic` to turn the vacuum off."
+ required: false
+ type: string
+ default: turn_off
+payload_return_to_base:
+ description: The payload to send to the `command_topic` to tell the vacuum to return to base.
+ required: false
+ type: string
+ default: return_to_base
+payload_stop:
+ description: The payload to send to the `command_topic` to stop the vacuum.
+ required: false
+ type: string
+ default: stop
+payload_clean_spot:
+ description: The payload to send to the `command_topic` to begin a spot cleaning cycle.
+ required: false
+ type: string
+ default: clean_spot
+payload_locate:
+ description: The payload to send to the `command_topic` to locate the vacuum (typically plays a song).
+ required: false
+ type: string
+ default: locate
+payload_start_pause:
+ description: The payload to send to the `command_topic` to start or pause the vacuum.
+ required: false
+ type: string
+ default: start_pause
+battery_level_topic:
+ description: The MQTT topic subscribed to receive battery level values from the vacuum.
+ required: false
+ type: string
+battery_level_template:
+ description: "Defines a [template](/topics/templating/) to define the battery level of the vacuum."
+ required: false
+ type: string
+charging_topic:
+ description: The MQTT topic subscribed to receive charging state values from the vacuum.
+ required: false
+ type: string
+charging_template:
+ description: "Defines a [template](/topics/templating/) to define the charging state of the vacuum."
+ required: false
+ type: string
+cleaning_topic:
+ description: The MQTT topic subscribed to receive cleaning state values from the vacuum.
+ required: false
+ type: string
+cleaning_template:
+ description: "Defines a [template](/topics/templating/) to define the cleaning state of the vacuum."
+ required: false
+ type: string
+docked_topic:
+ description: The MQTT topic subscribed to receive docked state values from the vacuum.
+ required: false
+ type: string
+docked_template:
+ description: "Defines a [template](/topics/templating/) to define the docked state of the vacuum."
+ required: false
+ type: string
+fan_speed_topic:
+ description: The MQTT topic subscribed to receive fan speed values from the vacuum.
+ required: false
+ type: string
+fan_speed_template:
+ description: "Defines a [template](/topics/templating/) to define the fan speed of the vacuum."
+ required: false
+ type: string
+set_fan_speed_topic:
+ description: The MQTT topic to publish commands to control the vacuum's fan speed.
+ required: false
+ type: string
+fan_speed_list:
+ description: List of possible fan speeds for the vacuum.
+ required: false
+ type: string list
+send_command_topic:
+ description: The MQTT topic to publish custom commands to the vacuum.
+ required: false
+ type: string
+availability_topic:
+ description: The MQTT topic subscribed to receive availability (online/offline) updates.
+ required: false
+ type: string
+payload_available:
+ description: The payload that represents the available state.
+ required: false
+ type: string
+ default: online
+payload_not_available:
+ description: The payload that represents the unavailable state.
+ required: false
+ type: string
+ default: offline
+{% endconfiguration %}
### {% linkable_title Default MQTT Protocol %}
diff --git a/source/_components/vacuum.xiaomi_miio.markdown b/source/_components/vacuum.xiaomi_miio.markdown
index e14e1506578..4abc27588cb 100644
--- a/source/_components/vacuum.xiaomi_miio.markdown
+++ b/source/_components/vacuum.xiaomi_miio.markdown
@@ -155,7 +155,7 @@ To fetch the token follow these instructions depending on your mobile phone plat
Follow the pairing process using your phone and Mi-Home app. You will be able to retrieve the token from a SQLite file inside your phone.
-Before you begin you need to install `libffi-dev` and `libssl-dev` by running the command below. This is needed for `python-mirobo` to be installed correctly.
+Before you begin you need to install `libffi-dev` and `libssl-dev` by running the command below. This is needed for `python-miio` to be installed correctly.
```bash
$ sudo apt-get install libffi-dev libssl-dev
@@ -185,7 +185,7 @@ To fetch the token follow these instructions depending on your mobile phone plat
Follow the pairing process using your phone and Mi-Home app. You will be able to retrieve the token from a SQLite file inside your phone.
-Before you begin you need to install `libffi-dev` and `libssl-dev` by running the command below. This is needed for `python-mirobo` to be installed correctly.
+Before you begin you need to install `libffi-dev` and `libssl-dev` by running the command below. This is needed for `python-miio` to be installed correctly.
```bash
$ sudo apt-get install libffi-dev libssl-dev
diff --git a/source/_components/weather.darksky.markdown b/source/_components/weather.darksky.markdown
new file mode 100644
index 00000000000..0352ef6074e
--- /dev/null
+++ b/source/_components/weather.darksky.markdown
@@ -0,0 +1,70 @@
+---
+layout: page
+title: "Dark Sky"
+description: "Instructions how to integrate Dark Sky within Home Assistant."
+date: 2016-09-29 09:00
+sidebar: true
+comments: false
+sharing: true
+footer: true
+logo: dark_sky.png
+ha_category: Weather
+ha_release: 0.61
+ha_iot_class: "Cloud Polling"
+---
+
+The `darksky` platform uses the [Dark Sky](https://darksky.net/) web service as
+a source for meteorological data for your location.
+
+You need an API key which is free but requires
+[registration](https://darksky.net/dev/register). The free tier allows up to
+1000 calls per day, this platform updates at most every 3 minutes, using up to
+480 of those calls.
+
+
+[Dark Sky](https://darksky.net/dev/) will charge you $0.0001 per API call if you
+enter your credit card details and create more than 1000 calls per day.
+
+
+To add Dark Sky to your installation, add the following to your `configuration.yaml` file:
+
+```yaml
+# Example configuration.yaml entry
+weather:
+ - platform: darksky
+ api_key: YOUR_API_KEY
+```
+
+{% configuration %}
+api_key:
+ description: "Your API key for [Dark Sky](https://darksky.net/dev/)."
+ required: true
+ type: string
+latitude:
+ description: Manually specify latitude. By default the value will be taken from the Home Assistant configuration.
+ required: false
+ type: number
+ default: Provided by Home Assistant configuration
+longitude:
+ description: Manually specify longitude. By default the value will be taken from the Home Assistant configuration.
+ required: false
+ type: number
+ default: Provided by Home Assistant configuration
+units:
+ description: "Manually specify unit system. Valid values are: `auto`, `us`, `si`, `ca`, `uk` and `uk2`."
+ required: false
+ type: string
+ default: "`si` if Home Assistant unit system is metric, `us` if imperial."
+name:
+ description: Name to use in the frontend.
+ required: false
+ type: string
+ default: Open Sky
+{% endconfiguration %}
+
+
+This platform is an alternative to the [`darksky`](/components/sensor.darksky/)
+sensor.
+
+
+Details about the API are available in the [Dark Sky documentation](https://darksky.net/dev/docs).
diff --git a/source/_components/weather.metoffice.markdown b/source/_components/weather.metoffice.markdown
index d05b55431e6..58751218063 100644
--- a/source/_components/weather.metoffice.markdown
+++ b/source/_components/weather.metoffice.markdown
@@ -20,16 +20,15 @@ To add the Met Office weather platform to your installation, you'll need to regi
```yaml
weather:
- platform: metoffice
- api_key: "my-api-key"
+ api_key: YOUR_API_KEY
```
Configuration variables:
-- **api_key** (*Required*): Your personal API key from the [Datapoint website][datapoint].
+- **api_key** (*Required*): Your personal API key from the [Datapoint website](http://www.metoffice.gov.uk/datapoint).
This platform is an alternative to the [`metoffice`](/components/sensor.metoffice/) sensor.
The weather platform is easier to configure but less customizable.
-[datapoint]: http://www.metoffice.gov.uk/datapoint
diff --git a/source/_posts/2017-12-17-introducing-home-assistant-cloud.markdown b/source/_posts/2017-12-17-introducing-home-assistant-cloud.markdown
index ddc52e5ab7c..b55eabb3e31 100644
--- a/source/_posts/2017-12-17-introducing-home-assistant-cloud.markdown
+++ b/source/_posts/2017-12-17-introducing-home-assistant-cloud.markdown
@@ -14,7 +14,9 @@ Today we’re introducing the next step in the Home Assistant saga: the Home Ass
The first service that is supported via the Home Assistant Cloud is the Amazon Alexa Smart Home skill. This integration will allow you to control all your devices in Home Assistant via Amazon Alexa. You will be able to say _“Alexa, turn on the kitchen lights”_ and your local Home Assistant will turn on the lights. Because Alexa talks to Home Assistant, it doesn’t matter what kind of lights they are! Anything that is linked to Home Assistant will work. IKEA lights, a 10 year old X10 switch or something you’ve made yourself. As long as Home Assistant can control it, you can control it via Alexa.
-We have designed the Home Assistant Cloud with security in mind. When you activate the new Cloud component, your instance will setup a secure connection to the Home Assistant Cloud. Alexa will deliver messages to our cloud which we will forward to your local instance for processing. We just forward the response back to Alexa. This means that we do not have to store the state of your house in our cloud, we’re just the messenger!
+We have designed the Home Assistant Cloud with security in mind. When you activate the new Cloud component, your instance will create a secure connection to the Home Assistant Cloud. There is no need for any further configuration or to expose your instance to the internet.
+
+Integrations like Alexa will deliver messages to our cloud which we will forward to your local instance for processing. We just forward the response back to Alexa. This means that we do not have to store the state of your house in our cloud, we’re just the messenger!
We are making the beta of the Home Assistant Cloud publicly available today. During the beta period the Home Assistant Cloud will be free to use. We are currently planning to run a beta till March 1, 2018 0:00 UTC. Once the beta ends, the Home Assistant Cloud will be part of our Community Support package which will run at $5 USD/month.
diff --git a/source/_posts/2018-01-14-release-61.markdown b/source/_posts/2018-01-14-release-61.markdown
new file mode 100644
index 00000000000..230b737f83b
--- /dev/null
+++ b/source/_posts/2018-01-14-release-61.markdown
@@ -0,0 +1,732 @@
+---
+layout: post
+title: "0.61: Coinbase, Discogs, iGlo, Sochain"
+description: "New crypto currency sensors and other new stuff including breaking changes."
+date: 2018-01-14 18:00:00
+date_formatted: "January 14, 2018"
+author: Fabian Affolter
+author_twitter: fabaff
+comments: true
+categories: Release-Notes
+og_image: /images/blog/2018-01-0.61/components.png
+---
+
+
+
+Almost a 100 contributors to this release 🎉 That's what you get when you skip a release. It's a little late but "Happy New Year" and welcome to 0.61 the first release 2018.
+
+This release contain some breaking changes. Please make sure that you check the section below if you are running into trouble.
+
+There is not much more to tell and I don't want to make something up.
+
+
+## {% linkable_title New Platforms %}
+
+- Add Discogs Sensor platform ([@thibmaek] - [#10957]) ([sensor.discogs docs]) (new-platform)
+- Greenwave Reality (TCP Connected) Lighting Component ([@dfiel] - [#11282]) ([light.greenwave docs]) (new-platform)
+- Added rainsensor ([@jbarrancos] - [#11023]) ([rainbird docs]) ([sensor.rainbird docs]) ([switch.rainbird docs]) (new-platform)
+- Sochain cryptocurrency sensor ([@Klathmon] - [#11335]) ([sensor.sochain docs]) (new-platform)
+- Support for EcoNet water heaters ([@w1ll1am23] - [#11260]) ([climate.econet docs]) (new-platform)
+- Add deCONZ component ([@Kane610] - [#10321]) ([deconz docs]) ([binary_sensor.deconz docs]) ([light.deconz docs]) ([sensor.deconz docs]) (new-platform)
+- Added new climate component from Daikin ([@rofrantz] - [#10983]) ([climate.daikin docs]) (new-platform)
+- Add Touchline climate platform ([@abondoe] - [#10547]) ([climate.touchline docs]) (new-platform)
+- Add new iGlo component ([@jesserockz] - [#11171]) ([light.iglo docs]) (new-platform)
+- Add Dark Sky weather component ([@DanNixon] - [#11435]) ([weather.darksky docs]) (new-platform)
+- Coinbase.com sensor platform ([@nkgilley] - [#11036]) ([coinbase docs]) ([sensor.coinbase docs]) (new-platform)
+
+## {% linkable_title If you need help... %}
+
+...don't hesitate to use our very active [forums](https://community.home-assistant.io/) or join us for a little [chat](https://discord.gg/c5DvZ4e). The release notes have comments enabled but it's preferred if you use the former communication channels. Thanks.
+
+## {% linkable_title Reporting Issues %}
+
+Experiencing issues introduced by this release? Please report them in our [issue tracker](https://github.com/home-assistant/home-assistant/issues). Make sure to fill in all fields of the issue template.
+
+
+
+## {% linkable_title Breaking Changes %}
+
+- Extend Threshold binary sensor to support ranges. This means that you can now set `up` and `lower`. ([@DanNixon] - [#11110]) ([binary_sensor.threshold docs]) (breaking change)
+- The Steam game platform contains changes:
+ - `game` attribute no longer set in `device_state_attributes` if no game is currently being played as the string "None" is no longer passed if no current game is being played, instead the `game` attribute is not present.
+ - States now use lower snake case.
+ - The "Play" and "Trade" states has been renamed to "looking_to_play" and "looking_to_trade".
+ ([@frwickst] - [#11182]) ([sensor.steam_online docs]) (breaking change)
+- The [`tile`][device_tracker.tile docs] platform now shows only active Tiles by default; to show all Tiles, including expired/inactive ones, `show_inactive` must be `True`. The following state attributes have been removed: `last_seen` and `last_updated`. ([@bachya] - [#11172]) ([device_tracker.tile docs]) (breaking change)
+- The `hidden_string` feature has been removed from the isy994 component. Previously, this allowed entities to be "hidden" in Home Assistant if a configured string was present in an ISY device's name or folder path. This was removed because hiding devices is now done via the customization feature.
+Note however, that this feature was replaced by a new ignore_string config option, which will now cause Home Assistant to completely ignore devices with the matching string so that they will not be imported as a Home Assistant device at all. This can be helpful if you have nodes in the ISY that aren't useful at all in Hass (IR transmitter nodes are a good example.) ([@OverloadUT] - [#11243]) ([isy994 docs]) ([binary_sensor.isy994 docs]) ([cover.isy994 docs]) ([fan.isy994 docs]) ([light.isy994 docs]) ([lock.isy994 docs]) ([sensor.isy994 docs]) ([switch.isy994 docs]) (breaking change)
+- The [`egardia` alarm panel][alarm_control_panel.egardia docs] platform no longer a need the users to run a separate Egardiaserver component. It can now also run on HASS.io. ([@jeroenterheerdt] - [#11344]) ([alarm_control_panel.egardia docs]) (breaking change)
+- The binary sensor platform of the DoorBird integration has been deleted, so remove DoorBird from your `binary_sensor` configuration. Instead, set the `doorbell_events` option of the `doorbird` component to `True`. The `last_visitor` option has been removed from the camera component, as it is now always added as an entity. ([@Klikini] - [#11193]) ([camera.doorbird docs]) (breaking change)
+- The following attributes of the TP-Link switch and light platform have been renamed:
+ - Light: `current_consumption` -> `current_power_w`, `daily_consumption` -> `daily_energy_kwh` and `monthly_consumption` -> `monthly_energy_kwh`
+ - Switch: `current` -> `current_a`, `current_consumption` -> `current_power_w`, `total_consumption` -> `total_energy_kwh` and `daily_consumption` -> `today_energy_kwh` ([@DanNixon] - [#10979]) ([light.tplink docs]) ([switch.tplink docs]) (breaking change)
+- Move IMAP Email Content body to an attribute ([@notoriousbdg] - [#11096]) ([sensor.imap_email_content docs]) (breaking change)
+- Automations which were using `state` that was returning `target_temperature` of the `netatmo` climate platform needs an update. ([@ciotlosm] - [#11345]) ([climate.netatmo docs]) (breaking change)
+- The default availability payloads for the `MQTT` switch platform have changed from "ON" and "OFF" to "online" and "offline" (in order to match the majority of MQTT platforms that already supported availability reporting). ([@DanNixon] - [#11336]) (breaking change)
+- Customizations for how entities are exposed to Alexa are no longer set via `customize`. Instead they are set via the configuration of the cloud component:
+
+ ```yaml
+ cloud:
+ alexa:
+ entity_config:
+ switch.kitchen:
+ name: 'Name for Alexa'
+ description: 'Description for Alexa'
+ display_categories: 'LIGHT'
+ ```
+ ([@balloob] - [#11461]) ([cloud docs]) ([alexa.smart_home docs]) (breaking change)
+- The extension of the `alpha_vantage` requires an update of the configuration as now are exchange data available as well. ([@ChristianKuehnel] - [#11427]) ([sensor.alpha_vantage docs]) (breaking change)
+- The `prometheus` component now supports pushing all sensors and fixes wrong metrics. If may require that you update your configuration. ([@michaelkuty] - [#11159]) ([prometheus docs]) (breaking change)
+- Insteon local devices will now use their address as the `entity_id` and `name`. The friendly name can be customized using the [standard customization configuration](https://home-assistant.io/docs/configuration/customizing-devices/). ([@camrun91] - [#11088]) ([insteon_local docs]) ([fan.insteon_local docs]) ([light.insteon_local docs]) ([switch.insteon_local docs]) (breaking change)
+- Google Assistant is no longer configured via `customize` but instead has its configuration under the `google_assistant` entry in your `configuration.yaml`. The attributes will no longer have to be prefixed with `google_assistant_` either.
+
+ | Old option | New option |
+ | ---------- | ------------ |
+ | google_assistant | expose |
+ | aliases | aliases |
+ | google_assistant_name | name |
+ | google_assistant_type | type |
+
+ Before:
+
+ ```yaml
+ homeassistant:
+ customize:
+ switch.kitchen:
+ google_assistant: false
+ google_assistant_name: nice lights
+ google_assistant_type: light
+ aliases:
+ - roof lights
+
+ google_assistant:
+ ```
+
+ After:
+
+ ```yaml
+ google_assistant:
+ entity_config:
+ switch.kitchen:
+ expose: false
+ alias: roof lights
+ name: nice lights
+ type: light
+ ```
+([@balloob] - [#11499]) ([cloud docs]) ([google_assistant docs]) (breaking change)
+- The `climate.set_aux_heat` service is no longer available for the Sensibo cliamte platform. Now call `climate.turn_on` or `climate.turn_off`. ([@andrey-git] - [#11579]) ([climate.sensibo docs]) (breaking change)
+
+## {% linkable_title All changes %}
+
+- Try multiple methods of getting data in asuswrt. ([@PeWu] - [#11140]) ([device_tracker.asuswrt docs])
+- Hydroquebec component use now asyncio ([@titilambert] - [#10795]) ([sensor.hydroquebec docs])
+- Hive Component Release Two ([@KJonline] - [#11053]) ([hive docs]) ([climate.hive docs]) ([light.hive docs])
+- Add Discogs Sensor platform ([@thibmaek] - [#10957]) ([sensor.discogs docs]) (new-platform)
+- Fix statistics sensor mean and median when only one sample is available. ([@markferry] - [#11180]) ([sensor.statistics docs])
+- Extend Threshold binary sensor to support ranges ([@DanNixon] - [#11110]) ([binary_sensor.threshold docs]) (breaking change)
+- Bump python-miio version ([@djchen] - [#11232]) ([fan.xiaomi_miio docs]) ([light.xiaomi_miio docs]) ([switch.xiaomi_miio docs]) ([vacuum.xiaomi_miio docs])
+- Backup configuration files before overwriting ([@cgarwood] - [#11216])
+- Upgrade to new miflora version 0.2.0 ([@ChristianKuehnel] - [#11250]) ([sensor.miflora docs])
+- Add workaround for running tox on Windows platforms ([@veleek] - [#11188])
+- added myself to become code owner for miflora and plant ([@ChristianKuehnel] - [#11251])
+- Proper Steam game names and small fixes ([@frwickst] - [#11182]) ([sensor.steam_online docs]) (breaking change)
+- Bugfix: 10509 - http is hard coded in plex sensor ([@ryanm101] - [#11072]) ([sensor.plex docs])
+- Adding MotionIP to BinarySensors for HMIP-SMI ([@schnoetz] - [#11268]) ([homematic docs])
+- Revert "Backup configuration files before overwriting" ([@pvizeli] - [#11269])
+- Functinality to save/restore snapshots for monoprice platform ([@etsinko] - [#10296]) ([media_player.monoprice docs])
+- Change manifest path to /states as this is the path / actually sets. ([@andrey-git] - [#11274])
+- Report Sensibo as off when it is off ([@andrey-git] - [#11281]) ([climate.sensibo docs])
+- Added password for GPS logger endpoint ([@foxel] - [#11245]) ([device_tracker.gpslogger docs])
+- Greenwave Reality (TCP Connected) Lighting Component ([@dfiel] - [#11282]) ([light.greenwave docs]) (new-platform)
+- Adds support for disabled Tiles and automatic session renewal ([@bachya] - [#11172]) ([device_tracker.tile docs]) (breaking change)
+- Plex refactor ([@ryanm101] - [#11235]) ([media_player.plex docs])
+- alexa: Add handling for covers ([@philk] - [#11242]) ([alexa.smart_home docs])
+- Added rainsensor ([@jbarrancos] - [#11023]) ([rainbird docs]) ([sensor.rainbird docs]) ([switch.rainbird docs]) (new-platform)
+- Store raw state of RF sensors from alarmdecoder ([@PhracturedBlue] - [#10841]) ([alarmdecoder docs]) ([binary_sensor.alarmdecoder docs])
+- Add Chime status and control to Alarm Decoder component ([@goyney] - [#11271]) ([alarm_control_panel.alarmdecoder docs])
+- Better error handling ([@rofrantz] - [#11297]) ([sensor.transmission docs]) ([switch.transmission docs])
+- Removed error log used as debug ([@cmsimike] - [#11301]) ([octoprint docs])
+- Huge ISY994 platform cleanup, fixes support for 5.0.10 firmware ([@OverloadUT] - [#11243]) ([isy994 docs]) ([binary_sensor.isy994 docs]) ([cover.isy994 docs]) ([fan.isy994 docs]) ([light.isy994 docs]) ([lock.isy994 docs]) ([sensor.isy994 docs]) ([switch.isy994 docs]) (breaking change)
+- Add heartbeat to websocket connections ([@balloob] - [#11298]) ([cloud.iot docs])
+- Fix typo in bitcoin.py component for mined blocks. ([@awkwardDuck] - [#11318]) ([sensor.bitcoin docs])
+- xiaomi_aqara: Fix covers never being closed ([@cnrd] - [#11319]) ([cover.xiaomi_aqara docs])
+- Fix for track_new_devices BC ([@masarliev] - [#11202]) ([device_tracker docs])
+- Upgrade aiohttp_cors to 0.6.0 ([@fabaff] - [#11310]) ([http docs])
+- Upgrade pysnmp to 4.4.3 ([@fabaff] - [#11317]) ([device_tracker.snmp docs]) ([sensor.snmp docs]) ([switch.snmp docs])
+- Upgrade luftdaten to 0.1.3 ([@fabaff] - [#11316]) ([sensor.luftdaten docs])
+- Upgrade yahooweather to 0.10 ([@fabaff] - [#11309]) ([weather.yweather docs])
+- Upgrade distro to 1.2.0 ([@fabaff] - [#11312]) ([updater docs])
+- Upgrade python-digitalocean to 1.13.2 ([@fabaff] - [#11311]) ([digital_ocean docs])
+- Upgrade youtube_dl to 2017.12.23 ([@fabaff] - [#11308]) ([media_extractor docs])
+- Upgrade alpha_vantage to 1.6.0 ([@fabaff] - [#11307]) ([sensor.alpha_vantage docs])
+- Bugfix for HA Issue 7292, 9412 - switch to gamertag to receive ssl image url ([@ReneNulschDE] - [#11315]) ([sensor.xbox_live docs])
+- closes #11314 by not restricting the voice to anything but a string ([@Human] - [#11326]) ([tts.marytts docs])
+- Additional device classes for binary sensors ([@schmittx] - [#11280]) ([binary_sensor docs])
+- Remove need for separate EgardiaServer setup ([@jeroenterheerdt] - [#11344]) ([alarm_control_panel.egardia docs]) (breaking change)
+- Add default names and validation for TP-Link devices ([@DanNixon] - [#11346]) ([light.tplink docs]) ([switch.tplink docs])
+- Sochain cryptocurrency sensor ([@Klathmon] - [#11335]) ([sensor.sochain docs]) (new-platform)
+- pass stops_at to get_station_by_name ([@ttroy50] - [#11304]) ([sensor.irish_rail_transport docs])
+- Move data instance to setup ([@fabaff] - [#11350]) ([sensor.swiss_public_transport docs])
+- Update modbus.py ([@goldminenine] - [#11238]) ([modbus docs])
+- DoorBird feature update ([@Klikini] - [#11193]) ([camera.doorbird docs]) (breaking change)
+- Upgrade aiohttp to 2.3.7 ([@fabaff] - [#11329])
+- Upgrade fuzzywuzzy to 0.16.0 ([@fabaff] - [#11331]) ([conversation docs])
+- Upgrade pyowm to 2.8.0 ([@fabaff] - [#11332]) ([sensor.openweathermap docs]) ([weather.openweathermap docs])
+- Upgrade sqlalchemy to 1.2.0 ([@fabaff] - [#11333])
+- Upgrade mypy to 0.560 ([@fabaff] - [#11334])
+- Upgrade python-telegram-bot to 9.0.0 ([@fabaff] - [#11341]) ([telegram_bot docs])
+- Upgrade youtube_dl to 2017.12.28 ([@fabaff] - [#11357]) ([media_extractor docs])
+- Correct units used in TP-Link energy monioring ([@DanNixon] - [#10979]) ([light.tplink docs]) ([switch.tplink docs]) (breaking change)
+- Add HTTP endpoint for resending email confirmation ([@balloob] - [#11354]) ([cloud.auth_api docs]) ([cloud.http_api docs])
+- Fix RGB template ordering in MQTT Light ([@DanNixon] - [#11362]) ([light.mqtt docs])
+- Ping device tracker now respects interval_seconds ([@tschmidty69] - [#11348]) ([device_tracker.ping docs])
+- Fido component use now asyncio ([@titilambert] - [#11244]) ([sensor.fido docs])
+- Support for EcoNet water heaters ([@w1ll1am23] - [#11260]) ([climate.econet docs]) (new-platform)
+- Remember the Milk - updating and completing tasks ([@ChristianKuehnel] - [#11069]) ([remember_the_milk docs])
+- Reverts unit conversions in TP-Link bulb ([@DanNixon] - [#11381]) ([light.tplink docs])
+- Clean up Google Assistant ([@balloob] - [#11375]) ([google_assistant docs]) ([google_assistant.http docs]) ([google_assistant.smart_home docs])
+- Adding support for Egardia / Woonveilig version GATE-03 ([@jeroenterheerdt] - [#11397]) ([alarm_control_panel.egardia docs])
+- Add deCONZ component ([@Kane610] - [#10321]) ([deconz docs]) ([binary_sensor.deconz docs]) ([light.deconz docs]) ([sensor.deconz docs]) (new-platform)
+- Fix broken tests ([@balloob] - [#11395])
+- Upgrade pychromecast to 1.0.3 ([@OttoWinter] - [#11410]) ([media_player.cast docs])
+- Bump pywemo to fix request include problems. ([@pavoni] - [#11401]) ([wemo docs])
+- Log exceptions that happen during service call ([@balloob] - [#11394])
+- Move IMAP Email Content body to an attribute ([@notoriousbdg] - [#11096]) ([sensor.imap_email_content docs]) (breaking change)
+- Notify webos timeout error fix ([@masarliev] - [#11027]) ([notify.webostv docs])
+- Removed status block to allow https://github.com/home-assistant/home-assistant-polymer/pull/766 with no impact ([@ciotlosm] - [#11345]) ([climate.netatmo docs]) (breaking change)
+- More support for availability reporting on MQTT components ([@DanNixon] - [#11336]) (breaking change)
+- Do not purge the most recent state for an entity ([@tinloaf] - [#11039])
+- Performance optimization of TP-Link switch ([@amelchio] - [#11416]) ([switch.tplink docs])
+- Fixing OpenWeatherMap Sensor. Current weather is 'unknown' if forecast: false. It was reported as #8640. ([@tomaszduda23] - [#11417]) ([sensor.openweathermap docs])
+- Silence redundant warnings about slow setup ([@amelchio] - [#11352])
+- Account for User-Agent being non-existent, causing a TypeError ([@akatrevorjay] - [#11064])
+- Cloud Updates ([@balloob] - [#11404]) ([cloud docs])
+- Add support for the renaming of Yamaha Receiver Zones via configuration file. Added a test to cover the change, plus previously untested options. ([@dfinlay] - [#11402]) ([media_player.yamaha docs])
+- Plex api update ([@ryanm101] - [#11423]) ([media_player.plex docs]) ([sensor.plex docs])
+- fix: hmip-etrv-2 now working with homeassistant ([@daenny] - [#11175]) ([homematic docs]) ([climate.homematic docs])
+- Fix errors in zigbee push state ([@SteveEasley] - [#11386]) ([zigbee docs])
+- Add on/off supported feature to climate ([@andrey-git] - [#11379]) ([climate docs]) ([climate.demo docs]) ([climate.sensibo docs])
+- Fix CONF_FRIENDLY_NAME ([@cdce8p] - [#11438]) ([cover.template docs]) ([light.template docs])
+- Climate: fix missing "|" ([@andrey-git] - [#11441]) ([climate.demo docs])
+- Google Assistant -> Google Actions ([@balloob] - [#11442]) ([cloud.iot docs])
+- Added new climate component from Daikin ([@rofrantz] - [#10983]) ([climate.daikin docs]) (new-platform)
+- Updated generic thermostat to respect operation_mode and added away mode ([@ciotlosm] - [#11445]) ([climate.generic_thermostat docs])
+- Reconnect to alarmdecoder on disconnect ([@PhracturedBlue] - [#11383]) ([alarmdecoder docs])
+- Set tahoma cover scan interval to 60 seconds ([@bakedraccoon] - [#11447]) ([cover.tahoma docs])
+- Add some tests to the cloud component ([@balloob] - [#11460]) ([cloud docs]) ([cloud.iot docs])
+- Input Select - Added service description ([@cdce8p] - [#11456]) ([input_select docs])
+- Input Boolean - Deleted 'DEFAULT_INITIAL' ([@cdce8p] - [#11453]) ([input_boolean docs])
+- Updated gitignore file ([@cdce8p] - [#11452])
+- Update hydroquebec component to use hass httpsession ([@titilambert] - [#11412]) ([sensor.hydroquebec docs])
+- Catch everything when calling to OctoPrint API to fix #10557 ([@w1ll1am23] - [#11457]) ([octoprint docs])
+- Update PULL_REQUEST_TEMPLATE.md ([@danielhiversen] - [#11465])
+- Alexa to not use customize for entity config ([@balloob] - [#11461]) ([cloud docs]) ([alexa.smart_home docs]) (breaking change)
+- Don't duplicate html5 registrations ([@Chris-V] - [#11451]) ([notify.html5 docs])
+- AlarmDecoder remove icon function as BinarySensorDevice handles it correctly now ([@hawk259] - [#11467]) ([binary_sensor.alarmdecoder docs])
+- Upgrade psutil to 5.4.3 ([@fabaff] - [#11468]) ([sensor.systemmonitor docs])
+- Upgrade alpha_vantage to 1.8.0 ([@fabaff] - [#11476]) ([sensor.alpha_vantage docs])
+- Fix vultr tests ([@balloob] - [#11477])
+- Upgrade yarl to 0.17.0 ([@fabaff] - [#11478])
+- Add Touchline climate platform ([@abondoe] - [#10547]) ([climate.touchline docs]) (new-platform)
+- Upgrade pysnmp to 4.4.4 ([@fabaff] - [#11485]) ([device_tracker.snmp docs]) ([sensor.snmp docs]) ([switch.snmp docs])
+- Add new iGlo component ([@jesserockz] - [#11171]) ([light.iglo docs]) (new-platform)
+- Add missing configuration variables ([@fabaff] - [#11390]) ([sensor.metoffice docs])
+- Clean up Alexa.intent and DialogFlow.intent ([@balloob] - [#11492]) ([alexa.intent docs])
+- Fix time functions would throw errors in python scripts ([@tomwaters] - [#11414]) ([python_script docs])
+- Upgrade pywebpush to 1.5.0 ([@Chris-V] - [#11497]) ([notify.html5 docs])
+- upgrade schiene to 0.20 ([@JulianKahnert] - [#11504]) ([sensor.deutsche_bahn docs])
+- timer: include the remaining time in the state attributes ([@Julio-Guerra] - [#11510]) ([timer docs])
+- More tolerant KNX component if gateway cant be connected ([@Julius2342] - [#11511]) ([knx docs]) ([binary_sensor.knx docs]) ([climate.knx docs]) ([cover.knx docs]) ([light.knx docs]) ([sensor.knx docs]) ([switch.knx docs])
+- Snips (new) added speech response, parse snips/duration ([@tschmidty69] - [#11513]) ([snips docs])
+- Add Dark Sky weather component ([@DanNixon] - [#11435]) ([weather.darksky docs]) (new-platform)
+- Lazy loading of service descriptions ([@amelchio] - [#11479]) ([api docs]) ([websocket_api docs]) ([light.lifx docs])
+- Fix canary flaky test ([@balloob] - [#11519])
+- Address missed review comments for Dark Sky weather ([@DanNixon] - [#11520]) ([weather.darksky docs])
+- New features for Owntracks device_tracker ([@cpcowart] - [#11480]) ([device_tracker.owntracks docs])
+- Reconnect before mochad switch send command ([@aosadchyy] - [#11296]) ([switch.mochad docs])
+- Fix Kodi channels media type ([@florianj1] - [#11505]) ([media_player.kodi docs])
+- Extension sensor alpha_vantage ([@ChristianKuehnel] - [#11427]) ([sensor.alpha_vantage docs]) (breaking change)
+- MQTT json attributes ([@timstanley1985] - [#11439]) ([sensor.mqtt docs])
+- Support pushing all sensors and fix wrong metrics. ([@michaelkuty] - [#11159]) ([prometheus docs]) (breaking change)
+- Add options feature to Baidu TTS. ([@yienxu] - [#11462]) ([tts.baidu docs])
+- Insteon local update ([@camrun91] - [#11088]) ([insteon_local docs]) ([fan.insteon_local docs]) ([light.insteon_local docs]) ([switch.insteon_local docs]) (breaking change)
+- Snips: (fix) support new intentName format ([@tschmidty69] - [#11509]) ([snips docs])
+- Upgrade numpy to 1.14.0 ([@fabaff] - [#11542]) ([binary_sensor.trend docs]) ([image_processing.opencv docs])
+- Upgrade python-etherscan-api to 0.0.2 ([@fabaff] - [#11535]) ([sensor.etherscan docs])
+- Upgrade Sphinx to 1.6.6 ([@fabaff] - [#11534])
+- ZoneMinder event sensor updates ([@swilson] - [#11369]) ([sensor.zoneminder docs])
+- Move Google Assistant entity config out of customize ([@balloob] - [#11499]) ([cloud docs]) ([google_assistant docs]) (breaking change)
+- Upgrade lightify to 1.0.6.1 ([@fabaff] - [#11545]) ([light.osramlightify docs])
+- Improved test runtime ([@cdce8p] - [#11553]) ([binary_sensor.workday docs])
+- Add 2 media_player services and 1 custom service to Squeezebox platform ([@ericpignet] - [#10969]) ([media_player.squeezebox docs])
+- Fix error on entity_config missing ([@philk] - [#11561]) ([google_assistant.http docs])
+- Upgrade keyring to 10.3.2 ([@fabaff] - [#11531])
+- Coinbase.com sensor platform ([@nkgilley] - [#11036]) ([coinbase docs]) ([sensor.coinbase docs]) (new-platform)
+- Try to fix crashes after Hue refactoring ([@andreacampi] - [#11270]) ([light.hue docs])
+- Remove execution file perm ([@balloob] - [#11563])
+- Deprecate explicit entity_id in template platforms ([@amelchio] - [#11123]) ([binary_sensor.template docs]) ([cover.template docs]) ([light.template docs]) ([sensor.template docs]) ([switch.template docs])
+- Test tweaks ([@balloob] - [#11560])
+- Add Velux Windows to Tahoma ([@bakedraccoon] - [#11538]) ([tahoma docs]) ([cover.tahoma docs])
+- Extend hass.io services / updater ([@pvizeli] - [#11549]) ([hassio docs])
+- Add sensibo_assume_state service to Sensibo climate ([@andrey-git] - [#11567]) ([climate.sensibo docs])
+- Tracking all groups to allow changing of existing groups ([@randellhodges] - [#11444]) ([group docs])
+- Fix new squeezebox service descriptions for lazy loading ([@amelchio] - [#11574]) ([media_player.squeezebox docs])
+- Mark REST binary_sensor unavailable if request fails ([@DanNixon] - [#11506]) ([binary_sensor.rest docs])
+- Tado improvements - hot water zone sensors and climate precision ([@andersonshatch] - [#11521]) ([climate.tado docs]) ([sensor.tado docs])
+- Make the rpi_rf component thread-safe using an RLock ([@ulido] - [#11487]) ([switch.rpi_rf docs])
+- Update pyhomematic, support new devices ([@danielperna84] - [#11578]) ([homematic docs])
+- Alarmdecoder add validation of the zone types ([@hawk259] - [#11488]) ([alarmdecoder docs])
+- Support OSRAM lights on ZHA ([@armills] - [#11522]) ([light.zha docs])
+- Fix bluetooth tracker source ([@swilson] - [#11469]) ([device_tracker docs]) ([device_tracker.bluetooth_le_tracker docs]) ([device_tracker.bluetooth_tracker docs])
+- Fix for asuswrt, telnet not working and presence-detection for router mode ([@kennedyshead] - [#11422]) ([device_tracker.asuswrt docs])
+- Remove aux_heat support from Sensibo now that UI supports on/off ([@andrey-git] - [#11579]) ([climate.sensibo docs]) (breaking change)
+- Changed device type of media player and cover to switch ([@Laqoore] - [#11483]) ([google_assistant.smart_home docs])
+- Control ordering of display in history component ([@rwa] - [#11340]) ([history docs])
+- Pr/11430 ([@balloob] - [#11587])
+- Cast return values and add unit tests for the yahoo weather component. ([@cgtobi] - [#10699]) ([weather.yweather docs])
+- add velux roller shutter to tahoma ([@bakedraccoon] - [#11586]) ([tahoma docs])
+- Added support for enable/disable motion detection ([@abjorshammar] - [#11583]) ([camera.uvc docs])
+- Avoid returning empty media_image_url string ([@JackWindows] - [#11557]) ([media_player.cast docs])
+- Core support for hass.io calls & Bugfix check_config ([@pvizeli] - [#11571]) ([__init__ docs]) ([hassio docs]) ([updater docs])
+- Fix Tahoma stop command for 2 types of shutters ([@bakedraccoon] - [#11588]) ([cover.tahoma docs])
+- Pushbullet email support (fix) ([@tschmidty69] - [#11590]) ([notify.pushbullet docs])
+- Fix state for trigger with forced updates ([@armills] - [#11595]) ([automation.state docs])
+- Snips add say and say_actions services (new) ([@tschmidty69] - [#11596]) ([snips docs])
+- Concord232 alarm arm away fix ([@rwa] - [#11597]) ([alarm_control_panel.concord232 docs]) ([binary_sensor.concord232 docs])
+- Bugfix and cleanup for Rfxtrx ([@danielhiversen] - [#11600])
+- Xiaomi lib upgrade ([@danielhiversen] - [#11603])
+- Upgrade yarl to 0.18.0 ([@fabaff] - [#11609])
+- patch stop command ([@bakedraccoon] - [#11612]) ([cover.tahoma docs])
+- Use kelvin/mireds correctly for setting iglo white ([@jesserockz] - [#11622])
+- Update Pyarlo to 0.1.2 ([@arsaboo] - [#11626])
+
+[#10296]: https://github.com/home-assistant/home-assistant/pull/10296
+[#10321]: https://github.com/home-assistant/home-assistant/pull/10321
+[#10547]: https://github.com/home-assistant/home-assistant/pull/10547
+[#10699]: https://github.com/home-assistant/home-assistant/pull/10699
+[#10795]: https://github.com/home-assistant/home-assistant/pull/10795
+[#10841]: https://github.com/home-assistant/home-assistant/pull/10841
+[#10957]: https://github.com/home-assistant/home-assistant/pull/10957
+[#10969]: https://github.com/home-assistant/home-assistant/pull/10969
+[#10979]: https://github.com/home-assistant/home-assistant/pull/10979
+[#10983]: https://github.com/home-assistant/home-assistant/pull/10983
+[#11023]: https://github.com/home-assistant/home-assistant/pull/11023
+[#11027]: https://github.com/home-assistant/home-assistant/pull/11027
+[#11036]: https://github.com/home-assistant/home-assistant/pull/11036
+[#11039]: https://github.com/home-assistant/home-assistant/pull/11039
+[#11053]: https://github.com/home-assistant/home-assistant/pull/11053
+[#11064]: https://github.com/home-assistant/home-assistant/pull/11064
+[#11069]: https://github.com/home-assistant/home-assistant/pull/11069
+[#11072]: https://github.com/home-assistant/home-assistant/pull/11072
+[#11088]: https://github.com/home-assistant/home-assistant/pull/11088
+[#11096]: https://github.com/home-assistant/home-assistant/pull/11096
+[#11110]: https://github.com/home-assistant/home-assistant/pull/11110
+[#11123]: https://github.com/home-assistant/home-assistant/pull/11123
+[#11140]: https://github.com/home-assistant/home-assistant/pull/11140
+[#11159]: https://github.com/home-assistant/home-assistant/pull/11159
+[#11171]: https://github.com/home-assistant/home-assistant/pull/11171
+[#11172]: https://github.com/home-assistant/home-assistant/pull/11172
+[#11175]: https://github.com/home-assistant/home-assistant/pull/11175
+[#11180]: https://github.com/home-assistant/home-assistant/pull/11180
+[#11182]: https://github.com/home-assistant/home-assistant/pull/11182
+[#11188]: https://github.com/home-assistant/home-assistant/pull/11188
+[#11193]: https://github.com/home-assistant/home-assistant/pull/11193
+[#11202]: https://github.com/home-assistant/home-assistant/pull/11202
+[#11216]: https://github.com/home-assistant/home-assistant/pull/11216
+[#11232]: https://github.com/home-assistant/home-assistant/pull/11232
+[#11235]: https://github.com/home-assistant/home-assistant/pull/11235
+[#11238]: https://github.com/home-assistant/home-assistant/pull/11238
+[#11242]: https://github.com/home-assistant/home-assistant/pull/11242
+[#11243]: https://github.com/home-assistant/home-assistant/pull/11243
+[#11244]: https://github.com/home-assistant/home-assistant/pull/11244
+[#11245]: https://github.com/home-assistant/home-assistant/pull/11245
+[#11250]: https://github.com/home-assistant/home-assistant/pull/11250
+[#11251]: https://github.com/home-assistant/home-assistant/pull/11251
+[#11260]: https://github.com/home-assistant/home-assistant/pull/11260
+[#11268]: https://github.com/home-assistant/home-assistant/pull/11268
+[#11269]: https://github.com/home-assistant/home-assistant/pull/11269
+[#11270]: https://github.com/home-assistant/home-assistant/pull/11270
+[#11271]: https://github.com/home-assistant/home-assistant/pull/11271
+[#11274]: https://github.com/home-assistant/home-assistant/pull/11274
+[#11280]: https://github.com/home-assistant/home-assistant/pull/11280
+[#11281]: https://github.com/home-assistant/home-assistant/pull/11281
+[#11282]: https://github.com/home-assistant/home-assistant/pull/11282
+[#11296]: https://github.com/home-assistant/home-assistant/pull/11296
+[#11297]: https://github.com/home-assistant/home-assistant/pull/11297
+[#11298]: https://github.com/home-assistant/home-assistant/pull/11298
+[#11301]: https://github.com/home-assistant/home-assistant/pull/11301
+[#11304]: https://github.com/home-assistant/home-assistant/pull/11304
+[#11307]: https://github.com/home-assistant/home-assistant/pull/11307
+[#11308]: https://github.com/home-assistant/home-assistant/pull/11308
+[#11309]: https://github.com/home-assistant/home-assistant/pull/11309
+[#11310]: https://github.com/home-assistant/home-assistant/pull/11310
+[#11311]: https://github.com/home-assistant/home-assistant/pull/11311
+[#11312]: https://github.com/home-assistant/home-assistant/pull/11312
+[#11315]: https://github.com/home-assistant/home-assistant/pull/11315
+[#11316]: https://github.com/home-assistant/home-assistant/pull/11316
+[#11317]: https://github.com/home-assistant/home-assistant/pull/11317
+[#11318]: https://github.com/home-assistant/home-assistant/pull/11318
+[#11319]: https://github.com/home-assistant/home-assistant/pull/11319
+[#11326]: https://github.com/home-assistant/home-assistant/pull/11326
+[#11329]: https://github.com/home-assistant/home-assistant/pull/11329
+[#11331]: https://github.com/home-assistant/home-assistant/pull/11331
+[#11332]: https://github.com/home-assistant/home-assistant/pull/11332
+[#11333]: https://github.com/home-assistant/home-assistant/pull/11333
+[#11334]: https://github.com/home-assistant/home-assistant/pull/11334
+[#11335]: https://github.com/home-assistant/home-assistant/pull/11335
+[#11336]: https://github.com/home-assistant/home-assistant/pull/11336
+[#11340]: https://github.com/home-assistant/home-assistant/pull/11340
+[#11341]: https://github.com/home-assistant/home-assistant/pull/11341
+[#11344]: https://github.com/home-assistant/home-assistant/pull/11344
+[#11345]: https://github.com/home-assistant/home-assistant/pull/11345
+[#11346]: https://github.com/home-assistant/home-assistant/pull/11346
+[#11348]: https://github.com/home-assistant/home-assistant/pull/11348
+[#11350]: https://github.com/home-assistant/home-assistant/pull/11350
+[#11352]: https://github.com/home-assistant/home-assistant/pull/11352
+[#11354]: https://github.com/home-assistant/home-assistant/pull/11354
+[#11357]: https://github.com/home-assistant/home-assistant/pull/11357
+[#11362]: https://github.com/home-assistant/home-assistant/pull/11362
+[#11369]: https://github.com/home-assistant/home-assistant/pull/11369
+[#11375]: https://github.com/home-assistant/home-assistant/pull/11375
+[#11379]: https://github.com/home-assistant/home-assistant/pull/11379
+[#11381]: https://github.com/home-assistant/home-assistant/pull/11381
+[#11383]: https://github.com/home-assistant/home-assistant/pull/11383
+[#11386]: https://github.com/home-assistant/home-assistant/pull/11386
+[#11390]: https://github.com/home-assistant/home-assistant/pull/11390
+[#11394]: https://github.com/home-assistant/home-assistant/pull/11394
+[#11395]: https://github.com/home-assistant/home-assistant/pull/11395
+[#11397]: https://github.com/home-assistant/home-assistant/pull/11397
+[#11401]: https://github.com/home-assistant/home-assistant/pull/11401
+[#11402]: https://github.com/home-assistant/home-assistant/pull/11402
+[#11404]: https://github.com/home-assistant/home-assistant/pull/11404
+[#11410]: https://github.com/home-assistant/home-assistant/pull/11410
+[#11412]: https://github.com/home-assistant/home-assistant/pull/11412
+[#11414]: https://github.com/home-assistant/home-assistant/pull/11414
+[#11416]: https://github.com/home-assistant/home-assistant/pull/11416
+[#11417]: https://github.com/home-assistant/home-assistant/pull/11417
+[#11422]: https://github.com/home-assistant/home-assistant/pull/11422
+[#11423]: https://github.com/home-assistant/home-assistant/pull/11423
+[#11427]: https://github.com/home-assistant/home-assistant/pull/11427
+[#11435]: https://github.com/home-assistant/home-assistant/pull/11435
+[#11438]: https://github.com/home-assistant/home-assistant/pull/11438
+[#11439]: https://github.com/home-assistant/home-assistant/pull/11439
+[#11441]: https://github.com/home-assistant/home-assistant/pull/11441
+[#11442]: https://github.com/home-assistant/home-assistant/pull/11442
+[#11444]: https://github.com/home-assistant/home-assistant/pull/11444
+[#11445]: https://github.com/home-assistant/home-assistant/pull/11445
+[#11447]: https://github.com/home-assistant/home-assistant/pull/11447
+[#11451]: https://github.com/home-assistant/home-assistant/pull/11451
+[#11452]: https://github.com/home-assistant/home-assistant/pull/11452
+[#11453]: https://github.com/home-assistant/home-assistant/pull/11453
+[#11456]: https://github.com/home-assistant/home-assistant/pull/11456
+[#11457]: https://github.com/home-assistant/home-assistant/pull/11457
+[#11460]: https://github.com/home-assistant/home-assistant/pull/11460
+[#11461]: https://github.com/home-assistant/home-assistant/pull/11461
+[#11462]: https://github.com/home-assistant/home-assistant/pull/11462
+[#11465]: https://github.com/home-assistant/home-assistant/pull/11465
+[#11467]: https://github.com/home-assistant/home-assistant/pull/11467
+[#11468]: https://github.com/home-assistant/home-assistant/pull/11468
+[#11469]: https://github.com/home-assistant/home-assistant/pull/11469
+[#11476]: https://github.com/home-assistant/home-assistant/pull/11476
+[#11477]: https://github.com/home-assistant/home-assistant/pull/11477
+[#11478]: https://github.com/home-assistant/home-assistant/pull/11478
+[#11479]: https://github.com/home-assistant/home-assistant/pull/11479
+[#11480]: https://github.com/home-assistant/home-assistant/pull/11480
+[#11483]: https://github.com/home-assistant/home-assistant/pull/11483
+[#11485]: https://github.com/home-assistant/home-assistant/pull/11485
+[#11487]: https://github.com/home-assistant/home-assistant/pull/11487
+[#11488]: https://github.com/home-assistant/home-assistant/pull/11488
+[#11492]: https://github.com/home-assistant/home-assistant/pull/11492
+[#11497]: https://github.com/home-assistant/home-assistant/pull/11497
+[#11499]: https://github.com/home-assistant/home-assistant/pull/11499
+[#11504]: https://github.com/home-assistant/home-assistant/pull/11504
+[#11505]: https://github.com/home-assistant/home-assistant/pull/11505
+[#11506]: https://github.com/home-assistant/home-assistant/pull/11506
+[#11509]: https://github.com/home-assistant/home-assistant/pull/11509
+[#11510]: https://github.com/home-assistant/home-assistant/pull/11510
+[#11511]: https://github.com/home-assistant/home-assistant/pull/11511
+[#11513]: https://github.com/home-assistant/home-assistant/pull/11513
+[#11519]: https://github.com/home-assistant/home-assistant/pull/11519
+[#11520]: https://github.com/home-assistant/home-assistant/pull/11520
+[#11521]: https://github.com/home-assistant/home-assistant/pull/11521
+[#11522]: https://github.com/home-assistant/home-assistant/pull/11522
+[#11531]: https://github.com/home-assistant/home-assistant/pull/11531
+[#11534]: https://github.com/home-assistant/home-assistant/pull/11534
+[#11535]: https://github.com/home-assistant/home-assistant/pull/11535
+[#11538]: https://github.com/home-assistant/home-assistant/pull/11538
+[#11542]: https://github.com/home-assistant/home-assistant/pull/11542
+[#11545]: https://github.com/home-assistant/home-assistant/pull/11545
+[#11549]: https://github.com/home-assistant/home-assistant/pull/11549
+[#11553]: https://github.com/home-assistant/home-assistant/pull/11553
+[#11557]: https://github.com/home-assistant/home-assistant/pull/11557
+[#11560]: https://github.com/home-assistant/home-assistant/pull/11560
+[#11561]: https://github.com/home-assistant/home-assistant/pull/11561
+[#11563]: https://github.com/home-assistant/home-assistant/pull/11563
+[#11567]: https://github.com/home-assistant/home-assistant/pull/11567
+[#11571]: https://github.com/home-assistant/home-assistant/pull/11571
+[#11574]: https://github.com/home-assistant/home-assistant/pull/11574
+[#11578]: https://github.com/home-assistant/home-assistant/pull/11578
+[#11579]: https://github.com/home-assistant/home-assistant/pull/11579
+[#11583]: https://github.com/home-assistant/home-assistant/pull/11583
+[#11586]: https://github.com/home-assistant/home-assistant/pull/11586
+[#11587]: https://github.com/home-assistant/home-assistant/pull/11587
+[#11588]: https://github.com/home-assistant/home-assistant/pull/11588
+[#11590]: https://github.com/home-assistant/home-assistant/pull/11590
+[#11595]: https://github.com/home-assistant/home-assistant/pull/11595
+[#11596]: https://github.com/home-assistant/home-assistant/pull/11596
+[#11597]: https://github.com/home-assistant/home-assistant/pull/11597
+[#11600]: https://github.com/home-assistant/home-assistant/pull/11600
+[#11603]: https://github.com/home-assistant/home-assistant/pull/11603
+[#11609]: https://github.com/home-assistant/home-assistant/pull/11609
+[#11612]: https://github.com/home-assistant/home-assistant/pull/11612
+[#11622]: https://github.com/home-assistant/home-assistant/pull/11622
+[#11626]: https://github.com/home-assistant/home-assistant/pull/11626
+[@Chris-V]: https://github.com/Chris-V
+[@ChristianKuehnel]: https://github.com/ChristianKuehnel
+[@DanNixon]: https://github.com/DanNixon
+[@Human]: https://github.com/Human
+[@JackWindows]: https://github.com/JackWindows
+[@JulianKahnert]: https://github.com/JulianKahnert
+[@Julio-Guerra]: https://github.com/Julio-Guerra
+[@Julius2342]: https://github.com/Julius2342
+[@KJonline]: https://github.com/KJonline
+[@Kane610]: https://github.com/Kane610
+[@Klathmon]: https://github.com/Klathmon
+[@Klikini]: https://github.com/Klikini
+[@Laqoore]: https://github.com/Laqoore
+[@OttoWinter]: https://github.com/OttoWinter
+[@OverloadUT]: https://github.com/OverloadUT
+[@PeWu]: https://github.com/PeWu
+[@PhracturedBlue]: https://github.com/PhracturedBlue
+[@ReneNulschDE]: https://github.com/ReneNulschDE
+[@SteveEasley]: https://github.com/SteveEasley
+[@abjorshammar]: https://github.com/abjorshammar
+[@abondoe]: https://github.com/abondoe
+[@akatrevorjay]: https://github.com/akatrevorjay
+[@amelchio]: https://github.com/amelchio
+[@andersonshatch]: https://github.com/andersonshatch
+[@andreacampi]: https://github.com/andreacampi
+[@andrey-git]: https://github.com/andrey-git
+[@aosadchyy]: https://github.com/aosadchyy
+[@armills]: https://github.com/armills
+[@arsaboo]: https://github.com/arsaboo
+[@awkwardDuck]: https://github.com/awkwardDuck
+[@bachya]: https://github.com/bachya
+[@bakedraccoon]: https://github.com/bakedraccoon
+[@balloob]: https://github.com/balloob
+[@camrun91]: https://github.com/camrun91
+[@cdce8p]: https://github.com/cdce8p
+[@cgarwood]: https://github.com/cgarwood
+[@cgtobi]: https://github.com/cgtobi
+[@ciotlosm]: https://github.com/ciotlosm
+[@cmsimike]: https://github.com/cmsimike
+[@cnrd]: https://github.com/cnrd
+[@cpcowart]: https://github.com/cpcowart
+[@daenny]: https://github.com/daenny
+[@danielhiversen]: https://github.com/danielhiversen
+[@danielperna84]: https://github.com/danielperna84
+[@dfiel]: https://github.com/dfiel
+[@dfinlay]: https://github.com/dfinlay
+[@djchen]: https://github.com/djchen
+[@ericpignet]: https://github.com/ericpignet
+[@etsinko]: https://github.com/etsinko
+[@fabaff]: https://github.com/fabaff
+[@florianj1]: https://github.com/florianj1
+[@foxel]: https://github.com/foxel
+[@frwickst]: https://github.com/frwickst
+[@goldminenine]: https://github.com/goldminenine
+[@goyney]: https://github.com/goyney
+[@hawk259]: https://github.com/hawk259
+[@jbarrancos]: https://github.com/jbarrancos
+[@jeroenterheerdt]: https://github.com/jeroenterheerdt
+[@jesserockz]: https://github.com/jesserockz
+[@kennedyshead]: https://github.com/kennedyshead
+[@markferry]: https://github.com/markferry
+[@masarliev]: https://github.com/masarliev
+[@michaelkuty]: https://github.com/michaelkuty
+[@nkgilley]: https://github.com/nkgilley
+[@notoriousbdg]: https://github.com/notoriousbdg
+[@pavoni]: https://github.com/pavoni
+[@philk]: https://github.com/philk
+[@pvizeli]: https://github.com/pvizeli
+[@randellhodges]: https://github.com/randellhodges
+[@rofrantz]: https://github.com/rofrantz
+[@rwa]: https://github.com/rwa
+[@ryanm101]: https://github.com/ryanm101
+[@schmittx]: https://github.com/schmittx
+[@schnoetz]: https://github.com/schnoetz
+[@swilson]: https://github.com/swilson
+[@thibmaek]: https://github.com/thibmaek
+[@timstanley1985]: https://github.com/timstanley1985
+[@tinloaf]: https://github.com/tinloaf
+[@titilambert]: https://github.com/titilambert
+[@tomaszduda23]: https://github.com/tomaszduda23
+[@tomwaters]: https://github.com/tomwaters
+[@tschmidty69]: https://github.com/tschmidty69
+[@ttroy50]: https://github.com/ttroy50
+[@ulido]: https://github.com/ulido
+[@veleek]: https://github.com/veleek
+[@w1ll1am23]: https://github.com/w1ll1am23
+[@yienxu]: https://github.com/yienxu
+[__init__ docs]: https://home-assistant.io/components/__init__/
+[alarm_control_panel.alarmdecoder docs]: https://home-assistant.io/components/alarm_control_panel.alarmdecoder/
+[alarm_control_panel.concord232 docs]: https://home-assistant.io/components/alarm_control_panel.concord232/
+[alarm_control_panel.egardia docs]: https://home-assistant.io/components/alarm_control_panel.egardia/
+[alarmdecoder docs]: https://home-assistant.io/components/alarmdecoder/
+[alexa.intent docs]: https://home-assistant.io/components/alexa.intent/
+[alexa.smart_home docs]: https://home-assistant.io/components/alexa.smart_home/
+[api docs]: https://home-assistant.io/components/api/
+[automation.state docs]: https://home-assistant.io/docs/automation/trigger/#state-trigger
+[binary_sensor docs]: https://home-assistant.io/components/binary_sensor/
+[binary_sensor.alarmdecoder docs]: https://home-assistant.io/components/binary_sensor.alarmdecoder/
+[binary_sensor.concord232 docs]: https://home-assistant.io/components/binary_sensor.concord232/
+[binary_sensor.deconz docs]: https://home-assistant.io/components/binary_sensor.deconz/
+[binary_sensor.isy994 docs]: https://home-assistant.io/components/binary_sensor.isy994/
+[binary_sensor.knx docs]: https://home-assistant.io/components/binary_sensor.knx/
+[binary_sensor.rest docs]: https://home-assistant.io/components/binary_sensor.rest/
+[binary_sensor.template docs]: https://home-assistant.io/components/binary_sensor.template/
+[binary_sensor.threshold docs]: https://home-assistant.io/components/binary_sensor.threshold/
+[binary_sensor.trend docs]: https://home-assistant.io/components/binary_sensor.trend/
+[binary_sensor.workday docs]: https://home-assistant.io/components/binary_sensor.workday/
+[camera.doorbird docs]: https://home-assistant.io/components/camera.doorbird/
+[camera.uvc docs]: https://home-assistant.io/components/camera.uvc/
+[climate docs]: https://home-assistant.io/components/climate/
+[climate.daikin docs]: https://home-assistant.io/components/climate.daikin/
+[climate.demo docs]: https://home-assistant.io/components/climate.demo/
+[climate.econet docs]: https://home-assistant.io/components/climate.econet/
+[climate.generic_thermostat docs]: https://home-assistant.io/components/climate.generic_thermostat/
+[climate.hive docs]: https://home-assistant.io/components/climate.hive/
+[climate.homematic docs]: https://home-assistant.io/components/climate.homematic/
+[climate.knx docs]: https://home-assistant.io/components/climate.knx/
+[climate.netatmo docs]: https://home-assistant.io/components/climate.netatmo/
+[climate.sensibo docs]: https://home-assistant.io/components/climate.sensibo/
+[climate.tado docs]: https://home-assistant.io/components/climate.tado/
+[climate.touchline docs]: https://home-assistant.io/components/climate.touchline/
+[cloud docs]: https://home-assistant.io/components/cloud/
+[cloud.auth_api docs]: https://home-assistant.io/components/cloud.auth_api/
+[cloud.http_api docs]: https://home-assistant.io/components/cloud.http_api/
+[cloud.iot docs]: https://home-assistant.io/components/cloud.iot/
+[coinbase docs]: https://home-assistant.io/components/coinbase/
+[conversation docs]: https://home-assistant.io/components/conversation/
+[cover.isy994 docs]: https://home-assistant.io/components/cover.isy994/
+[cover.knx docs]: https://home-assistant.io/components/cover.knx/
+[cover.tahoma docs]: https://home-assistant.io/components/cover.tahoma/
+[cover.template docs]: https://home-assistant.io/components/cover.template/
+[cover.xiaomi_aqara docs]: https://home-assistant.io/components/cover.xiaomi_aqara/
+[deconz docs]: https://home-assistant.io/components/deconz/
+[device_tracker docs]: https://home-assistant.io/components/device_tracker/
+[device_tracker.asuswrt docs]: https://home-assistant.io/components/device_tracker.asuswrt/
+[device_tracker.bluetooth_le_tracker docs]: https://home-assistant.io/components/device_tracker.bluetooth_le_tracker/
+[device_tracker.bluetooth_tracker docs]: https://home-assistant.io/components/device_tracker.bluetooth_tracker/
+[device_tracker.gpslogger docs]: https://home-assistant.io/components/device_tracker.gpslogger/
+[device_tracker.owntracks docs]: https://home-assistant.io/components/device_tracker.owntracks/
+[device_tracker.ping docs]: https://home-assistant.io/components/device_tracker.ping/
+[device_tracker.snmp docs]: https://home-assistant.io/components/device_tracker.snmp/
+[device_tracker.tile docs]: https://home-assistant.io/components/device_tracker.tile/
+[digital_ocean docs]: https://home-assistant.io/components/digital_ocean/
+[fan.insteon_local docs]: https://home-assistant.io/components/fan.insteon_local/
+[fan.isy994 docs]: https://home-assistant.io/components/fan.isy994/
+[fan.xiaomi_miio docs]: https://home-assistant.io/components/fan.xiaomi_miio/
+[google_assistant docs]: https://home-assistant.io/components/google_assistant/
+[google_assistant.http docs]: https://home-assistant.io/components/google_assistant.http/
+[google_assistant.smart_home docs]: https://home-assistant.io/components/google_assistant.smart_home/
+[group docs]: https://home-assistant.io/components/group/
+[hassio docs]: https://home-assistant.io/components/hassio/
+[history docs]: https://home-assistant.io/components/history/
+[hive docs]: https://home-assistant.io/components/hive/
+[homematic docs]: https://home-assistant.io/components/homematic/
+[http docs]: https://home-assistant.io/components/http/
+[image_processing.opencv docs]: https://home-assistant.io/components/image_processing.opencv/
+[input_boolean docs]: https://home-assistant.io/components/input_boolean/
+[input_select docs]: https://home-assistant.io/components/input_select/
+[insteon_local docs]: https://home-assistant.io/components/insteon_local/
+[isy994 docs]: https://home-assistant.io/components/isy994/
+[knx docs]: https://home-assistant.io/components/knx/
+[light.deconz docs]: https://home-assistant.io/components/light.deconz/
+[light.greenwave docs]: https://home-assistant.io/components/light.greenwave/
+[light.hive docs]: https://home-assistant.io/components/light.hive/
+[light.hue docs]: https://home-assistant.io/components/light.hue/
+[light.iglo docs]: https://home-assistant.io/components/light.iglo/
+[light.insteon_local docs]: https://home-assistant.io/components/light.insteon_local/
+[light.isy994 docs]: https://home-assistant.io/components/light.isy994/
+[light.knx docs]: https://home-assistant.io/components/light.knx/
+[light.lifx docs]: https://home-assistant.io/components/light.lifx/
+[light.mqtt docs]: https://home-assistant.io/components/light.mqtt/
+[light.osramlightify docs]: https://home-assistant.io/components/light.osramlightify/
+[light.template docs]: https://home-assistant.io/components/light.template/
+[light.tplink docs]: https://home-assistant.io/components/light.tplink/
+[light.xiaomi_miio docs]: https://home-assistant.io/components/light.xiaomi_miio/
+[light.zha docs]: https://home-assistant.io/components/light.zha/
+[lock.isy994 docs]: https://home-assistant.io/components/lock.isy994/
+[media_extractor docs]: https://home-assistant.io/components/media_extractor/
+[media_player.cast docs]: https://home-assistant.io/components/media_player.cast/
+[media_player.kodi docs]: https://home-assistant.io/components/media_player.kodi/
+[media_player.monoprice docs]: https://home-assistant.io/components/media_player.monoprice/
+[media_player.plex docs]: https://home-assistant.io/components/media_player.plex/
+[media_player.squeezebox docs]: https://home-assistant.io/components/media_player.squeezebox/
+[media_player.yamaha docs]: https://home-assistant.io/components/media_player.yamaha/
+[modbus docs]: https://home-assistant.io/components/modbus/
+[notify.html5 docs]: https://home-assistant.io/components/notify.html5/
+[notify.pushbullet docs]: https://home-assistant.io/components/notify.pushbullet/
+[notify.webostv docs]: https://home-assistant.io/components/notify.webostv/
+[octoprint docs]: https://home-assistant.io/components/octoprint/
+[prometheus docs]: https://home-assistant.io/components/prometheus/
+[python_script docs]: https://home-assistant.io/components/python_script/
+[rainbird docs]: https://home-assistant.io/components/rainbird/
+[remember_the_milk docs]: https://home-assistant.io/components/remember_the_milk/
+[sensor.alpha_vantage docs]: https://home-assistant.io/components/sensor.alpha_vantage/
+[sensor.bitcoin docs]: https://home-assistant.io/components/sensor.bitcoin/
+[sensor.coinbase docs]: https://home-assistant.io/components/sensor.coinbase/
+[sensor.deconz docs]: https://home-assistant.io/components/sensor.deconz/
+[sensor.deutsche_bahn docs]: https://home-assistant.io/components/sensor.deutsche_bahn/
+[sensor.discogs docs]: https://home-assistant.io/components/sensor.discogs/
+[sensor.etherscan docs]: https://home-assistant.io/components/sensor.etherscan/
+[sensor.fido docs]: https://home-assistant.io/components/sensor.fido/
+[sensor.hydroquebec docs]: https://home-assistant.io/components/sensor.hydroquebec/
+[sensor.imap_email_content docs]: https://home-assistant.io/components/sensor.imap_email_content/
+[sensor.irish_rail_transport docs]: https://home-assistant.io/components/sensor.irish_rail_transport/
+[sensor.isy994 docs]: https://home-assistant.io/components/sensor.isy994/
+[sensor.knx docs]: https://home-assistant.io/components/sensor.knx/
+[sensor.luftdaten docs]: https://home-assistant.io/components/sensor.luftdaten/
+[sensor.metoffice docs]: https://home-assistant.io/components/sensor.metoffice/
+[sensor.miflora docs]: https://home-assistant.io/components/sensor.miflora/
+[sensor.mqtt docs]: https://home-assistant.io/components/sensor.mqtt/
+[sensor.openweathermap docs]: https://home-assistant.io/components/sensor.openweathermap/
+[sensor.plex docs]: https://home-assistant.io/components/sensor.plex/
+[sensor.rainbird docs]: https://home-assistant.io/components/sensor.rainbird/
+[sensor.snmp docs]: https://home-assistant.io/components/sensor.snmp/
+[sensor.sochain docs]: https://home-assistant.io/components/sensor.sochain/
+[sensor.statistics docs]: https://home-assistant.io/components/sensor.statistics/
+[sensor.steam_online docs]: https://home-assistant.io/components/sensor.steam_online/
+[sensor.swiss_public_transport docs]: https://home-assistant.io/components/sensor.swiss_public_transport/
+[sensor.systemmonitor docs]: https://home-assistant.io/components/sensor.systemmonitor/
+[sensor.tado docs]: https://home-assistant.io/components/sensor.tado/
+[sensor.template docs]: https://home-assistant.io/components/sensor.template/
+[sensor.transmission docs]: https://home-assistant.io/components/sensor.transmission/
+[sensor.xbox_live docs]: https://home-assistant.io/components/sensor.xbox_live/
+[sensor.zoneminder docs]: https://home-assistant.io/components/sensor.zoneminder/
+[snips docs]: https://home-assistant.io/components/snips/
+[switch.insteon_local docs]: https://home-assistant.io/components/switch.insteon_local/
+[switch.isy994 docs]: https://home-assistant.io/components/switch.isy994/
+[switch.knx docs]: https://home-assistant.io/components/switch.knx/
+[switch.mochad docs]: https://home-assistant.io/components/switch.mochad/
+[switch.rainbird docs]: https://home-assistant.io/components/switch.rainbird/
+[switch.rpi_rf docs]: https://home-assistant.io/components/switch.rpi_rf/
+[switch.snmp docs]: https://home-assistant.io/components/switch.snmp/
+[switch.template docs]: https://home-assistant.io/components/switch.template/
+[switch.tplink docs]: https://home-assistant.io/components/switch.tplink/
+[switch.transmission docs]: https://home-assistant.io/components/switch.transmission/
+[switch.xiaomi_miio docs]: https://home-assistant.io/components/switch.xiaomi_miio/
+[tahoma docs]: https://home-assistant.io/components/tahoma/
+[telegram_bot docs]: https://home-assistant.io/components/telegram_bot/
+[timer docs]: https://home-assistant.io/components/timer/
+[tts.baidu docs]: https://home-assistant.io/components/tts.baidu/
+[tts.marytts docs]: https://home-assistant.io/components/tts.marytts/
+[updater docs]: https://home-assistant.io/components/updater/
+[vacuum.xiaomi_miio docs]: https://home-assistant.io/components/vacuum.xiaomi_miio/
+[weather.darksky docs]: https://home-assistant.io/components/weather.darksky/
+[weather.openweathermap docs]: https://home-assistant.io/components/weather.openweathermap/
+[weather.yweather docs]: https://home-assistant.io/components/weather.yweather/
+[websocket_api docs]: https://home-assistant.io/components/websocket_api/
+[wemo docs]: https://home-assistant.io/components/wemo/
+[zigbee docs]: https://home-assistant.io/components/zigbee/
diff --git a/source/images/blog/2018-01-0.61/components.png b/source/images/blog/2018-01-0.61/components.png
new file mode 100644
index 00000000000..8f03dfe6b70
Binary files /dev/null and b/source/images/blog/2018-01-0.61/components.png differ
diff --git a/source/images/supported_brands/coinbase.png b/source/images/supported_brands/coinbase.png
new file mode 100755
index 00000000000..03f5018cae8
Binary files /dev/null and b/source/images/supported_brands/coinbase.png differ
diff --git a/source/images/supported_brands/deconz.jpeg b/source/images/supported_brands/deconz.jpeg
new file mode 100644
index 00000000000..6bd2e5373d7
Binary files /dev/null and b/source/images/supported_brands/deconz.jpeg differ
diff --git a/source/images/supported_brands/discogs.png b/source/images/supported_brands/discogs.png
new file mode 100644
index 00000000000..e207579d99a
Binary files /dev/null and b/source/images/supported_brands/discogs.png differ
diff --git a/source/images/supported_brands/econet.png b/source/images/supported_brands/econet.png
new file mode 100644
index 00000000000..cff0e0706c4
Binary files /dev/null and b/source/images/supported_brands/econet.png differ
diff --git a/source/images/supported_brands/greenwavereality.png b/source/images/supported_brands/greenwavereality.png
new file mode 100644
index 00000000000..d80243b4750
Binary files /dev/null and b/source/images/supported_brands/greenwavereality.png differ
diff --git a/source/images/supported_brands/iglo.png b/source/images/supported_brands/iglo.png
new file mode 100644
index 00000000000..69b51da1d34
Binary files /dev/null and b/source/images/supported_brands/iglo.png differ
diff --git a/source/images/supported_brands/nuheat.png b/source/images/supported_brands/nuheat.png
new file mode 100644
index 00000000000..4bc30571f0b
Binary files /dev/null and b/source/images/supported_brands/nuheat.png differ
diff --git a/source/images/supported_brands/roth.png b/source/images/supported_brands/roth.png
new file mode 100644
index 00000000000..7fadc544d06
Binary files /dev/null and b/source/images/supported_brands/roth.png differ
diff --git a/source/images/supported_brands/sochain.png b/source/images/supported_brands/sochain.png
new file mode 100644
index 00000000000..0cfc42bc6eb
Binary files /dev/null and b/source/images/supported_brands/sochain.png differ
diff --git a/source/index.html b/source/index.html
index 173bef72c13..a847b2632b9 100644
--- a/source/index.html
+++ b/source/index.html
@@ -38,7 +38,7 @@ description: Open-source home automation platform running on Python 3. Track and
Use Alexa to control Home Assistant.
**Services**.
@@ -222,6 +222,22 @@ automation:
entity_id: climate.kitchen
swing_mode: 1
```
+### {% linkable_title Service `climate.turn_on` %}
+
+Turn climate device on
+
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | ----------- |
+| `entity_id` | yes | String or list of strings that point at `entity_id`'s of climate devices to control. Targets all when omitted.
+
+### {% linkable_title Service `climate.turn_off` %}
+
+Turn climate device off
+
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | ----------- |
+| `entity_id` | yes | String or list of strings that point at `entity_id`'s of climate devices to control. Targets all when omitted.
+
#### {% linkable_title Customization %}
The step for the setpoint can be adjusted (default to 0,5 increments) by adding the following line into configuration
diff --git a/source/_components/climate.mqtt.markdown b/source/_components/climate.mqtt.markdown
index 94a9bf27e70..03c5808ceb6 100644
--- a/source/_components/climate.mqtt.markdown
+++ b/source/_components/climate.mqtt.markdown
@@ -28,34 +28,121 @@ climate:
temperature_command_topic: /sensors/hvac_study/target_temp
```
-Configuration variables *except* for MQTT topics:
-
-- **name** (*Required*): Name of MQTT HVAC.
-- **qos** (*Optional*): The maximum QoS level of the state topic. Default is `0` and will also be used to publishing messages.
-- **retain** (*Optional*): If the published message should have the retain flag on or not.
-- **send_if_off** (*Optional*): Set to `false` to suppress sending of all MQTT messages when the current mode is `Off`. Defaults to `true`.
-- **initial** (*Optional*): Set the initial target temperature. Defaults to 21 degrees.
-- **payload_on** (*Optional*): For MQTT topics that control an `on` / `off` value (e.g., `aux_command_topic`), set the value that should be sent for `on`. Defaults to 'ON'.
-- **payload_off** (*Optional*): For MQTT topics that control an `on` / `off` value (e.g., `aux_command_topic`), set the value that should be sent for `off`. Defaults to 'OFF'.
-
-Configuration of the MQTT topics:
-
-- **current_temperature_topic** (*Optional*): The MQTT topic on which to listen for the current temperature
-- **power_command_topic** (*Optional*): 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.
-- **mode_command_topic** (*Optional*): The MQTT topic to publish commands to change the HVAC operation mode.
-- **mode_state_topic** (*Optional*): The MQTT topic to subscribe for changes of the HVAC operation mode. If this is not set, the operation mode works in optimistic mode (see below).
-- **temperature_command_topic** (*Optional*): The MQTT topic to publish commands to change the target temperature.
-- **temperature_state_topic** (*Optional*): The MQTT topic to subscribe for changes in the target temperature. If this is not set, the target temperature works in optimistic mode (see below).
-- **fan_mode_command_topic** (*Optional*): The MQTT topic to publish commands to change the fan mode.
-- **fan_mode_state_topic** (*Optional*): The MQTT topic to subscribe for changes of the HVAC fan mode. If this is not set, the fan mode works in optimistic mode (see below).
-- **swing_mode_command_topic** (*Optional*): The MQTT topic to publish commands to change the swing mode.
-- **swing_mode_state_topic** (*Optional*): The MQTT topic to subscribe for changes of the HVAC swing mode. If this is not set, the swing mode works in optimistic mode (see below).
-- **away_mode_command_topic** (*Optional*): The MQTT topic to publish commands to change the away mode.
-- **away_mode_state_topic** (*Optional*): The MQTT topic to subscribe for changes of the HVAC away mode. If this is not set, the away mode works in optimistic mode (see below).
-- **hold_command_topic** (*Optional*): The MQTT topic to publish commands to change the hold mode.
-- **hold_state_topic** (*Optional*): The MQTT topic to subscribe for changes of the HVAC hold mode. If this is not set, the hold mode works in optimistic mode (see below).
-- **aux_command_topic** (*Optional*): The MQTT topic to publish commands to switch auxiliary heat.
-- **aux_state_topic** (*Optional*): The MQTT topic to subscribe for changes of the auxiliary heat mode. If this is not set, the auxiliary heat mode works in optimistic mode (see below).
+{% configuration %}
+name:
+ description: The name of the HVAC.
+ required: false
+ type: string
+ default: MQTT HVAC
+qos:
+ description: The maximum QoS level to be used when receiving and publishing messages.
+ required: false
+ type: integer
+ default: 0
+retain:
+ description: Defines if published messages should have the retain flag set.
+ required: false
+ type: boolean
+ default: false
+send_if_off:
+ description: "Set to `false` to suppress sending of all MQTT messages when the current mode is `Off`."
+ required: false
+ type: boolean
+ default: true
+initial:
+ description: Set the initial target temperature.
+ required: false
+ type: number
+ default: 21
+payload_on:
+ description: The payload that represents enabled state.
+ required: false
+ type: string
+ default: ON
+payload_off:
+ description: The payload that represents disabled state.
+ required: false
+ type: string
+ default: OFF
+availability_topic:
+ description: The MQTT topic subscribed to receive availability (online/offline) updates.
+ required: false
+ type: string
+payload_available:
+ description: The payload that represents the available state.
+ required: false
+ type: string
+ default: online
+payload_not_available:
+ description: The payload that represents the unavailable state.
+ required: false
+ type: string
+ default: offline
+current_temperature_topic:
+ description: The MQTT topic on which to listen for the current temperature.
+ required: false
+ type: string
+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
+ type: string
+mode_command_topic:
+ description: The MQTT topic to publish commands to change the HVAC operation mode.
+ required: false
+ type: string
+mode_state_topic:
+ description: The MQTT topic to subscribe for changes of the HVAC operation mode. If this is not set, the operation mode works in optimistic mode (see below).
+ required: false
+ type: string
+temperature_command_topic:
+ description: The MQTT topic to publish commands to change the target temperature.
+ required: false
+ type: string
+temperature_state_topic:
+ description: The MQTT topic to subscribe for changes in the target temperature. If this is not set, the target temperature works in optimistic mode (see below).
+ required: false
+ type: string
+fan_mode_command_topic:
+ description: The MQTT topic to publish commands to change the fan mode.
+ required: false
+ type: string
+fan_mode_state_topic:
+ description: The MQTT topic to subscribe for changes of the HVAC fan mode. If this is not set, the fan mode works in optimistic mode (see below).
+ required: false
+ type: string
+swing_mode_command_topic:
+ description: The MQTT topic to publish commands to change the swing mode.
+ required: false
+ type: string
+swing_mode_state_topic:
+ description: The MQTT topic to subscribe for changes of the HVAC swing mode. If this is not set, the swing mode works in optimistic mode (see below).
+ required: false
+ type: string
+away_mode_command_topic:
+ description: The MQTT topic to publish commands to change the away mode.
+ required: false
+ type: string
+away_mode_state_topic:
+ description: The MQTT topic to subscribe for changes of the HVAC away mode. If this is not set, the away mode works in optimistic mode (see below).
+ required: false
+ type: string
+hold_command_topic:
+ description: The MQTT topic to publish commands to change the hold mode.
+ required: false
+ type: string
+hold_state_topic:
+ description: The MQTT topic to subscribe for changes of the HVAC hold mode. If this is not set, the hold mode works in optimistic mode (see below).
+ required: false
+ type: string
+aux_command_topic:
+ description: The MQTT topic to publish commands to switch auxiliary heat.
+ required: false
+ type: string
+aux_state_topic:
+ description: The MQTT topic to subscribe for changes of the auxiliary heat mode. If this is not set, the auxiliary heat mode works in optimistic mode (see below).
+ required: false
+ type: string
+{% endconfiguration %}
#### Optimistic mode
diff --git a/source/_components/climate.nuheat.markdown b/source/_components/climate.nuheat.markdown
new file mode 100644
index 00000000000..51ffd6fee4b
--- /dev/null
+++ b/source/_components/climate.nuheat.markdown
@@ -0,0 +1,139 @@
+---
+layout: page
+title: "NuHeat Thermostat"
+description: "Instructions how to integrate your NuHeat Signature thermostats within Home Assistant."
+date: 2017-11-11 18:00
+sidebar: true
+comments: false
+sharing: true
+footer: true
+logo: nuheat.png
+ha_category: Climate
+ha_release: 0.61
+ha_iot_class: "Cloud Polling"
+---
+
+