- {{ page.title }} -
-- - {{ content }} -
++You should choose a unique device name (DEVICE_NAME) to avoid clashes with other devices. +
+ +The JSON payload must contain the new state and can have a friendly name. The friendly name is used in the frontend to name the sensor. + +```json +{"state": "on", "attributes": {"friendly_name": "Radio"}} +``` + +For a quick test `curl` can be useful to "simulate" a device. + +```bash +$ curl -X POST -H "x-ha-access: YOUR_PASSWORD" \ + -d '{"state": "off", "attributes": {"friendly_name": "Radio"}}' \ + http://localhost:8123/api/states/binary_sensor.radio +``` + +To check if the sensor is working, use again `curl` to retrieve the [current state](/developers/rest_api/#get-apistatesltentity_id). + +```bash +$ curl -X GET -H "x-ha-access: YOUR_PASSWORD" \ + http://localhost:8123/api/states/binary_sensor.radio +{ + "attributes": { + "friendly_name": "Radio" + }, + "entity_id": "binary_sensor.radio", + "last_changed": "16:45:51 05-02-2016", + "last_updated": "16:45:51 05-02-2016", + "state": "off" +} +``` + +## {% linkable_title Examples %} + +In this section you find some real life examples of how to use this sensor. Beside `curl`. + +### {% linkable_title Using Python request module %} + +As already shown on the [API](/developers/rest_api/) page, it's very simple to use Python and the [Requests](http://docs.python-requests.org/en/latest/) module for the interaction with Home Assistant. + +```python +response = requests.post( + 'http://localhost:8123/api/states/binary_sensor.radio', + headers={'x-ha-access': 'YOUR_PASSWORD', 'content-type': 'application/json'}, + data=json.dumps({'state': 'on', 'attributes': {'friendly_name': 'Radio'}})) +print(response.text) +``` + +### {% linkable_title Using `httpie` %} + +[`httpie`](https://github.com/jkbrzt/httpie) is a user-friendly CLI HTTP client. + +```bash +$ http -v POST http://localhost:8123/api/states/binary_sensor.radio \ + x-ha-access:YOUR_PASSWORD state=off \ + attributes:='{"friendly_name": "Radio"}' +``` diff --git a/source/_components/binary_sensor.markdown b/source/_components/binary_sensor.markdown index 477642ec958..f3bbd430190 100644 --- a/source/_components/binary_sensor.markdown +++ b/source/_components/binary_sensor.markdown @@ -1,5 +1,5 @@ --- -layout: component +layout: page title: "Binary Sensor" description: "Instructions how to setup your binary sensors with Home Assistant." date: 2015-11-20 14:00 diff --git a/source/_components/binary_sensor.mqtt.markdown b/source/_components/binary_sensor.mqtt.markdown index 6ab07dff653..43a3ab06a58 100644 --- a/source/_components/binary_sensor.mqtt.markdown +++ b/source/_components/binary_sensor.mqtt.markdown @@ -1,6 +1,6 @@ --- -layout: component -title: "MQTT binary sensor" +layout: page +title: "MQTT Binary Sensor" description: "Instructions how to integrate MQTT binary sensors within Home Assistant." date: 2015-05-30 23:21 sidebar: true diff --git a/source/_components/binary_sensor.nest.markdown b/source/_components/binary_sensor.nest.markdown index ce43d3f95a8..06ed382f461 100644 --- a/source/_components/binary_sensor.nest.markdown +++ b/source/_components/binary_sensor.nest.markdown @@ -1,6 +1,6 @@ --- -layout: component -title: "Nest binary sensor" +layout: page +title: "Nest Binary Sensor" description: "Instructions how to integrate Nest binary sensors within Home Assistant." date: 2016-01-26 08:00 sidebar: true @@ -12,7 +12,7 @@ ha_category: Binary Sensor --- -The Nest binary sensor platform let you monitor various states of a thermostat from [Nest](https://nest.com). +The `nest` binary sensor platform let you monitor various states of a thermostat from [Nest](https://nest.com). To set it up, add the following information to your `configuration.yaml` file: @@ -21,18 +21,27 @@ sensor: platform: nest monitored_conditions: - 'fan' - - 'hvac_ac_state', - - 'hvac_aux_heater_state', - - 'hvac_heat_x2_state', - - 'hvac_heat_x3_state', - - 'hvac_alt_heat_state', - - 'hvac_alt_heat_x2_state', - - 'hvac_emer_heat_state', + - 'hvac_ac_state' + - 'hvac_aux_heater_state' + - 'hvac_heat_x2_state' + - 'hvac_heat_x3_state' + - 'hvac_alt_heat_state' + - 'hvac_alt_heat_x2_state' + - 'hvac_emer_heat_state' - 'online' ``` Configuration variables: - **monitored_conditions** array (*Required*): States to monitor. + - 'fan' + - 'hvac_ac_state' + - 'hvac_aux_heater_state' + - 'hvac_heat_x2_state' + - 'hvac_heat_x3_state' + - 'hvac_alt_heat_state' + - 'hvac_alt_heat_x2_state' + - 'hvac_emer_heat_state' + - 'online' -You must have the [Nest component](https://home-assistant.io/components/nest/) configured to use this sensor.
+You must have the [Nest component](/components/nest/) configured to use this sensor.
diff --git a/source/_components/binary_sensor.rest.markdown b/source/_components/binary_sensor.rest.markdown index 6cb56043db0..474a1565d49 100644 --- a/source/_components/binary_sensor.rest.markdown +++ b/source/_components/binary_sensor.rest.markdown @@ -1,6 +1,6 @@ --- -layout: component -title: "RESTful binary sensor" +layout: page +title: "RESTful Binary Sensor" description: "Instructions how to integrate REST binary sensors into Home Assistant." date: 2015-12-17 19:10 sidebar: true diff --git a/source/_components/binary_sensor.rpi_gpio.markdown b/source/_components/binary_sensor.rpi_gpio.markdown index 4bc2f7581c4..dc2c0b8888a 100644 --- a/source/_components/binary_sensor.rpi_gpio.markdown +++ b/source/_components/binary_sensor.rpi_gpio.markdown @@ -1,6 +1,6 @@ --- -layout: component -title: "Raspberry PI GPIO sensor" +layout: page +title: "Raspberry PI GPIO Binary Sensor" description: "Instructions how to integrate the GPIO sensor capability of a Raspberry PI into Home Assistant." date: 2015-08-30 19:00 sidebar: true @@ -12,7 +12,7 @@ ha_category: Sensor --- -The rpi_gpio binary sensor platform allows you to read sensor values of the GPIOs of your [Raspberry Pi](https://www.raspberrypi.org/). +The `rpi_gpio` binary sensor platform allows you to read sensor values of the GPIOs of your [Raspberry Pi](https://www.raspberrypi.org/). To use your Raspberry Pi's GPIO in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/binary_sensor.zigbee.markdown b/source/_components/binary_sensor.zigbee.markdown index 7d270316e27..d8731ac102b 100644 --- a/source/_components/binary_sensor.zigbee.markdown +++ b/source/_components/binary_sensor.zigbee.markdown @@ -1,6 +1,6 @@ --- -layout: component -title: ZigBee Binary Sensor +layout: page +title: "ZigBee Binary Sensor" description: "Instructions on how to set up ZigBee binary sensors within Home Assistant." date: 2016-01-28 12:38 sidebar: true diff --git a/source/_components/browser.markdown b/source/_components/browser.markdown index 273c3ae7e40..c7ce25dc61e 100644 --- a/source/_components/browser.markdown +++ b/source/_components/browser.markdown @@ -1,5 +1,5 @@ --- -layout: component +layout: page title: "Browser" description: "Instructions how to setup the browser component with Home Assistant." date: 2015-01-24 14:39 diff --git a/source/_components/camera.foscam.markdown b/source/_components/camera.foscam.markdown index 9fd47c6a9fc..ed4b4106d7d 100644 --- a/source/_components/camera.foscam.markdown +++ b/source/_components/camera.foscam.markdown @@ -1,6 +1,6 @@ --- -layout: component -title: "Foscam IP camera" +layout: page +title: "Foscam IP Camera" description: "Instructions how to integrate Foscam IP cameras within Home Assistant." date: 2015-09-17 08:01 sidebar: true @@ -12,7 +12,7 @@ ha_category: Camera --- -The foscam platform allows you to watch the live stream of your [Foscam](http://www.foscam.com/) IP camera in Home Assistant. +The `foscam` platform allows you to watch the live stream of your [Foscam](http://www.foscam.com/) IP camera in Home Assistant. To enable your Foscam IP camera in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/camera.generic.markdown b/source/_components/camera.generic.markdown index 065207f37b8..3d88569b683 100644 --- a/source/_components/camera.generic.markdown +++ b/source/_components/camera.generic.markdown @@ -1,5 +1,5 @@ --- -layout: component +layout: page title: "Generic IP Camera" description: "Instructions how to integrate IP cameras within Home Assistant." date: 2015-07-11 0:36 diff --git a/source/_components/camera.markdown b/source/_components/camera.markdown index cfcc0393b24..e56503400c1 100644 --- a/source/_components/camera.markdown +++ b/source/_components/camera.markdown @@ -1,5 +1,5 @@ --- -layout: component +layout: page title: "Camera" description: "Instructions how to integrate cameras within Home Assistant." date: 2015-11-09 08:36 diff --git a/source/_components/camera.mjpeg.markdown b/source/_components/camera.mjpeg.markdown index 8fd297d0e41..4f166f044c4 100644 --- a/source/_components/camera.mjpeg.markdown +++ b/source/_components/camera.mjpeg.markdown @@ -1,5 +1,5 @@ --- -layout: component +layout: page title: "Generic MJPEG IP Camera" description: "Instructions how to integrate IP cameras within Home Assistant." date: 2015-11-09 08:36 @@ -11,7 +11,7 @@ ha_category: Camera --- -The mjpeg component allows you to integrate IP cameras which are capable to stream their video with MJPEG into Home Assistant. +The `mjpeg` component allows you to integrate IP cameras which are capable to stream their video with MJPEG into Home Assistant. To enable this sensor in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/configurator.markdown b/source/_components/configurator.markdown index d564089bc2c..44c594c9edb 100644 --- a/source/_components/configurator.markdown +++ b/source/_components/configurator.markdown @@ -1,5 +1,5 @@ --- -layout: component +layout: page title: "Configurator" description: "Instructions how to integrate the configurator in your components." date: 2015-03-15 00:51 diff --git a/source/_components/conversation.markdown b/source/_components/conversation.markdown index 7851621520d..7ff3b348b78 100644 --- a/source/_components/conversation.markdown +++ b/source/_components/conversation.markdown @@ -1,5 +1,5 @@ --- -layout: component +layout: page title: "Conversation" description: "Instructions how to have conversations with your Home Assistant." date: 2015-03-15 00:39 diff --git a/source/_components/device_sun_light_trigger.markdown b/source/_components/device_sun_light_trigger.markdown index 1b8cbc18655..dd2b298b2e1 100644 --- a/source/_components/device_sun_light_trigger.markdown +++ b/source/_components/device_sun_light_trigger.markdown @@ -1,5 +1,5 @@ --- -layout: component +layout: page title: "Presence based lights" description: "Instructions how to automate your lights with Home Assistant." date: 2015-01-20 22:36 diff --git a/source/_components/device_tracker.actiontec.markdown b/source/_components/device_tracker.actiontec.markdown index d3d5f198740..774b7ec2823 100644 --- a/source/_components/device_tracker.actiontec.markdown +++ b/source/_components/device_tracker.actiontec.markdown @@ -1,5 +1,5 @@ --- -layout: component +layout: page title: "Actiontec" description: "Instructions how to integrate Actiontec routers into Home Assistant." date: 2015-08-30 19:00 diff --git a/source/_components/device_tracker.aruba.markdown b/source/_components/device_tracker.aruba.markdown index 8a65953e5fe..4d76b30dd50 100644 --- a/source/_components/device_tracker.aruba.markdown +++ b/source/_components/device_tracker.aruba.markdown @@ -1,5 +1,5 @@ --- -layout: component +layout: page title: "Aruba" description: "Instructions how to integrate Aruba routers into Home Assistant." date: 2015-08-31 08:45 diff --git a/source/_components/device_tracker.asuswrt.markdown b/source/_components/device_tracker.asuswrt.markdown index 4ca50a9ef3b..e1590a59c93 100644 --- a/source/_components/device_tracker.asuswrt.markdown +++ b/source/_components/device_tracker.asuswrt.markdown @@ -1,5 +1,5 @@ --- -layout: component +layout: page title: "ASUSWRT" description: "Instructions how to integrate ASUSWRT based routers into Home Assistant." date: 2015-08-06 19:00 diff --git a/source/_components/device_tracker.ddwrt.markdown b/source/_components/device_tracker.ddwrt.markdown index 741959d19e1..5eee59d85f2 100644 --- a/source/_components/device_tracker.ddwrt.markdown +++ b/source/_components/device_tracker.ddwrt.markdown @@ -1,5 +1,5 @@ --- -layout: component +layout: page title: "DD-WRT" description: "Instructions how to integrate DD-WRT based routers into Home Assistant." date: 2015-05-11 09:00 diff --git a/source/_components/device_tracker.fritz.markdown b/source/_components/device_tracker.fritz.markdown index 32658f793bc..75d48a75b9f 100644 --- a/source/_components/device_tracker.fritz.markdown +++ b/source/_components/device_tracker.fritz.markdown @@ -1,5 +1,5 @@ --- -layout: component +layout: page title: "FRITZ!Box" description: "Instructions how to integrate AVM FRITZ!Box based routers into Home Assistant." date: 2015-12-13 19:00 @@ -23,7 +23,7 @@ To use an Fritz!Box router in your installation, add the following to your `conf ```yaml # Example configuration.yaml entry device_tracker: - platform: asuswrt + platform: fritz host: YOUR_ROUTER_IP username: YOUR_ADMIN_USERNAME password: YOUR_ADMIN_PASSWORD diff --git a/source/_components/device_tracker.icloud.markdown b/source/_components/device_tracker.icloud.markdown index 39299c46308..169ba7974c0 100644 --- a/source/_components/device_tracker.icloud.markdown +++ b/source/_components/device_tracker.icloud.markdown @@ -1,5 +1,5 @@ --- -layout: component +layout: page title: "iCloud" description: "Instructions how to use iCloud to track devices in Home Assistant." date: 2015-12-15 1000 diff --git a/source/_components/device_tracker.locative.markdown b/source/_components/device_tracker.locative.markdown index 17df285ccfa..dd1d40fc169 100644 --- a/source/_components/device_tracker.locative.markdown +++ b/source/_components/device_tracker.locative.markdown @@ -1,5 +1,5 @@ --- -layout: component +layout: page title: "Locative" description: "Instructions how to use Locative to track devices in Home Assistant." date: 2015-10-13 19:00 diff --git a/source/_components/device_tracker.luci.markdown b/source/_components/device_tracker.luci.markdown index 3db44706c83..81e60df206c 100644 --- a/source/_components/device_tracker.luci.markdown +++ b/source/_components/device_tracker.luci.markdown @@ -1,5 +1,5 @@ --- -layout: component +layout: page title: "OpenWRT (luci)" description: "Instructions how to integrate OpenWRT routers into Home Assistant." date: 2015-03-23 19:59 diff --git a/source/_components/device_tracker.markdown b/source/_components/device_tracker.markdown index bb36d19013d..f65447717db 100644 --- a/source/_components/device_tracker.markdown +++ b/source/_components/device_tracker.markdown @@ -1,5 +1,5 @@ --- -layout: component +layout: page title: "Device Tracker" description: "Instructions how to setup device tracking within Home Assistant." date: 2015-01-20 22:36 diff --git a/source/_components/device_tracker.mqtt.markdown b/source/_components/device_tracker.mqtt.markdown index 70c71cdebe6..7c0eed7d1d4 100644 --- a/source/_components/device_tracker.mqtt.markdown +++ b/source/_components/device_tracker.mqtt.markdown @@ -1,6 +1,6 @@ --- -layout: component -title: "MQTT device tracker" +layout: page +title: "MQTT Device Tracker" description: "Instructions how to use MQTT to track devices in Home Assistant." date: 2015-09-19 20:41 sidebar: true diff --git a/source/_components/device_tracker.netgear.markdown b/source/_components/device_tracker.netgear.markdown index a5a508ba4d4..67a37008ece 100644 --- a/source/_components/device_tracker.netgear.markdown +++ b/source/_components/device_tracker.netgear.markdown @@ -1,5 +1,5 @@ --- -layout: component +layout: page title: "Netgear" description: "Instructions how to integrate Netgear routers into Home Assistant." date: 2015-03-23 19:59 diff --git a/source/_components/device_tracker.nmap_scanner.markdown b/source/_components/device_tracker.nmap_scanner.markdown index f5fb0f42685..e2fad493eaa 100644 --- a/source/_components/device_tracker.nmap_scanner.markdown +++ b/source/_components/device_tracker.nmap_scanner.markdown @@ -1,5 +1,5 @@ --- -layout: component +layout: page title: "Nmap" description: "Instructions how to integrate Nmap into Home Assistant." date: 2015-03-23 19:59 diff --git a/source/_components/device_tracker.owntracks.markdown b/source/_components/device_tracker.owntracks.markdown index 2160821844f..10a04326a4b 100644 --- a/source/_components/device_tracker.owntracks.markdown +++ b/source/_components/device_tracker.owntracks.markdown @@ -1,5 +1,5 @@ --- -layout: component +layout: page title: "Owntracks" description: "Instructions how to use Owntracks to track devices in Home Assistant." date: 2015-09-22 07:00 diff --git a/source/_components/device_tracker.snmp.markdown b/source/_components/device_tracker.snmp.markdown index d5ef35f20fc..c33e605c692 100644 --- a/source/_components/device_tracker.snmp.markdown +++ b/source/_components/device_tracker.snmp.markdown @@ -1,5 +1,5 @@ --- -layout: component +layout: page title: "SNMP" description: "Instructions how to integrate SNMP into Home Assistant." date: 2015-10-08 12:00 diff --git a/source/_components/device_tracker.thomson.markdown b/source/_components/device_tracker.thomson.markdown index bb85bd340d0..8a81c40ad9e 100644 --- a/source/_components/device_tracker.thomson.markdown +++ b/source/_components/device_tracker.thomson.markdown @@ -1,5 +1,5 @@ --- -layout: component +layout: page title: "Thomson" description: "Instructions how to integrate Thomson routers into Home Assistant." date: 2015-08-30 19:00 diff --git a/source/_components/device_tracker.tomato.markdown b/source/_components/device_tracker.tomato.markdown index ad55ca2938d..db77f188633 100644 --- a/source/_components/device_tracker.tomato.markdown +++ b/source/_components/device_tracker.tomato.markdown @@ -1,5 +1,5 @@ --- -layout: component +layout: page title: "Tomato" description: "Instructions how to integrate Tomato routers into Home Assistant." date: 2015-03-23 19:59 diff --git a/source/_components/device_tracker.tplink.markdown b/source/_components/device_tracker.tplink.markdown index a95022d65a2..50dbf15802f 100644 --- a/source/_components/device_tracker.tplink.markdown +++ b/source/_components/device_tracker.tplink.markdown @@ -1,5 +1,5 @@ --- -layout: component +layout: page title: "TP-Link" description: "Instructions how to integrate TP-Link routers into Home Assistant." date: 2015-06-22 10:30 diff --git a/source/_components/device_tracker.ubus.markdown b/source/_components/device_tracker.ubus.markdown index 9ad16682b54..71a8c26db34 100644 --- a/source/_components/device_tracker.ubus.markdown +++ b/source/_components/device_tracker.ubus.markdown @@ -1,5 +1,5 @@ --- -layout: component +layout: page title: "OpenWRT (ubus)" description: "Instructions how to integrate OpenWRT routers into Home Assistant." date: 2015-03-23 19:59 diff --git a/source/_components/discovery.markdown b/source/_components/discovery.markdown index 9f316298063..8633fba2c2e 100644 --- a/source/_components/discovery.markdown +++ b/source/_components/discovery.markdown @@ -1,5 +1,5 @@ --- -layout: component +layout: page title: "Discovery" description: "Instructions how to setup Home Assistant to discover new devices." date: 2015-01-24 14:39 diff --git a/source/_components/downloader.markdown b/source/_components/downloader.markdown index 928d1b0da98..b347ad9ca7e 100644 --- a/source/_components/downloader.markdown +++ b/source/_components/downloader.markdown @@ -1,5 +1,5 @@ --- -layout: component +layout: page title: "Downloader" description: "Instructions how to setup the downloader component with Home Assistant." date: 2015-01-24 14:39 diff --git a/source/_components/ecobee.markdown b/source/_components/ecobee.markdown index fc21f7042ec..69879ddab9a 100644 --- a/source/_components/ecobee.markdown +++ b/source/_components/ecobee.markdown @@ -1,5 +1,5 @@ --- -layout: component +layout: page title: "Ecobee" description: "Instructions for how to integrate Ecobee thermostats and sensors within Home Assistant." date: 2015-11-30 17:54 diff --git a/source/_components/group.markdown b/source/_components/group.markdown index e28ac57bbd6..a33a3afd88a 100644 --- a/source/_components/group.markdown +++ b/source/_components/group.markdown @@ -1,5 +1,5 @@ --- -layout: component +layout: page title: "Group" description: "Instructions how to setup groups within Home Assistant." date: 2015-03-23 19:59 diff --git a/source/_components/history.markdown b/source/_components/history.markdown index d2cd12b6f1b..90e5df451aa 100644 --- a/source/_components/history.markdown +++ b/source/_components/history.markdown @@ -1,5 +1,5 @@ --- -layout: component +layout: page title: "History" description: "Instructions how to enable history support for Home Assistant." date: 2015-03-23 19:59 @@ -28,22 +28,22 @@ history:-Events are saved in a local database. Google Graphs is used to draw the graph. Drawing is happening 100% in your browser - no data is transferred to anyone at any time. +Events are saved in a local database. Google Graphs is used to draw the graph. Drawing is happening 100% in your browser. No data is transferred to anyone at any time.
#### {% linkable_title Implementation details %} -The history is stored in a SQLite databse `home-assistant.db` within your config directory. +The history is stored in a SQLite database `home-assistant.db` within your config directory. - - events table is all events except time_changed that happened while recorder component was running. - - states table contains all the new_state values of state_changed events. + - events table is all events except `time_changed` that happened while recorder component was running. + - states table contains all the `new_state` values of `state_changed` events. - Inside the states table you have: - - entity_id: the entity_id of the entity - - state: the state of the entity - - attributes: JSON of the state attributes - - last_changed: timestamp last time the state has changed. A state_changed event can happen when just attributes change. - - last_updated: timestamp anything has changed (state, attributes) - - created: timestamp this entry was inserted into the database + - `entity_id`: the entity_id of the entity + - `state`: the state of the entity + - `attributes`: JSON of the state attributes + - `last_changed`: timestamp last time the state has changed. A state_changed event can happen when just attributes change. + - `last_updated`: timestamp anything has changed (state, attributes) + - `created`: timestamp this entry was inserted into the database When the history component queries the states table it only selects states where the state has changed: `WHERE last_changed=last_updated` @@ -55,3 +55,7 @@ SQLite databases do not support native dates. That's why all the dates are saved from datetime import datetime datetime.fromtimestamp(1422830502) ``` + +#### {% linkable_title API %} + +The history information are also available through the [RESTful API](/developers/rest_api/#get-apihistory). diff --git a/source/_components/http.markdown b/source/_components/http.markdown index f0876ff711d..a05b058d1f7 100644 --- a/source/_components/http.markdown +++ b/source/_components/http.markdown @@ -1,5 +1,5 @@ --- -layout: component +layout: page title: "HTTP" description: "Offers a web framework to serve files." date: 2015-12-06 21:35 @@ -25,9 +25,16 @@ http: Configuration variables: -- **api_password** (*Optional*): Protect Home Assistant with a password +- **api_password** (*Optional*): Protect Home Assistant with a password. - **server_port** (*Optional*): Let you set a port to use. Defaults to 8123. - **development** (*Optional*): Disable caching and load unvulcanized assets. Useful for Frontend development. - **ssl_certificate** (*Optional*): Path to your TLS/SSL certificate to serve Home Assistant over a secure connection. - **ssl_key** (*Optional*): Path to your TLS/SSL key to serve Home Assistant over a secure connection. +On top of the `http` component is a [REST API](/developers/rest_api/) and a [Python API](/developers/python_api/) available. + +The `http` platforms are not a real platform within the meaning of the terminology used around Home Assistant. Home Assistant's [REST API](/developers/rest_api/) is consuming and proceeding messages received over HTTP. + +To use those kind of sensors in your installation no configuration in Home Assistant is needed. All configuration is done on the devices themselves. This means that you must be able to edit the target URL or endpoint and the payload. The entity will be created after the first message has arrived. + +All [requests](/developers/rest_api/#post-apistatesltentity_id) needs to be sent to the endpoint of the device and must be **POST**. diff --git a/source/_components/ifttt.manything.markdown b/source/_components/ifttt.manything.markdown index dd9b53751fa..c5535ef28c0 100644 --- a/source/_components/ifttt.manything.markdown +++ b/source/_components/ifttt.manything.markdown @@ -1,5 +1,5 @@ --- -layout: component +layout: page title: "ManyThing" description: "Instructions how to setup ManyThing support with IFTTT." date: 2015-09-07 18:00 diff --git a/source/_components/ifttt.markdown b/source/_components/ifttt.markdown index 67d3dcb42e2..c5adde1b462 100644 --- a/source/_components/ifttt.markdown +++ b/source/_components/ifttt.markdown @@ -1,5 +1,5 @@ --- -layout: component +layout: page title: "IFTTT" description: "Instructions how to setup IFTTT within Home Assistant." date: 2015-09-07 18:00 diff --git a/source/_components/influxdb.markdown b/source/_components/influxdb.markdown index 5c4a6c708bf..32ed6d6ac39 100644 --- a/source/_components/influxdb.markdown +++ b/source/_components/influxdb.markdown @@ -1,5 +1,5 @@ --- -layout: component +layout: page title: "InfluxDB" description: "Record events in InfluxDB." date: 2015-12-06 13:08 diff --git a/source/_components/input_boolean.markdown b/source/_components/input_boolean.markdown index 4b874a236d6..2fcdedc64b4 100644 --- a/source/_components/input_boolean.markdown +++ b/source/_components/input_boolean.markdown @@ -1,5 +1,5 @@ --- -layout: component +layout: page title: "Input Boolean" description: "Instructions how to integrate the Input Boolean component into Home Assistant." date: 2016-01-17 16:58 diff --git a/source/_components/insteon_hub.markdown b/source/_components/insteon_hub.markdown index 1681372681f..7e6aa5f098b 100644 --- a/source/_components/insteon_hub.markdown +++ b/source/_components/insteon_hub.markdown @@ -1,6 +1,6 @@ --- -layout: component -title: "Insteon" +layout: page +title: "Insteon Hub" description: "Instructions how to setup the Insteon Hub within Home Assistant." date: 2016-01-27 08:00 sidebar: true @@ -11,18 +11,22 @@ logo: insteon.png ha_category: Hub --- -The `insteon` component let you use your [Insteon](http://www.insteon.com/) Hub with Home Assistant. +The `insteon` component lets you use your [Insteon Hub](http://www.insteon.com/insteon-hub/) with Home Assistant. -To integrate your Insteon hub with Home Assistant, add the following section to your `configuration.yaml` file: +You will need to obtain an Insteon REST API key from the [Insteon Developer program](http://www.insteon.com/become-an-insteon-developer) to use this component. + +To integrate your Insteon Hub with Home Assistant, add the following section to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry -insteon: +insteon_hub: username: YOUR_USERNAME password: YOUR_PASSWORD + api_key: YOUR_API_KEY ``` Configuration variables: -- **username** (*Required*): The username that used to access the Insteon interface. -- **password** (*Required*): The password that used to access the Insteon interface. +- **username** (*Required*): The username used to access the Insteon interface (e.g. the [connect.insteon.com](connect.insteon.com) site). +- **password** (*Required*): The password used to access the Insteon interface. +- **api_key** (*Required*): The Insteon REST API key emailed to you once you are approved in the Insteon Developer program. diff --git a/source/_components/introduction.markdown b/source/_components/introduction.markdown index dabfd1b4557..243e3b2c25a 100644 --- a/source/_components/introduction.markdown +++ b/source/_components/introduction.markdown @@ -1,5 +1,5 @@ --- -layout: component +layout: page title: "Introduction" description: "Details about the introduction within Home Assistant." date: 2015-10-25 15:15 diff --git a/source/_components/isy994.markdown b/source/_components/isy994.markdown index 0bb77c922a0..eac00a8cc4c 100644 --- a/source/_components/isy994.markdown +++ b/source/_components/isy994.markdown @@ -1,5 +1,5 @@ --- -layout: component +layout: page title: "ISY994 Controller" description: "Instructions how to setup the ISY994 controller within Home Assistant." date: 2015-01-20 22:36 diff --git a/source/_components/keyboard.markdown b/source/_components/keyboard.markdown index 4bf2672e14b..40f15421e00 100644 --- a/source/_components/keyboard.markdown +++ b/source/_components/keyboard.markdown @@ -1,5 +1,5 @@ --- -layout: component +layout: page title: "Keyboard" description: "Instructions how to simulate key presses with Home Assistant." date: 2015-01-24 14:39 diff --git a/source/_components/light.blinksticklight.markdown b/source/_components/light.blinksticklight.markdown index e1e1c186c7c..0d80ee2086e 100644 --- a/source/_components/light.blinksticklight.markdown +++ b/source/_components/light.blinksticklight.markdown @@ -1,5 +1,5 @@ --- -layout: component +layout: page title: "Blinkstick" description: "Instructions how to setup Blinkstick lights within Home Assistant." date: 2015-10-08 10:00 @@ -12,7 +12,7 @@ ha_category: Light --- -The blinkstick platform let you can control your [Blinkstick](https://www.blinkstick.com/) lights from within Home Assistant. +The `blinkstick` platform let you can control your [Blinkstick](https://www.blinkstick.com/) lights from within Home Assistant. To add blinkstick to your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/light.hue.markdown b/source/_components/light.hue.markdown index 8789a5d3322..501005a7f2a 100644 --- a/source/_components/light.hue.markdown +++ b/source/_components/light.hue.markdown @@ -1,5 +1,5 @@ --- -layout: component +layout: page title: "Philips Hue" description: "Instructions how to setup Philips Hue within Home Assistant." date: 2015-03-23 20:09 diff --git a/source/_components/light.hyperion.markdown b/source/_components/light.hyperion.markdown index db95cad7a4b..48889a36e83 100644 --- a/source/_components/light.hyperion.markdown +++ b/source/_components/light.hyperion.markdown @@ -1,6 +1,6 @@ --- -layout: component -title: Hyperion +layout: page +title: "Hyperion" description: "Instructions how to integrate Hyperion into Home Assistant." date: 2015-10-25 22:43 sidebar: true diff --git a/source/_components/light.lifx.markdown b/source/_components/light.lifx.markdown index f6456c04566..b164bb2f4d5 100644 --- a/source/_components/light.lifx.markdown +++ b/source/_components/light.lifx.markdown @@ -1,5 +1,5 @@ --- -layout: component +layout: page title: "LIFX" description: "Instructions how to integrate LIFX into Home Assistant." date: 2016-01-27 08:00 diff --git a/source/_components/light.limitlessled.markdown b/source/_components/light.limitlessled.markdown index 57b088c9ad2..3a8ad99a4b5 100644 --- a/source/_components/light.limitlessled.markdown +++ b/source/_components/light.limitlessled.markdown @@ -1,11 +1,10 @@ --- -layout: component +layout: page title: "LimitlessLED" description: "Instructions on how to setup LimitlessLED within Home Assistant." date: 2015-12-03 13:00 sidebar: true layout: page -title: "LimitlessLED support" sidebar: false comments: false sharing: true diff --git a/source/_components/light.markdown b/source/_components/light.markdown index 51bf8111115..9cf467f247a 100644 --- a/source/_components/light.markdown +++ b/source/_components/light.markdown @@ -1,5 +1,5 @@ --- -layout: component +layout: page title: "Lights" description: "Instructions how to setup your lights with Home Assistant." date: 2015-01-24 14:39 diff --git a/source/_components/light.mqtt.markdown b/source/_components/light.mqtt.markdown index 6e8b57ce211..f0d4680a8a7 100644 --- a/source/_components/light.mqtt.markdown +++ b/source/_components/light.mqtt.markdown @@ -1,6 +1,6 @@ --- -layout: component -title: "MQTT light" +layout: page +title: "MQTT Light" description: "Instructions how to setup MQTT lights within Home Assistant." date: 2015-11-13 08:30 sidebar: true diff --git a/source/_components/light.rfxtrx.markdown b/source/_components/light.rfxtrx.markdown index a793421e6a5..374df8887b8 100644 --- a/source/_components/light.rfxtrx.markdown +++ b/source/_components/light.rfxtrx.markdown @@ -1,6 +1,6 @@ --- -layout: component -title: "RFXtrx light" +layout: page +title: "RFXtrx Light" description: "Instructions how to integrate RFXtrx lights into Home Assistant." date: 2015-10-08 10:15 sidebar: true @@ -9,7 +9,8 @@ sharing: true footer: true ha_category: Light --- -The rfxtrx platform support lights that communicate in the frequency range of 433.92 MHz. + +The `rfxtrx` platform support lights that communicate in the frequency range of 433.92 MHz. To enable RFXtrx lights in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/light.tellstick.markdown b/source/_components/light.tellstick.markdown index 733ca3ce7be..7326dc49345 100644 --- a/source/_components/light.tellstick.markdown +++ b/source/_components/light.tellstick.markdown @@ -1,6 +1,6 @@ --- -layout: component -title: "TellStick light" +layout: page +title: "TellStick Light" description: "Instructions how to integrate TellStick lights into Home Assistant." date: 2015-08-06 19:00 sidebar: true @@ -12,7 +12,7 @@ ha_category: Light --- -This tellstick light platform allows you to control your [TellStick](http://www.telldus.se/products/tellstick) dimmers. +This `tellstick` light platform allows you to control your [TellStick](http://www.telldus.se/products/tellstick) dimmers. To use your TellStick device in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/light.vera.markdown b/source/_components/light.vera.markdown index 5ab3de9e3c9..3ed552548a4 100644 --- a/source/_components/light.vera.markdown +++ b/source/_components/light.vera.markdown @@ -1,6 +1,6 @@ --- -layout: component -title: "Vera light" +layout: page +title: "Vera Light" description: "Instructions how to integrate Vera lights into Home Assistant." date: 2015-10-20 21:00 sidebar: true @@ -12,7 +12,7 @@ ha_category: Light --- -This vera light platform allows you to control your [Vera](http://getvera.com/) lights. +This `vera` light platform allows you to control your [Vera](http://getvera.com/) lights. This platform is useful if you wish for switches connected to your Vera controller to appear as lights in Home Assistant. All switches will be added as a light unless you exclude them in the configuration file. diff --git a/source/_components/light.wink.markdown b/source/_components/light.wink.markdown index d4d86298a7e..3f019b5ca97 100644 --- a/source/_components/light.wink.markdown +++ b/source/_components/light.wink.markdown @@ -1,6 +1,6 @@ --- -layout: component -title: "Wink light" +layout: page +title: "Wink Light" description: "Instructions how to setup the Wink lights within Home Assistant." date: 2015-01-20 22:36 sidebar: true @@ -12,6 +12,6 @@ ha_category: Light --- -The wink sensor platform allows you to use your [Wink](http://www.wink.com/) lights. +The wink light platform allows you to use your [Wink](http://www.wink.com/) lights. The requirement is that you have setup your [Wink hub](/components/light.wink/). diff --git a/source/_components/light.zigbee.markdown b/source/_components/light.zigbee.markdown index 0c71f8e4bfc..25832fedbd1 100644 --- a/source/_components/light.zigbee.markdown +++ b/source/_components/light.zigbee.markdown @@ -1,5 +1,5 @@ --- -layout: component +layout: page title: ZigBee Light description: "Instructions on how to set up ZigBee lights within Home Assistant." date: 2016-01-28 12:38 diff --git a/source/_components/light.zwave.markdown b/source/_components/light.zwave.markdown index 4b547ee58d4..00b3c7b64d3 100644 --- a/source/_components/light.zwave.markdown +++ b/source/_components/light.zwave.markdown @@ -1,6 +1,6 @@ --- -layout: component -title: "Z-Wave light" +layout: page +title: "Z-Wave Light" description: "Instructions how to setup the Z-Wave lights within Home Assistant." date: 2015-11-11 13:00 sidebar: true diff --git a/source/_components/lock.markdown b/source/_components/lock.markdown index a905a990b9a..dcad2d30566 100644 --- a/source/_components/lock.markdown +++ b/source/_components/lock.markdown @@ -1,5 +1,5 @@ --- -layout: component +layout: page title: "Locks" description: "Instructions how to setup your locks with Home Assistant." date: 2015-11-21 08:10 diff --git a/source/_components/lock.wink.markdown b/source/_components/lock.wink.markdown index 656c149151c..d9abf003f8a 100644 --- a/source/_components/lock.wink.markdown +++ b/source/_components/lock.wink.markdown @@ -1,6 +1,6 @@ --- -layout: component -title: "Wink lock" +layout: page +title: "Wink Lock" description: "Instructions how to setup the Wink locks within Home Assistant." date: 2015-11-20 12:00 sidebar: true @@ -12,7 +12,7 @@ ha_category: Lock --- -The wink lock platform allows you to control your [Wink](http://www.wink.com/) locks. +The Wink lock platform allows you to control your [Wink](http://www.wink.com/) locks. The requirement is that you have setup your [Wink hub](/components/wink/). diff --git a/source/_components/logbook.markdown b/source/_components/logbook.markdown index 7e3581788c3..f7b3c42be79 100644 --- a/source/_components/logbook.markdown +++ b/source/_components/logbook.markdown @@ -1,5 +1,5 @@ --- -layout: component +layout: page title: "Logbook" description: "Instructions how to enable the logbook component for Home Assistant." date: 2015-04-25 9:23 diff --git a/source/_components/logger.markdown b/source/_components/logger.markdown index e7a9935c9bd..66c521e09ea 100644 --- a/source/_components/logger.markdown +++ b/source/_components/logger.markdown @@ -1,5 +1,5 @@ --- -layout: component +layout: page title: "Logger" description: "Instructions how to enable the logger component for Home Assistant." date: 2015-11-12 17:00 diff --git a/source/_components/media_player.cast.markdown b/source/_components/media_player.cast.markdown index ad8048f4878..0ce3920e4ec 100644 --- a/source/_components/media_player.cast.markdown +++ b/source/_components/media_player.cast.markdown @@ -1,5 +1,5 @@ --- -layout: component +layout: page title: "Google Cast" description: "Instructions how to integrate Google Cast into Home Assistant." date: 2015-03-23 19:59 diff --git a/source/_components/media_player.denon.markdown b/source/_components/media_player.denon.markdown index 1b7890b98c0..6d53b6c7617 100644 --- a/source/_components/media_player.denon.markdown +++ b/source/_components/media_player.denon.markdown @@ -1,5 +1,5 @@ --- -layout: component +layout: page title: "Denon Network Receivers" description: "Instructions how to integrate Denon Network Receivers into Home Assistant." date: 2015-09-08 09:00 @@ -12,7 +12,7 @@ ha_category: Media Player --- -The denon platform allows you to control a [Denon Network Receivers](http://www.denon.co.uk/chg/product/compactsystems/networkmusicsystems/ceolpiccolo) from Home Assistant. +The `denon` platform allows you to control a [Denon Network Receivers](http://www.denon.co.uk/chg/product/compactsystems/networkmusicsystems/ceolpiccolo) from Home Assistant. Supported devices: diff --git a/source/_components/media_player.firetv.markdown b/source/_components/media_player.firetv.markdown index 8f52a5582da..7561b7bbe8d 100644 --- a/source/_components/media_player.firetv.markdown +++ b/source/_components/media_player.firetv.markdown @@ -1,5 +1,5 @@ --- -layout: component +layout: page title: "FireTV" description: "Instructions how to integrate Music Player Daemon into Home Assistant." date: 2015-10-23 18:00 @@ -12,7 +12,7 @@ ha_category: Media Player --- -The firetv platform allows you to control a [Amazon Fire TV/stick](http://www.amazon.com/Amazon-DV83YW-Fire-TV/dp/B00U3FPN4U). +The `firetv` platform allows you to control a [Amazon Fire TV/stick](http://www.amazon.com/Amazon-DV83YW-Fire-TV/dp/B00U3FPN4U). The python-firetv Python 2.x module with its helper script that exposes a HTTP server to fetch state and perform actions is used. diff --git a/source/_components/media_player.itunes.markdown b/source/_components/media_player.itunes.markdown index 5e5c890353a..3e77b6f862f 100644 --- a/source/_components/media_player.itunes.markdown +++ b/source/_components/media_player.itunes.markdown @@ -1,5 +1,5 @@ --- -layout: component +layout: page title: "iTunes" description: "Instructions how to integrate iTunes into Home Assistant." date: 2015-06-22 11:00 diff --git a/source/_components/media_player.kodi.markdown b/source/_components/media_player.kodi.markdown index effa67c954f..b2e95c22e75 100644 --- a/source/_components/media_player.kodi.markdown +++ b/source/_components/media_player.kodi.markdown @@ -1,5 +1,5 @@ --- -layout: component +layout: page title: "Kodi" description: "Instructions how to integrate Kodi into Home Assistant." date: 2015-06-22 11:00 @@ -13,7 +13,7 @@ featured: true --- -The kodi platform allows you to control a [Kodi](http://kodi.tv/) multimedia system from Home Assistant. +The `kodi` platform allows you to control a [Kodi](http://kodi.tv/) multimedia system from Home Assistant. To add Kodi to your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/media_player.markdown b/source/_components/media_player.markdown index 5a227781835..24d81c3b2e9 100644 --- a/source/_components/media_player.markdown +++ b/source/_components/media_player.markdown @@ -1,5 +1,5 @@ --- -layout: component +layout: page title: "Media Player" description: "Instructions how to setup your media players with Home Assistant." date: 2015-01-24 14:39 diff --git a/source/_components/media_player.mpd.markdown b/source/_components/media_player.mpd.markdown index 49d5b265325..b600a2e4159 100644 --- a/source/_components/media_player.mpd.markdown +++ b/source/_components/media_player.mpd.markdown @@ -1,5 +1,5 @@ --- -layout: component +layout: page title: "Music Player Daemon (MPD)" description: "Instructions how to integrate Music Player Daemon into Home Assistant." date: 2015-06-02 08:00 @@ -12,7 +12,7 @@ ha_category: Media Player --- -The mpd platform allows you to control a [Music Player Daemon](http://www.musicpd.org/) from Home Assistant. Unfortunatly you will not be able to manipulate the playlist (add or delete songs) or add transitions between the songs. +The `mpd` platform allows you to control a [Music Player Daemon](http://www.musicpd.org/) from Home Assistant. Unfortunatly you will not be able to manipulate the playlist (add or delete songs) or add transitions between the songs. To add MPD to your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/media_player.plex.markdown b/source/_components/media_player.plex.markdown index 4488e68fb87..72b4787d810 100644 --- a/source/_components/media_player.plex.markdown +++ b/source/_components/media_player.plex.markdown @@ -1,5 +1,5 @@ --- -layout: component +layout: page title: "Plex" description: "Instructions how to integrate Plex into Home Assistant." date: 2015-10-05 21:21 diff --git a/source/_components/media_player.sonos.markdown b/source/_components/media_player.sonos.markdown index 22354e8d55a..8b7dcc4e698 100644 --- a/source/_components/media_player.sonos.markdown +++ b/source/_components/media_player.sonos.markdown @@ -1,5 +1,5 @@ --- -layout: component +layout: page title: "Sonos" description: "Instructions how to integrateSonos devices into Home Assistant." date: 2015-09-12 13:00 @@ -13,7 +13,7 @@ featured: true --- -The sonos platform allows you to control your [Sonos](http://www.sonos.com) HiFi wireless speakers and audio components from Home Assistant. +The `sonos` platform allows you to control your [Sonos](http://www.sonos.com) HiFi wireless speakers and audio components from Home Assistant. To add your Sonos components to your installation, add the following to your `configuration.yaml` file. It will perform auto-discovery of your connected speakers. diff --git a/source/_components/media_player.squeezebox.markdown b/source/_components/media_player.squeezebox.markdown index 5d1a11ce52a..ba31bd25503 100644 --- a/source/_components/media_player.squeezebox.markdown +++ b/source/_components/media_player.squeezebox.markdown @@ -1,5 +1,5 @@ --- -layout: component +layout: page title: "Logitech Squeezebox" description: "Instructions on how to integrate a Logitech Squeezebox player into Home Assistant." date: 2015-08-09 11:00 diff --git a/source/_components/media_player.universal.markdown b/source/_components/media_player.universal.markdown index f634f7bdb88..fd0267ffb52 100644 --- a/source/_components/media_player.universal.markdown +++ b/source/_components/media_player.universal.markdown @@ -1,5 +1,5 @@ --- -layout: component +layout: page title: "Universal" description: "Instructions how to create a universal media player in Home Assistant." date: 2016-01-12 22:00 diff --git a/source/_components/modbus.markdown b/source/_components/modbus.markdown index f33ca58ca30..d8e4a36daaa 100644 --- a/source/_components/modbus.markdown +++ b/source/_components/modbus.markdown @@ -1,5 +1,5 @@ --- -layout: component +layout: page title: "Modbus" description: "Instructions how to integrate Modbus within Home Assistant." date: 2015-04-25 9:16 diff --git a/source/_components/mqtt.markdown b/source/_components/mqtt.markdown index 2c0684ac9f1..cac78c44052 100644 --- a/source/_components/mqtt.markdown +++ b/source/_components/mqtt.markdown @@ -1,5 +1,5 @@ --- -layout: component +layout: page title: "MQTT" description: "Instructions how to setup MQTT within Home Assistant." date: 2015-08-07 18:00 diff --git a/source/_components/mqtt_eventstream.markdown b/source/_components/mqtt_eventstream.markdown index d4e209c46e7..cdbf0ded35d 100644 --- a/source/_components/mqtt_eventstream.markdown +++ b/source/_components/mqtt_eventstream.markdown @@ -1,5 +1,5 @@ --- -layout: component +layout: page title: "MQTT Eventstream" description: "Instructions how to setup MQTT eventstream within Home Assistant." date: 2016-01-13 08:00 diff --git a/source/_components/mysensors.markdown b/source/_components/mysensors.markdown index 26214db8b51..e5a6c9a84e3 100644 --- a/source/_components/mysensors.markdown +++ b/source/_components/mysensors.markdown @@ -1,5 +1,5 @@ --- -layout: component +layout: page title: "MySensors" description: "Instructions how to integrate MySensors sensors into Home Assistant." date: 2015-05-14 21:57 diff --git a/source/_components/nest.markdown b/source/_components/nest.markdown index b04bfb93c26..f8a4723fe8a 100644 --- a/source/_components/nest.markdown +++ b/source/_components/nest.markdown @@ -1,5 +1,5 @@ --- -layout: component +layout: page title: "Nest" description: "Instructions how to integrate Nest into Home Assistant." date: 2016-01-29 21:57 diff --git a/source/_components/notify.file.markdown b/source/_components/notify.file.markdown index da02630853f..afb14df7b83 100644 --- a/source/_components/notify.file.markdown +++ b/source/_components/notify.file.markdown @@ -1,5 +1,5 @@ --- -layout: component +layout: page title: "File" description: "Instructions how to add file notifications to Home Assistant." date: 2015-06-22 10:00 @@ -11,7 +11,7 @@ ha_category: Notifications --- -The file platform allows you to store notifications from Home Assistant as a file. +The `file` platform allows you to store notifications from Home Assistant as a file. To enable file notifications in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/notify.free_mobile.markdown b/source/_components/notify.free_mobile.markdown index a3d6c53f574..43ae84c090a 100644 --- a/source/_components/notify.free_mobile.markdown +++ b/source/_components/notify.free_mobile.markdown @@ -1,5 +1,5 @@ --- -layout: component +layout: page title: "Free Mobile" description: "Instructions how to add user notifications to Home Assistant." date: 2016-01-12 08:36 diff --git a/source/_components/notify.google_voice.markdown b/source/_components/notify.google_voice.markdown index 677f8749d98..61044ffc40a 100644 --- a/source/_components/notify.google_voice.markdown +++ b/source/_components/notify.google_voice.markdown @@ -1,5 +1,5 @@ --- -layout: component +layout: page title: "Google Voice SMS" description: "Instructions how to add user notifications to Home Assistant." date: 2016-01-29 diff --git a/source/_components/notify.instapush.markdown b/source/_components/notify.instapush.markdown index 9160a0ea649..5fc49341bfd 100644 --- a/source/_components/notify.instapush.markdown +++ b/source/_components/notify.instapush.markdown @@ -1,5 +1,5 @@ --- -layout: component +layout: page title: "Instapush" description: "Instructions how to add Instapush notifications to Home Assistant." date: 2015-05-01 18:00 @@ -12,7 +12,7 @@ ha_category: Notifications --- -The instapush platform uses [Instapush](https://instapush.im) to delivery notifications from Home Assistant to your Android or iOS device. +The `instapush` platform uses [Instapush](https://instapush.im) to delivery notifications from Home Assistant to your Android or iOS device. The Instapush [Getting Started page](https://instapush.im/home/start/) will guide through the process of creating the required items. diff --git a/source/_components/notify.markdown b/source/_components/notify.markdown index ed8f64c4d7d..f6d4f7b5350 100644 --- a/source/_components/notify.markdown +++ b/source/_components/notify.markdown @@ -1,5 +1,5 @@ --- -layout: component +layout: page title: "Notifications" description: "Instructions how to add user notifications to Home Assistant." date: 2015-01-20 22:36 diff --git a/source/_components/notify.mqtt.markdown b/source/_components/notify.mqtt.markdown new file mode 100644 index 00000000000..1f42e72e43d --- /dev/null +++ b/source/_components/notify.mqtt.markdown @@ -0,0 +1,33 @@ +--- +layout: page +title: "MQTT Notifications" +description: "Instructions how to add MQTT notifications to Home Assistant." +date: 2016-02-01 08:00 +sidebar: true +comments: false +sharing: true +footer: true +logo: mqtt.png +ha_category: Notifications +--- + +The MQTT notification support is different than the other [notification](/components/notify/) platforms. It is a service. This means that you don't have to create a configuration entry but you need to provide more details while calling the service. + +**Call Service** section from the **Developer Tools** allows you to send MQTT messages. Choose *mqtt/publish* from the list of **Available services:** and enter something like the sample below into the **Service Data** field and hit **CALL SERVICE**. + +```json +{"payload": "Test message from HA", "topic": "home/notification", "qos": 0, "retain": 0} +``` + +
+
+
+You should choose a unique device name (DEVICE_NAME) to avoid clashes with other devices. +
+ + The JSON payload must contain the new state and should include the unit of measurement and a friendly name. The friendly name is used in the frontend to name the sensor. + +```json +{"state": "20", "attributes": {"unit_of_measurement": "°C", "friendly_name": "Bathroom Temperature"}} +``` + +For a quick test `curl` can be useful to "simulate" a device. + +```bash +$ curl -XPOST -H "x-ha-access: YOUR_PASSWORD" \ + -d '{"state": "20", "attributes": {"unit_of_measurement": "°C", "friendly_name": "Bathroom Temp"}}' \ + http://localhost:8123/api/states/sensor.bathroom_temperature +``` + +Use again `curl` to retrieve the [current state](/developers/rest_api/#get-apistatesltentity_id) to check if the sensor is working. + +```bash +$ curl -X GET -H "x-ha-access: YOUR_PASSWORD" \ + http://localhost:8123/api/states/sensor.bathroom_temperature +{ + "attributes": { + "friendly_name": "Bathroom Temp", + "unit_of_measurement": "\u00b0C" + }, + "entity_id": "sensor.bathroom_temperature", + "last_changed": "09:46:17 06-02-2016", + "last_updated": "09:48:46 06-02-2016", + "state": "20" +} +``` + +For more examples please visit the [HTTP Binary Sensor](/components/binary_sensor.http/#examples) page. diff --git a/source/_components/sensor.markdown b/source/_components/sensor.markdown index 215246234ef..fc8a35d9269 100644 --- a/source/_components/sensor.markdown +++ b/source/_components/sensor.markdown @@ -1,5 +1,5 @@ --- -layout: component +layout: page title: "Sensor" description: "Instructions how to setup your sensors with Home Assistant." date: 2015-01-24 14:39 diff --git a/source/_components/sensor.modbus.markdown b/source/_components/sensor.modbus.markdown index 404868f4fe6..99f85d03cc3 100644 --- a/source/_components/sensor.modbus.markdown +++ b/source/_components/sensor.modbus.markdown @@ -1,6 +1,6 @@ --- -layout: component -title: "Modbus sensor" +layout: page +title: "Modbus Sensor" description: "Instructions how to integrate Modbus sensors into Home Assistant." date: 2015-08-30 23:38 sidebar: true @@ -12,7 +12,7 @@ ha_category: Sensor --- -The modbus sensor platform allows you to gather data from your [Modbus](http://www.modbus.org/) sensors. +The `modbus` sensor platform allows you to gather data from your [Modbus](http://www.modbus.org/) sensors. To use your Modbus sensors in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/sensor.mqtt.markdown b/source/_components/sensor.mqtt.markdown index 71b6355428d..770ff862e15 100644 --- a/source/_components/sensor.mqtt.markdown +++ b/source/_components/sensor.mqtt.markdown @@ -1,6 +1,6 @@ --- -layout: component -title: "MQTT sensor" +layout: page +title: "MQTT Sensor" description: "Instructions how to integrate MQTT sensors within Home Assistant." date: 2015-05-30 23:21 sidebar: true diff --git a/source/_components/sensor.mysensors.markdown b/source/_components/sensor.mysensors.markdown index bc58715d98b..4fce2117198 100644 --- a/source/_components/sensor.mysensors.markdown +++ b/source/_components/sensor.mysensors.markdown @@ -1,6 +1,6 @@ --- -layout: component -title: "MySensors sensors" +layout: page +title: "MySensors Sensor" description: "Instructions how to integrate MySensors sensors into Home Assistant." date: 2016-01-17 15:49 sidebar: true diff --git a/source/_components/sensor.nest.markdown b/source/_components/sensor.nest.markdown index f723d806ff7..b85a2344e08 100644 --- a/source/_components/sensor.nest.markdown +++ b/source/_components/sensor.nest.markdown @@ -1,6 +1,6 @@ --- -layout: component -title: "Nest sensor" +layout: page +title: "Nest Sensor" description: "Instructions how to integrate Nest sensors within Home Assistant." date: 2016-01-13 19:59 sidebar: true @@ -12,7 +12,7 @@ ha_category: Sensor --- -The Nest sensor platform let you monitor sensors connected to your [Nest](https://nest.com) thermostat. +The `nest` sensor platform let you monitor sensors connected to your [Nest](https://nest.com) thermostat. To set it up, add the following information to your `configuration.yaml` file: @@ -20,20 +20,30 @@ To set it up, add the following information to your `configuration.yaml` file: sensor: platform: nest monitored_conditions: - - 'temperature', - - 'target', - - 'away_temperature[0]', + - 'temperature' + - 'target' + - 'away_temperature[0]' - 'away_temperature[1]' - - 'humidity', - - 'mode', - - 'last_ip', - - 'local_ip', - - 'last_connection', + - 'humidity' + - 'mode' + - 'last_ip' + - 'local_ip' + - 'last_connection' - 'battery_level' ``` Configuration variables: - **monitored_conditions** array (*Required*): States to monitor. + - 'temperature' + - 'target' + - 'away_temperature[0]' + - 'away_temperature[1]' + - 'humidity' + - 'mode' + - 'last_ip' + - 'local_ip' + - 'last_connection' + - 'battery_level' -You must have the [Nest component](https://home-assistant.io/components/nest/) configured to use this sensor.
+You must have the [Nest component](/components/nest/) configured to use this sensor.
diff --git a/source/_components/sensor.netatmo.markdown b/source/_components/sensor.netatmo.markdown index 2e7b4d01d2b..ad196eda243 100644 --- a/source/_components/sensor.netatmo.markdown +++ b/source/_components/sensor.netatmo.markdown @@ -1,6 +1,6 @@ --- -layout: component -title: "Netatmo" +layout: page +title: "Netatmo Sensor" description: "Instructions how to integrate Netatmo sensors into Home Assistant." date: 2016-01-14 08:10 sidebar: true @@ -76,4 +76,4 @@ You have to provide these name in your Home Assistant configuration file.The Home Assistant NetAtmo platform has only be tested with the classic indoor and outdoor module. There is no support for the rainmeter and windmeter module at this time because developers does not own these modules. -
\ No newline at end of file + diff --git a/source/_components/sensor.onewire.markdown b/source/_components/sensor.onewire.markdown index 44cb32bea84..15fb06ec854 100644 --- a/source/_components/sensor.onewire.markdown +++ b/source/_components/sensor.onewire.markdown @@ -1,6 +1,6 @@ --- -layout: component -title: "One wire sensor" +layout: page +title: "One wire Sensor" description: "Instructions how to integrate One wire (1-wire) sensors into Home Assistant." date: 2016-01-17 07:15 sidebar: true diff --git a/source/_components/sensor.openweathermap.markdown b/source/_components/sensor.openweathermap.markdown index 11b0dd5b541..66e5e4f3d89 100644 --- a/source/_components/sensor.openweathermap.markdown +++ b/source/_components/sensor.openweathermap.markdown @@ -1,5 +1,5 @@ --- -layout: component +layout: page title: "OpenWeatherMap" description: "Instructions how to integrate OpenWeatherMap within Home Assistant." date: 2015-04-25 9:06 @@ -12,7 +12,7 @@ ha_category: Weather --- -The openweathermap platform uses [OpenWeatherMap](http://openweathermap.org/) as an source for current meteorological data for your location. The `forecast` will show you the condition in 3 h. +The `openweathermap` platform uses [OpenWeatherMap](http://openweathermap.org/) as an source for current meteorological data for your location. The `forecast` will show you the condition in 3 h. You need an API key which is free but requires a [registration](http://home.openweathermap.org/users/sign_up). diff --git a/source/_components/sensor.rest.markdown b/source/_components/sensor.rest.markdown index 59bfb47f70a..c75a216dac7 100644 --- a/source/_components/sensor.rest.markdown +++ b/source/_components/sensor.rest.markdown @@ -1,6 +1,6 @@ --- -layout: component -title: "RESTful sensor" +layout: page +title: "RESTful Sensor" description: "Instructions how to integrate REST sensors into Home Assistant." date: 2015-09-14 19:10 sidebar: true @@ -71,7 +71,6 @@ Always want to know your external IP address. [JSON Test](http://www.jsontest.co To display the IP address, the entry for a sensor in the `configuration.yaml` file will look like this. ```yaml -# Example configuration.yaml entry - platform: rest resource: http://ip.jsontest.com name: External IP @@ -85,7 +84,6 @@ The [glances](/components/sensor.glances/) sensor is doing the exact same thing Add something similar to the entry below to your `configuration.yaml` file: ```yaml -# Example configuration.yaml entry - platform: rest resource: http://IP_ADRRESS:61208/api/2/mem/used name: Used mem @@ -93,3 +91,16 @@ Add something similar to the entry below to your `configuration.yaml` file: unit_of_measurement: MB ``` +### {% linkable_title Value for other Home Assistant instance %} + +The Home Assistant [API](/developers/rest_api/) is exposing the data from your attached sensors. If you are running multiple Home Assistant instances which are not [connected](/developers/architecture/#multiple-connected-instances) you can still get information from them. + + +```yaml + - platform: rest + resource: http://IP_ADDRESS:8123/api/states/sensor.weather_temperature + name: Temperature + value_template: {% raw %}'{{ value_json.state }}'{% endraw %} + unit_of_measurement: "°C" +``` + diff --git a/source/_components/sensor.rfxtrx.markdown b/source/_components/sensor.rfxtrx.markdown index 9b8efa6c138..1f9ce224c85 100644 --- a/source/_components/sensor.rfxtrx.markdown +++ b/source/_components/sensor.rfxtrx.markdown @@ -1,6 +1,6 @@ --- -layout: component -title: "RFXtrx sensor" +layout: page +title: "RFXtrx Sensor" description: "Instructions how to integrate RFXtrx sensors into Home Assistant." date: 2015-08-06 17:15 sidebar: true @@ -10,7 +10,7 @@ footer: true ha_category: Sensor --- -The rfxtrx platform support sensors that communicate in the frequency range of 433.92 MHz. +The `rfxtrx` platform support sensors that communicate in the frequency range of 433.92 MHz. To enable RFXtrx sensors in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/sensor.sabnzbd.markdown b/source/_components/sensor.sabnzbd.markdown index fa2718ff746..984143da7fc 100644 --- a/source/_components/sensor.sabnzbd.markdown +++ b/source/_components/sensor.sabnzbd.markdown @@ -1,5 +1,5 @@ --- -layout: component +layout: page title: "SABnzbd" description: "Instructions how to integrate SABnzbd within Home Assistant." date: 2015-03-23 19:59 @@ -12,7 +12,7 @@ ha_category: Sensor --- -The sabnzbd platform will allow you to monitor your downloads with [SABnzbd](http://sabnzbd.org) from within Home Assistant and setup automation based on the information. +The `sabnzbd` platform will allow you to monitor your downloads with [SABnzbd](http://sabnzbd.org) from within Home Assistant and setup automation based on the information. To use sabnzbd with your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/sensor.swiss_public_transport.markdown b/source/_components/sensor.swiss_public_transport.markdown index f2ab2840d96..47239742921 100644 --- a/source/_components/sensor.swiss_public_transport.markdown +++ b/source/_components/sensor.swiss_public_transport.markdown @@ -1,5 +1,5 @@ --- -layout: component +layout: page title: "Swiss Public Transport" description: "Instructions how to integrate timetable data for travelling in Switzerland within Home Assistant." date: 2015-06-02 21:45 @@ -11,7 +11,7 @@ ha_category: Sensor --- -The swiss public transport sensor will give you the next two departure times from a given location to another one in Switzerland. +The `swiss_public_transport` sensor will give you the next two departure times from a given location to another one in Switzerland. The [Stationboard](http://transport.opendata.ch/examples/stationboard.html) website can help to determine the exact name of the start and the end station. With the station names it's necessary to search for the ID of those stations: diff --git a/source/_components/sensor.systemmonitor.markdown b/source/_components/sensor.systemmonitor.markdown index fd44db9b33b..e1fb58cd46a 100644 --- a/source/_components/sensor.systemmonitor.markdown +++ b/source/_components/sensor.systemmonitor.markdown @@ -1,5 +1,5 @@ --- -layout: component +layout: page title: "System Monitor" description: "Instructions how to monitor the Home Assistant host." date: 2015-03-23 19:59 @@ -10,7 +10,7 @@ footer: true ha_category: Sensor --- -The system monitoring sensor platform to allow you to monitor disk usage, memory usage, CPU usage, and running processes. This platform has superseded the process component which is now considered deprecated. +The `systemmonitor` sensor platform to allow you to monitor disk usage, memory usage, CPU usage, and running processes. This platform has superseded the process component which is now considered deprecated. To add this platform to your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/sensor.tellduslive.markdown b/source/_components/sensor.tellduslive.markdown index 9874f868a25..43fffd40249 100644 --- a/source/_components/sensor.tellduslive.markdown +++ b/source/_components/sensor.tellduslive.markdown @@ -1,6 +1,6 @@ --- -layout: component -title: "Telldus Live sensors" +layout: page +title: "Telldus Live sensor" description: "Instructions how to integrate Telldus Live sensors into Home Assistant." date: 2016-01-17 15:49 sidebar: true diff --git a/source/_components/sensor.tellstick.markdown b/source/_components/sensor.tellstick.markdown index cc8b995135c..8c7a244ebe6 100644 --- a/source/_components/sensor.tellstick.markdown +++ b/source/_components/sensor.tellstick.markdown @@ -1,6 +1,6 @@ --- -layout: component -title: "TellStick sensor" +layout: page +title: "TellStick Sensor" description: "Instructions how to integrate TellStick sensors into Home Assistant." date: 2015-08-06 19:00 sidebar: true @@ -12,7 +12,7 @@ ha_category: Sensor --- -This tellstick sensor platform allows you to get current meteorological data from a [TellStick](http://www.telldus.se/products/tellstick) device. +The `tellstick` sensor platform allows you to get current meteorological data from a [TellStick](http://www.telldus.se/products/tellstick) device. To use your TellStick device in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/sensor.temper.markdown b/source/_components/sensor.temper.markdown index 386f8108e99..d204cf7fd4a 100644 --- a/source/_components/sensor.temper.markdown +++ b/source/_components/sensor.temper.markdown @@ -1,6 +1,6 @@ --- -layout: component -title: "TEMPer sensor" +layout: page +title: "TEMPer Sensor" description: "Instructions how to integrate TEMPer sensors into Home Assistant." date: 2015-08-06 19:00 sidebar: true @@ -10,7 +10,7 @@ footer: true ha_category: Sensor --- -This temper sensor platform allows you to get the current temperature from a TEMPer device. +This `temper` sensor platform allows you to get the current temperature from a TEMPer device. To use your TEMPer sensor in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/sensor.template.markdown b/source/_components/sensor.template.markdown index c45e33577a9..da6ec606d69 100644 --- a/source/_components/sensor.template.markdown +++ b/source/_components/sensor.template.markdown @@ -1,6 +1,6 @@ --- -layout: component -title: "Template sensor" +layout: page +title: "Template Sensor" description: "Instructions how to integrate Template sensors into Home Assistant." date: 2016-01-27 07:00 sidebar: true @@ -20,11 +20,11 @@ sensor: platform: template sensors: solar_angle: - value_template: '{{ states.sun.sun.attributes.elevation }}' + value_template: {% raw %}'{{ states.sun.sun.attributes.elevation }}'{% endraw %} friendly_name: 'Sun angle' unit_of_measurement: 'degrees' sunrise: - value_template: '{{ states.sun.sun.attributes.next_rising }}' + value_template: {% raw %}'{{ states.sun.sun.attributes.next_rising }}'{% endraw %} ``` Configuration variables: @@ -41,17 +41,40 @@ In this section you find some real life examples of how to use this sensor. ### {% linkable_title Sun angle %} -This example shows the sun angle in the frontend. +This example shows the sun angle in the frontend. ```yaml sensor: platform: template sensors: solar_angle: - value_template: '{{ "%+.1f"|format(states.sun.sun.attributes.elevation) }}' + value_template: {% raw %}'{{ "%+.1f"|format(states.sun.sun.attributes.elevation) }}'{% endraw %} friendly_name: 'Sun Angle' unit_of_measurement: '°' ``` +### {% linkable_title Multi line example with an if test %} + +This example shows a multiple line template with and is test. It looks at a sensing switch and shows on/off in the frontend. + +```yaml +sensor: + platform: template + sensors: + kettle: + friendly_name: 'Kettle' + {% raw %}value_template: >- + {%- if is_state("switch.kettle", "off") %} + off + {% elif states.switch.kettle.attributes.kwh < 1000 %} + standby + {% elif is_state("switch.kettle", "on") %} + on + {% else %} + failed + {%- endif %}{% endraw %} + +``` +(please note the blank line to close the multi-line template) diff --git a/source/_components/sensor.time_date.markdown b/source/_components/sensor.time_date.markdown index 612bce17a13..2a945fb8b59 100644 --- a/source/_components/sensor.time_date.markdown +++ b/source/_components/sensor.time_date.markdown @@ -1,5 +1,5 @@ --- -layout: component +layout: page title: "Time & Date" description: "Instructions how to integrate the time and the date within Home Assistant." date: 2015-05-08 17:15 @@ -11,7 +11,7 @@ ha_category: Sensor --- -The time and date platform simple displays the time in various formats, the date, or both. +The time and date (`time_date`) platform simple displays the time in various formats, the date, or both. To enable this sensor in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/sensor.torque.markdown b/source/_components/sensor.torque.markdown index f7287899d91..f8911e5fada 100644 --- a/source/_components/sensor.torque.markdown +++ b/source/_components/sensor.torque.markdown @@ -1,5 +1,5 @@ --- -layout: component +layout: page title: "Torque (OBD2)" description: "Instructions how to integrate Torque sensors into Home Assistant." date: 2015-12-20 18:00 diff --git a/source/_components/sensor.transmission.markdown b/source/_components/sensor.transmission.markdown index 7714f867188..e484da70f1e 100644 --- a/source/_components/sensor.transmission.markdown +++ b/source/_components/sensor.transmission.markdown @@ -1,7 +1,7 @@ --- -layout: component -title: "Transmission sensor" -description: "Instructions how to integrate Transmission within Home Assistant." +layout: page +title: "Transmission Sensor" +description: "Instructions how to integrate Transmission sensors within Home Assistant." date: 2015-04-25 9:06 sidebar: true comments: false @@ -12,7 +12,7 @@ ha_category: Sensor --- -The [Transmission](http://www.transmissionbt.com/) platform allows you to monitor your downloads from within Home Assistant and setup automation based on the information. +The `trnasmission` platform allows you to monitor your downloads with [Transmission](http://www.transmissionbt.com/) from within Home Assistant and setup automation based on the information. ```yaml # Example configuration.yaml entry diff --git a/source/_components/sensor.twitch.markdown b/source/_components/sensor.twitch.markdown index 56c5dff9331..b1b81299ca6 100644 --- a/source/_components/sensor.twitch.markdown +++ b/source/_components/sensor.twitch.markdown @@ -1,5 +1,5 @@ --- -layout: component +layout: page title: "Twitch" description: "Instructions how to integrate Twitch sensors into Home Assistant." date: 2015-12-19 09:00 diff --git a/source/_components/sensor.vera.markdown b/source/_components/sensor.vera.markdown index 6386b2efaa7..eb634bf280a 100644 --- a/source/_components/sensor.vera.markdown +++ b/source/_components/sensor.vera.markdown @@ -1,6 +1,6 @@ --- -layout: component -title: "Vera sensor" +layout: page +title: "Vera Sensor" description: "Instructions how to integrate Vera sensors into Home Assistant." date: 2015-10-20 21:00 sidebar: true @@ -12,7 +12,7 @@ ha_category: Sensor --- -This vera sensor platform allows you to get data from your [Vera](http://getvera.com/) sensors. +This `vera` sensor platform allows you to get data from your [Vera](http://getvera.com/) sensors. To use your Vera sensor in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/sensor.wink.markdown b/source/_components/sensor.wink.markdown index 5238e0d8cdc..f8aa03fa560 100644 --- a/source/_components/sensor.wink.markdown +++ b/source/_components/sensor.wink.markdown @@ -1,6 +1,6 @@ --- -layout: component -title: "Wink sensor" +layout: page +title: "Wink Sensor" description: "Instructions how to setup the Wink sensors within Home Assistant." date: 2015-01-20 22:36 sidebar: true @@ -12,7 +12,7 @@ ha_category: Sensor --- -The wink sensor platform allows you to get data from your [Wink](http://www.wink.com/) sensors. +The Wink sensor platform allows you to get data from your [Wink](http://www.wink.com/) sensors. The requirement is that you have setup your [Wink hub](/components/light.wink/). diff --git a/source/_components/sensor.worldclock.markdown b/source/_components/sensor.worldclock.markdown index ef6c0f7a4ee..a438ea034bd 100644 --- a/source/_components/sensor.worldclock.markdown +++ b/source/_components/sensor.worldclock.markdown @@ -1,5 +1,5 @@ --- -layout: component +layout: page title: "Worldclock" description: "Instructions how to integrate a Worldclock within Home Assistant." date: 2015-10-02 11:15 @@ -11,7 +11,7 @@ ha_category: Sensor --- -The worldclock platform simple displays the current time in a different time zone +The `worldclock` sensor platform simple displays the current time in a different time zone To enable this sensor in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/sensor.yr.markdown b/source/_components/sensor.yr.markdown index b64d2005941..3c0072da258 100644 --- a/source/_components/sensor.yr.markdown +++ b/source/_components/sensor.yr.markdown @@ -1,5 +1,5 @@ --- -layout: component +layout: page title: "YR" description: "Instructions how to integrate Yr.no within Home Assistant." date: 2016-01-04 14:00 diff --git a/source/_components/sensor.zigbee.markdown b/source/_components/sensor.zigbee.markdown index db03ea55bcf..45a58641aca 100644 --- a/source/_components/sensor.zigbee.markdown +++ b/source/_components/sensor.zigbee.markdown @@ -1,5 +1,5 @@ --- -layout: component +layout: page title: ZigBee Sensor description: "Instructions on how to set up ZigBee sensors within Home Assistant." date: 2016-01-28 10:08 diff --git a/source/_components/sensor.zwave.markdown b/source/_components/sensor.zwave.markdown index 0de9c07750c..0b4641935a9 100644 --- a/source/_components/sensor.zwave.markdown +++ b/source/_components/sensor.zwave.markdown @@ -1,6 +1,6 @@ --- -layout: component -title: "Z-Wave sensor" +layout: page +title: "Z-Wave Sensor" description: "Instructions how to setup the Z-Wave sensors within Home Assistant." date: 2015-11-15 13:00 sidebar: true diff --git a/source/_components/shell_command.markdown b/source/_components/shell_command.markdown index 5e99dc73854..00551f9b65c 100644 --- a/source/_components/shell_command.markdown +++ b/source/_components/shell_command.markdown @@ -1,5 +1,5 @@ --- -layout: component +layout: page title: "Shell command" description: "Instructions how to integrate Shell commands into Home Assistant." date: 2015-10-13 19:10 diff --git a/source/_components/simple_alarm.markdown b/source/_components/simple_alarm.markdown index f158203cec4..d0e8f14a98d 100644 --- a/source/_components/simple_alarm.markdown +++ b/source/_components/simple_alarm.markdown @@ -1,5 +1,5 @@ --- -layout: component +layout: page title: "Intruder Alerts" description: "Instructions how to receive intruder alerts from Home Assistant." date: 2015-01-20 22:36 diff --git a/source/_components/statsd.markdown b/source/_components/statsd.markdown index fbaa914b3ef..80a473c4456 100644 --- a/source/_components/statsd.markdown +++ b/source/_components/statsd.markdown @@ -1,5 +1,5 @@ --- -layout: component +layout: page title: "StatsD" description: "Record events in StatsD." date: 2016-01-25 08:00 diff --git a/source/_components/sun.markdown b/source/_components/sun.markdown index 3d5c3268b97..81fac12dc5c 100644 --- a/source/_components/sun.markdown +++ b/source/_components/sun.markdown @@ -1,5 +1,5 @@ --- -layout: component +layout: page title: "Sun" description: "Instructions how to track the sun within Home Assistant." date: 2015-01-24 14:39 diff --git a/source/_components/switch.arduino.markdown b/source/_components/switch.arduino.markdown index 7bdd9363e40..b2a1b7ef5cd 100644 --- a/source/_components/switch.arduino.markdown +++ b/source/_components/switch.arduino.markdown @@ -1,6 +1,6 @@ --- -layout: component -title: "Arduino switch" +layout: page +title: "Arduino Switch" description: "Instructions how to integrate Arduino boards pins as switches within Home Assistant." date: 2015-09-14 18:28 sidebar: true @@ -12,7 +12,7 @@ ha_category: DIY --- -The arduino switch platform allows you to control the digital pins of your [Arduino](https://www.arduino.cc/) board. Support for switching pins is limited to high/on and low/off of the digital pins. PWM (pin 3,5,6,9,10, and 11 on an Arduino Uno) is not supported yet. +The `arduino` switch platform allows you to control the digital pins of your [Arduino](https://www.arduino.cc/) board. Support for switching pins is limited to high/on and low/off of the digital pins. PWM (pin 3,5,6,9,10, and 11 on an Arduino Uno) is not supported yet. To enable the Arduino pins with Home Assistant, add the following section to your `configuration.yaml` file: diff --git a/source/_components/switch.arest.markdown b/source/_components/switch.arest.markdown index 8874ec4fd4e..a68fa5e5cc8 100644 --- a/source/_components/switch.arest.markdown +++ b/source/_components/switch.arest.markdown @@ -1,6 +1,6 @@ --- -layout: component -title: "aREST switch" +layout: page +title: "aREST Switch" description: "Instructions how to integrate aREST switches within Home Assistant." date: 2015-09-11 23:15 sidebar: true @@ -11,7 +11,7 @@ logo: arest.png ha_category: Switch --- -The arest switch platform allows you to toggle pins of your devices (like Arduino boards with a ethernet/wifi connection, ESP8266 based devices, and the Raspberry Pi) running the [aREST](http://arest.io/) RESTful framework. +The `arest` switch platform allows you to toggle pins of your devices (like Arduino boards with a ethernet/wifi connection, ESP8266 based devices, and the Raspberry Pi) running the [aREST](http://arest.io/) RESTful framework. To use your aREST enabled device with pins in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/switch.command_switch.markdown b/source/_components/switch.command_switch.markdown index 333f2ba277c..ea1dc0b7119 100644 --- a/source/_components/switch.command_switch.markdown +++ b/source/_components/switch.command_switch.markdown @@ -1,6 +1,6 @@ --- -layout: component -title: "Command line switch" +layout: page +title: "Command line Switch" description: "Instructions how to have switches call command line commands." date: 2015-06-10 22:41 sidebar: true diff --git a/source/_components/switch.edimax.markdown b/source/_components/switch.edimax.markdown index 479d6fba0cd..b0078775a0c 100644 --- a/source/_components/switch.edimax.markdown +++ b/source/_components/switch.edimax.markdown @@ -1,6 +1,6 @@ --- -layout: component -title: "Edimax switch" +layout: page +title: "Edimax Switch" description: "Instructions how to integrate Edimax switches into Home Assistant." date: 2015-06-10 22:54 sidebar: true @@ -12,7 +12,7 @@ ha_category: Switch --- -This edimax switch platform allows you to control the state of your [Edimax](http://www.edimax.com/edimax/merchandise/merchandise_list/data/edimax/global/home_automation_smart_plug/) switches. +This `edimax` switch platform allows you to control the state of your [Edimax](http://www.edimax.com/edimax/merchandise/merchandise_list/data/edimax/global/home_automation_smart_plug/) switches. To use your Edimax switch in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/switch.hikvision.markdown b/source/_components/switch.hikvision.markdown index 05f3d47d00f..1887dd389fc 100644 --- a/source/_components/switch.hikvision.markdown +++ b/source/_components/switch.hikvision.markdown @@ -1,6 +1,6 @@ --- -layout: component -title: "Hikvision camera" +layout: page +title: "Hikvision Camera Switch" description: "Instructions how to integrate Hikvision camera's into Home Assistant." date: 2015-06-10 22:54 sidebar: true @@ -12,7 +12,7 @@ ha_category: Camera --- -This hikvisioncam switch platform allows you to control your motion detection setting on your [Hikvision](http://www.hikvision.com/) camera. +This `hikvisioncam` switch platform allows you to control your motion detection setting on your [Hikvision](http://www.hikvision.com/) camera.
Currently works using default https port only.
diff --git a/source/_components/switch.markdown b/source/_components/switch.markdown
index c42f4760403..162d9c8c79a 100644
--- a/source/_components/switch.markdown
+++ b/source/_components/switch.markdown
@@ -1,5 +1,5 @@
---
-layout: component
+layout: page
title: "Switches"
description: "Instructions how to setup your switches with Home Assistant."
date: 2015-01-24 14:39
diff --git a/source/_components/switch.modbus.markdown b/source/_components/switch.modbus.markdown
index ff8c2d269c6..667b5a3dc78 100644
--- a/source/_components/switch.modbus.markdown
+++ b/source/_components/switch.modbus.markdown
@@ -1,6 +1,6 @@
---
-layout: component
-title: "Modbus switch"
+layout: page
+title: "Modbus Switch"
description: "Instructions how to integrate Modbus switches into Home Assistant."
date: 2015-08-30 23:38
sidebar: true
@@ -12,7 +12,7 @@ ha_category: Switch
---
-The modbus switch platform allows you to control [Modbus](http://www.modbus.org/) switches.
+The `modbus` switch platform allows you to control [Modbus](http://www.modbus.org/) switches.
To use your Modbus switches in your installation, add the following to your `configuration.yaml` file:
diff --git a/source/_components/switch.mqtt.markdown b/source/_components/switch.mqtt.markdown
index 88f42a36e66..6c609991110 100644
--- a/source/_components/switch.mqtt.markdown
+++ b/source/_components/switch.mqtt.markdown
@@ -1,6 +1,6 @@
---
-layout: component
-title: "MQTT switch"
+layout: page
+title: "MQTT Switch"
description: "Instructions how to integrate MQTT switches into Home Assistant."
date: 2015-08-30 23:38
sidebar: true
diff --git a/source/_components/switch.mysensors.markdown b/source/_components/switch.mysensors.markdown
index 43de6457344..7b3fb6f1a31 100644
--- a/source/_components/switch.mysensors.markdown
+++ b/source/_components/switch.mysensors.markdown
@@ -1,6 +1,6 @@
---
-layout: component
-title: "MySensors switches"
+layout: page
+title: "MySensors Switch"
description: "Instructions how to integrate MySensors switches into Home Assistant."
date: 2016-01-17 15:49
sidebar: true
diff --git a/source/_components/switch.mystrom.markdown b/source/_components/switch.mystrom.markdown
index eb6f281452e..e5bdac5b17d 100644
--- a/source/_components/switch.mystrom.markdown
+++ b/source/_components/switch.mystrom.markdown
@@ -1,6 +1,6 @@
---
-layout: component
-title: "myStrom switch"
+layout: page
+title: "myStrom Switch"
description: "Instructions how to integrate myStrom switches into Home Assistant."
date: 2015-11-25 22:00
sidebar: true
diff --git a/source/_components/switch.orvibo.markdown b/source/_components/switch.orvibo.markdown
index 19c464e2438..b365802102a 100644
--- a/source/_components/switch.orvibo.markdown
+++ b/source/_components/switch.orvibo.markdown
@@ -1,6 +1,6 @@
---
-layout: component
-title: "Orvibo switch"
+layout: page
+title: "Orvibo Switch"
description: "Instructions how to integrate Orvibo switches within Home Assistant."
date: 2015-11-15 18:15
sidebar: true
@@ -11,7 +11,7 @@ logo: orvibo.png
ha_category: Switch
---
-The orvibo switch platform allows you to toggle your Orvibo S20 Wifi Smart Switch.
+The `orvibo` switch platform allows you to toggle your Orvibo S20 Wifi Smart Switch.
To use your Orvibo switch in your installation, add the following to your `configuration.yaml` file:
diff --git a/source/_components/switch.rest.markdown b/source/_components/switch.rest.markdown
index ed7dfdc110c..3d56ca231b3 100644
--- a/source/_components/switch.rest.markdown
+++ b/source/_components/switch.rest.markdown
@@ -1,6 +1,6 @@
---
-layout: component
-title: "RESTful switch"
+layout: page
+title: "RESTful Switch"
description: "Instructions how to integrate REST switches into Home Assistant."
date: 2015-09-14 19:10
sidebar: true
diff --git a/source/_components/switch.rfxtrx.markdown b/source/_components/switch.rfxtrx.markdown
index 24eea9da287..215eb43af36 100644
--- a/source/_components/switch.rfxtrx.markdown
+++ b/source/_components/switch.rfxtrx.markdown
@@ -1,6 +1,6 @@
---
-layout: component
-title: "RFXtrx switch"
+layout: page
+title: "RFXtrx Switch"
description: "Instructions how to integrate RFXtrx switches into Home Assistant."
date: 2015-10-08 10:15
sidebar: true
@@ -9,7 +9,8 @@ sharing: true
footer: true
ha_category: Switch
---
-The rfxtrx platform support switches that communicate in the frequency range of 433.92 MHz.
+
+The `rfxtrx` platform support switches that communicate in the frequency range of 433.92 MHz.
To enable RFXtrx switches in your installation, add the following to your `configuration.yaml` file:
diff --git a/source/_components/switch.rpi_gpio.markdown b/source/_components/switch.rpi_gpio.markdown
index 284352994b1..608ca7aa1ab 100644
--- a/source/_components/switch.rpi_gpio.markdown
+++ b/source/_components/switch.rpi_gpio.markdown
@@ -1,6 +1,6 @@
---
-layout: component
-title: "Raspberry PI GPIO switch"
+layout: page
+title: "Raspberry PI GPIO Switch"
description: "Instructions how to integrate the GPIO of a Raspberry PI into Home Assistant as a switch."
date: 2015-08-07 14:00
sidebar: true
@@ -12,7 +12,7 @@ ha_category: Switch
---
-The rpi_gpio switch platform allows you to control the GPIOs of your [Raspberry Pi](https://www.raspberrypi.org/).
+The `rpi_gpio` switch platform allows you to control the GPIOs of your [Raspberry Pi](https://www.raspberrypi.org/).
To use your Raspberry Pi's GPIO in your installation, add the following to your `configuration.yaml` file:
diff --git a/source/_components/switch.tellduslive.markdown b/source/_components/switch.tellduslive.markdown
index ac38ab5f01f..eb2002814ab 100644
--- a/source/_components/switch.tellduslive.markdown
+++ b/source/_components/switch.tellduslive.markdown
@@ -1,6 +1,6 @@
---
-layout: component
-title: "Telldus Live switches"
+layout: page
+title: "Telldus Live Switch"
description: "Instructions how to integrate Telldus Live switches into Home Assistant."
date: 2016-01-17 15:49
sidebar: true
diff --git a/source/_components/switch.tellstick.markdown b/source/_components/switch.tellstick.markdown
index 21f22f825a3..e9f3baf21e4 100644
--- a/source/_components/switch.tellstick.markdown
+++ b/source/_components/switch.tellstick.markdown
@@ -1,6 +1,6 @@
---
-layout: component
-title: "TellStick switch"
+layout: page
+title: "TellStick Switch"
description: "Instructions how to integrate TellStick switches into Home Assistant."
date: 2015-08-06 19:00
sidebar: true
@@ -12,7 +12,7 @@ ha_category: Switch
---
-This tellstick switch platform allows you to control [TellStick](http://www.telldus.se/products/tellstick) devices.
+This `tellstick` switch platform allows you to control [TellStick](http://www.telldus.se/products/tellstick) devices.
To use your TellStick device in your installation, add the following to your `configuration.yaml` file:
diff --git a/source/_components/switch.transmission.markdown b/source/_components/switch.transmission.markdown
index c6aa8e84cdf..e5a1e435127 100644
--- a/source/_components/switch.transmission.markdown
+++ b/source/_components/switch.transmission.markdown
@@ -1,6 +1,6 @@
---
-layout: component
-title: "Transmission switch"
+layout: page
+title: "Transmission Switch"
description: "Instructions how to integrate Transmission within Home Assistant."
date: 2015-06-02 09:00
sidebar: true
@@ -12,7 +12,7 @@ ha_category: Switch
---
-The transmission platform allows you to control your [Transmission](http://www.transmissionbt.com/) client from within Home Assistant. The platform enables you switch to your 'Alternative Speed Limits' (aka 'Turtle mode') setting.
+The `transmission` switch platform allows you to control your [Transmission](http://www.transmissionbt.com/) client from within Home Assistant. The platform enables you switch to your 'Alternative Speed Limits' (aka 'Turtle mode') setting.
To add Transmission to your installation, add the following to your `configuration.yaml` file:
diff --git a/source/_components/switch.vera.markdown b/source/_components/switch.vera.markdown
index 868d6301587..07bad9bea28 100644
--- a/source/_components/switch.vera.markdown
+++ b/source/_components/switch.vera.markdown
@@ -1,6 +1,6 @@
---
-layout: component
-title: "Vera switch"
+layout: page
+title: "Vera Switch"
description: "Instructions how to integrate Vera switches into Home Assistant."
date: 2015-10-20 21:00
sidebar: true
@@ -12,7 +12,7 @@ ha_category: Switch
---
-This vera switch platform allows you to control your [Vera](http://getvera.com/) switches.
+This `vera` switch platform allows you to control your [Vera](http://getvera.com/) switches.
To use your Vera switches in your installation, add the following to your `configuration.yaml` file:
diff --git a/source/_components/switch.wemo.markdown b/source/_components/switch.wemo.markdown
index 7692befbb08..1e9560f77ee 100644
--- a/source/_components/switch.wemo.markdown
+++ b/source/_components/switch.wemo.markdown
@@ -1,6 +1,6 @@
---
-layout: component
-title: "Belkin WeMo switch"
+layout: page
+title: "Belkin WeMo Switch"
description: "Instructions how to integrate Belkin WeMo switches into Home Assistant."
date: 2015-03-23 19:59
sidebar: true
@@ -12,7 +12,7 @@ ha_category: Switch
---
-The wemo platform allows you to control your [Belkin WeMo](http://www.belkin.com/us/p/P-F7C027/) switches from within Home Assistant.
+The `wemo` platform allows you to control your [Belkin WeMo](http://www.belkin.com/us/p/P-F7C027/) switches from within Home Assistant.
They will be automatically discovered if the discovery component is enabled.
diff --git a/source/_components/switch.wink.markdown b/source/_components/switch.wink.markdown
index 29ca5b82106..6dda470f287 100644
--- a/source/_components/switch.wink.markdown
+++ b/source/_components/switch.wink.markdown
@@ -1,6 +1,6 @@
---
-layout: component
-title: "Wink switch"
+layout: page
+title: "Wink Switch"
description: "Instructions how to setup the Wink switches within Home Assistant."
date: 2015-01-20 22:36
sidebar: true
@@ -12,7 +12,7 @@ ha_category: Switch
---
-The wink switch platform allows you to control your [Wink](http://www.wink.com/) switches.
+The Wink switch platform allows you to control your [Wink](http://www.wink.com/) switches.
The requirement is that you have setup your [Wink hub](/components/light.wink/).
diff --git a/source/_components/switch.zigbee.markdown b/source/_components/switch.zigbee.markdown
index e75435b0184..41097f32e68 100644
--- a/source/_components/switch.zigbee.markdown
+++ b/source/_components/switch.zigbee.markdown
@@ -1,6 +1,6 @@
---
-layout: component
-title: ZigBee Switch
+layout: page
+title: "ZigBee Switch"
description: "Instructions on how to set up ZigBee switches within Home Assistant."
date: 2016-01-28 11:52
sidebar: true
diff --git a/source/_components/switch.zwave.markdown b/source/_components/switch.zwave.markdown
index 7ae6919567e..3b9f072fa12 100644
--- a/source/_components/switch.zwave.markdown
+++ b/source/_components/switch.zwave.markdown
@@ -1,6 +1,6 @@
---
-layout: component
-title: "Z-Wave switch"
+layout: page
+title: "Z-Wave Switch"
description: "Instructions how to setup the Z-Wave switches within Home Assistant."
date: 2015-11-15 13:00
sidebar: true
diff --git a/source/_components/tellduslive.markdown b/source/_components/tellduslive.markdown
index bf571f33590..3898d4d89bb 100644
--- a/source/_components/tellduslive.markdown
+++ b/source/_components/tellduslive.markdown
@@ -1,5 +1,5 @@
---
-layout: component
+layout: page
title: "Telldus Live"
description: "Instructions how to integrate Telldus Live into Home Assistant."
date: 2016-01-17 16:00
@@ -14,7 +14,7 @@ featured: false
The `tellduslive` component let you connect to [Telldus Live](https://live.telldus.com). It's cloud platform that connects to your Tellstick connected gear at home.
-To get started using Telldus Live, you will have to obtain developer keys from (https://api.telldus.com/keys/index)[developer-keys].
+To get started using Telldus Live, you will have to obtain developer keys from the [developer page](https://api.telldus.com/keys/index).
To integrate your Telldus Live with Home Assistant, add the following section to your `configuration.yaml` file:
diff --git a/source/_components/tellstick.markdown b/source/_components/tellstick.markdown
index 913415ece60..13124b11046 100644
--- a/source/_components/tellstick.markdown
+++ b/source/_components/tellstick.markdown
@@ -1,5 +1,5 @@
---
-layout: component
+layout: page
title: "TellStick"
description: "Instructions how to integrate your TellStick into Home Assistant."
date: 2015-03-28 13:06
@@ -12,7 +12,7 @@ ha_category: Hub
---
-The tellstick component integrates [TellStick](http://www.telldus.se/products/tellstick) devices into Home Assistant. This integration allows users to add switches, lights, and sensors which are communicating with 433 Mhz. There are couple of vendors (Capidi Elro, Intertechno, Nexa, Proove, Sartano, and Viking) how are selling products which works with TellStick. For more details, please check the TellStick [compatibility list](http://telldus.se/products/compability).
+The `tellstick` component integrates [TellStick](http://www.telldus.se/products/tellstick) devices into Home Assistant. This integration allows users to add switches, lights, and sensors which are communicating with 433 Mhz. There are couple of vendors (Capidi Elro, Intertechno, Nexa, Proove, Sartano, and Viking) how are selling products which works with TellStick. For more details, please check the TellStick [compatibility list](http://telldus.se/products/compability).
To get started, add the devices to your `configuration.yaml` file.
diff --git a/source/_components/thermostat.ecobee.markdown b/source/_components/thermostat.ecobee.markdown
index eb25c3f2f29..d209c458a0f 100644
--- a/source/_components/thermostat.ecobee.markdown
+++ b/source/_components/thermostat.ecobee.markdown
@@ -1,6 +1,6 @@
---
-layout: component
-title: "Ecobee thermostat"
+layout: page
+title: "Ecobee Thermostat"
description: "Instructions how to setup the Ecobee thermostats within Home Assistant."
date: 2015-11-30 18:00
sidebar: true
diff --git a/source/_components/thermostat.heat_control.markdown b/source/_components/thermostat.heat_control.markdown
index d27bb3993bb..5f754334261 100644
--- a/source/_components/thermostat.heat_control.markdown
+++ b/source/_components/thermostat.heat_control.markdown
@@ -1,5 +1,5 @@
---
-layout: component
+layout: page
title: "Heat control"
description: "Turn Home Assistant into a thermostat"
date: 2015-03-23 19:59
diff --git a/source/_components/thermostat.heatmiser.markdown b/source/_components/thermostat.heatmiser.markdown
index a3bff2cf420..49529fb0eb2 100644
--- a/source/_components/thermostat.heatmiser.markdown
+++ b/source/_components/thermostat.heatmiser.markdown
@@ -1,6 +1,6 @@
---
-layout: component
-title: "Heatmiser thermostat"
+layout: page
+title: "Heatmiser Thermostat"
description: "Instructions how to integrate Heatmiser thermostats within Home Assistant."
date: 2015-12-11 12:35
sidebar: true
@@ -12,7 +12,7 @@ ha_category: Thermostat
---
-The heatmiser thermostat platform let you control [Heatmiser DT/DT-E/PRT/PRT-E](http://www.heatmisershop.co.uk/heatmiser-slimline-programmable-room-thermostat/) thermostats from Heatmiser. The module itself is currently setup to work over a RS232 -> RS485 converter, therefore it connects over IP.
+The `heatmiser` thermostat platform let you control [Heatmiser DT/DT-E/PRT/PRT-E](http://www.heatmisershop.co.uk/heatmiser-slimline-programmable-room-thermostat/) thermostats from Heatmiser. The module itself is currently setup to work over a RS232 -> RS485 converter, therefore it connects over IP.
To set it up, add the following information to your `configuration.yaml` file:
@@ -35,4 +35,4 @@ Configuration variables:
- **port** (*Required*): The port that the interface is listening on.
- **tstats** (*Required*): A list of thermostats activated on the gateway.
- **id** (*Required*): The id of the thermostat as configured on the device itself
-- **name** (*Required*): A friendly name for the themostat
\ No newline at end of file
+- **name** (*Required*): A friendly name for the themostat
diff --git a/source/_components/thermostat.homematic.markdown b/source/_components/thermostat.homematic.markdown
index b281ec41841..dc206f5a7ab 100644
--- a/source/_components/thermostat.homematic.markdown
+++ b/source/_components/thermostat.homematic.markdown
@@ -1,6 +1,6 @@
---
-layout: component
-title: "Homematic thermostat"
+layout: page
+title: "Homematic Thermostat"
description: "Instructions how to integrate Homematic thermostats within Home Assistant."
date: 2015-11-25 08:00
sidebar: true
@@ -12,7 +12,7 @@ ha_category: Thermostat
---
-The homematic thermostat platform let you control [Homematic](http://www.homematic.com/) thermostat from Home Assistant. Currently there is support for Homematic (HM-TC-IT-WM-W-EU, HM-CC-RT-DN) thermostats using Homegear or Homematic central (CCU1/CCU2).
+The `homematic` thermostat platform let you control [Homematic](http://www.homematic.com/) thermostat from Home Assistant. Currently there is support for Homematic (HM-TC-IT-WM-W-EU, HM-CC-RT-DN) thermostats using Homegear or Homematic central (CCU1/CCU2).
To set it up, add the following information to your `configuration.yaml` file:
diff --git a/source/_components/thermostat.honeywell.markdown b/source/_components/thermostat.honeywell.markdown
index baaaf7fd14a..554b224734d 100644
--- a/source/_components/thermostat.honeywell.markdown
+++ b/source/_components/thermostat.honeywell.markdown
@@ -1,6 +1,6 @@
---
-layout: component
-title: "Honeywell thermostat"
+layout: page
+title: "Honeywell Thermostat"
description: "Instructions how to integrate Honeywell thermostats within Home Assistant."
date: 2015-11-09 17:15
sidebar: true
@@ -12,7 +12,7 @@ ha_category: Thermostat
---
-The honeywell thermostat platform let you control [Honeywell Connected](http://getconnected.honeywell.com/en/) thermostats from Home Assistant.
+The `honeywell` thermostat platform let you control [Honeywell Connected](http://getconnected.honeywell.com/en/) thermostats from Home Assistant.
To set it up, add the following information to your `configuration.yaml` file:
diff --git a/source/_components/thermostat.markdown b/source/_components/thermostat.markdown
index d47b2728c4a..d003e41cfa5 100644
--- a/source/_components/thermostat.markdown
+++ b/source/_components/thermostat.markdown
@@ -1,5 +1,5 @@
---
-layout: component
+layout: page
title: "Thermostats"
description: "Instructions how to setup thermostats tracking within Home Assistant."
date: 2015-01-20 22:36
diff --git a/source/_components/thermostat.nest.markdown b/source/_components/thermostat.nest.markdown
index 3164fb8c633..30c1b8c9005 100644
--- a/source/_components/thermostat.nest.markdown
+++ b/source/_components/thermostat.nest.markdown
@@ -1,6 +1,6 @@
---
-layout: component
-title: "Nest thermostat"
+layout: page
+title: "Nest Thermostat"
description: "Instructions how to integrate Nest thermostats within Home Assistant."
date: 2015-03-23 19:59
sidebar: true
@@ -12,7 +12,7 @@ ha_category: Thermostat
---
-The Nest thermostat platform let you control a thermostat from [Nest](https://nest.com).
+The `nest` thermostat platform let you control a thermostat from [Nest](https://nest.com).
To set it up, add the following information to your `configuration.yaml` file:
diff --git a/source/_components/thermostat.proliphix.markdown b/source/_components/thermostat.proliphix.markdown
index 6f8a4ce9b2c..c9c13f91d13 100644
--- a/source/_components/thermostat.proliphix.markdown
+++ b/source/_components/thermostat.proliphix.markdown
@@ -1,6 +1,6 @@
---
-layout: component
-title: "Proliphix thermostat"
+layout: page
+title: "Proliphix Thermostat"
description: "Instructions how to integrate Proliphix thermostats within Home Assistant."
date: 2016-01-15 08:00
sidebar: true
diff --git a/source/_components/thermostat.radiotherm.markdown b/source/_components/thermostat.radiotherm.markdown
index 37e9ae1999d..fc409933030 100644
--- a/source/_components/thermostat.radiotherm.markdown
+++ b/source/_components/thermostat.radiotherm.markdown
@@ -1,6 +1,6 @@
---
-layout: component
-title: "Radiotherm thermostat"
+layout: page
+title: "Radiotherm Thermostat"
description: "Instructions how to integrate Radiotherm thermostats within Home Assistant."
date: 2015-10-18 17:15
sidebar: true
@@ -12,7 +12,7 @@ ha_category: Thermostat
---
-The nest thermostat platform let you control a thermostat from [Radio Thermostat](http://www.radiothermostat.com/).
+The `radiotherm` thermostat platform let you control a thermostat from [Radio Thermostat](http://www.radiothermostat.com/).
The underlaying library supports:
- CT50 V1.09
diff --git a/source/_components/updater.markdown b/source/_components/updater.markdown
index 44d270b7b1e..8f857c78089 100644
--- a/source/_components/updater.markdown
+++ b/source/_components/updater.markdown
@@ -1,5 +1,5 @@
---
-layout: component
+layout: page
title: "Updater"
description: "Detecting when Home Assistant updates are available."
date: 2015-11-15 20:40
diff --git a/source/_components/vera.markdown b/source/_components/vera.markdown
index 4ceee75d400..782ca02cb7d 100644
--- a/source/_components/vera.markdown
+++ b/source/_components/vera.markdown
@@ -1,5 +1,5 @@
---
-layout: component
+layout: page
title: "Vera"
description: "Instructions how to setup Vera hubs within Home Assistant."
date: 2015-03-23 20:04
diff --git a/source/_components/verisure.markdown b/source/_components/verisure.markdown
index 06c635ecb31..8730ec8382f 100644
--- a/source/_components/verisure.markdown
+++ b/source/_components/verisure.markdown
@@ -1,5 +1,5 @@
---
-layout: component
+layout: page
title: "Verisure"
description: "Instructions how to setup Verisure devices within Home Assistant."
date: 2015-08-17 20:28
diff --git a/source/_components/wink.markdown b/source/_components/wink.markdown
index bebe9368ac2..4cd2283687b 100644
--- a/source/_components/wink.markdown
+++ b/source/_components/wink.markdown
@@ -1,5 +1,5 @@
---
-layout: component
+layout: page
title: "Wink"
description: "Instructions how to setup the Wink hub within Home Assistant."
date: 2015-01-20 22:36
diff --git a/source/_components/zigbee.markdown b/source/_components/zigbee.markdown
index 51ae3f4fae0..01770a49e11 100644
--- a/source/_components/zigbee.markdown
+++ b/source/_components/zigbee.markdown
@@ -1,5 +1,5 @@
---
-layout: component
+layout: page
title: "ZigBee"
description: "Instructions on how to integrate a ZigBee network with Home Assistant."
date: 2016-01-27 17:10
diff --git a/source/_components/zone.markdown b/source/_components/zone.markdown
index a0bd59ad1a2..bcb5980a1c1 100644
--- a/source/_components/zone.markdown
+++ b/source/_components/zone.markdown
@@ -1,5 +1,5 @@
---
-layout: component
+layout: page
title: "Zone"
description: "Instructions how to setup zones within Home Assistant."
date: 2015-10-04 09:23
diff --git a/source/_components/zwave.markdown b/source/_components/zwave.markdown
index 4a9c53e8c70..7cb6744faf4 100644
--- a/source/_components/zwave.markdown
+++ b/source/_components/zwave.markdown
@@ -1,5 +1,5 @@
---
-layout: component
+layout: page
title: "Z-Wave"
description: "Instructions how to integrate your existing Z-Wave within Home Assistant."
date: 2015-03-23 19:59
diff --git a/source/_cookbook/automation_for_rainy_days.markdown b/source/_cookbook/automation_for_rainy_days.markdown
index 63d78ce3d4c..52baa7a70b4 100644
--- a/source/_cookbook/automation_for_rainy_days.markdown
+++ b/source/_cookbook/automation_for_rainy_days.markdown
@@ -3,10 +3,11 @@ layout: page
title: "Automation for rainy days"
description: "Basic example how to use weather conditions to set states"
date: 2015-10-08 19:05
-sidebar: false
+sidebar: true
comments: false
sharing: true
footer: true
+ha_category: Automation Examples
---
### {% linkable_title Rainy Day Light %}
diff --git a/source/_cookbook/automation_sun.markdown b/source/_cookbook/automation_sun.markdown
index 54b986a9dec..3e9e058b22d 100644
--- a/source/_cookbook/automation_sun.markdown
+++ b/source/_cookbook/automation_sun.markdown
@@ -3,10 +3,11 @@ layout: page
title: "Automation examples using the sun"
description: "Automation examples that use the sun."
date: 2015-10-08 19:05
-sidebar: false
+sidebar: true
comments: false
sharing: true
footer: true
+ha_category: Automation Examples
---
#### {% linkable_title Turn on the living room lights 45 minutes before sunset if anyone home %}
diff --git a/source/_cookbook/basic_example_use_trigger_values.markdown b/source/_cookbook/basic_example_use_trigger_values.markdown
index cbff5a43b62..149177b85c3 100644
--- a/source/_cookbook/basic_example_use_trigger_values.markdown
+++ b/source/_cookbook/basic_example_use_trigger_values.markdown
@@ -3,10 +3,11 @@ layout: page
title: "Automation: use_trigger_values"
description: "Basic example how to use use_trigger_values in automation"
date: 2015-10-08 19:05
-sidebar: false
+sidebar: true
comments: false
sharing: true
footer: true
+ha_category: Automation Examples
---
### {% linkable_title Basic example for use_trigger_values %}
diff --git a/source/_cookbook/configuration_yaml_by_carlo_costanzo.markdown b/source/_cookbook/configuration_yaml_by_carlo_costanzo.markdown
new file mode 100644
index 00000000000..e20885eb7f3
--- /dev/null
+++ b/source/_cookbook/configuration_yaml_by_carlo_costanzo.markdown
@@ -0,0 +1,13 @@
+---
+layout: page
+title: "Configuration.yaml by Carlo Costanzo"
+description: ""
+date: 2016-02-07 11:45
+sidebar: true
+comments: false
+sharing: true
+footer: true
+ha_category: Full configuration.yaml Examples
+ha_external_link: https://gist.github.com/CCOSTAN/9934de973a293b809868
+---
+
diff --git a/source/_cookbook/configuration_yaml_by_happyleavesaoc.markdown b/source/_cookbook/configuration_yaml_by_happyleavesaoc.markdown
new file mode 100644
index 00000000000..774b2c093c9
--- /dev/null
+++ b/source/_cookbook/configuration_yaml_by_happyleavesaoc.markdown
@@ -0,0 +1,13 @@
+---
+layout: page
+title: "Configuration.yaml by happyleavesaoc"
+description: ""
+date: 2016-02-07 11:45
+sidebar: true
+comments: false
+sharing: true
+footer: true
+ha_category: Full configuration.yaml Examples
+ha_external_link: https://github.com/happyleavesaoc/my-home-automation/tree/master/homeassistant
+---
+
diff --git a/source/_cookbook/dim_lights_when_playing_media.markdown b/source/_cookbook/dim_lights_when_playing_media.markdown
index 488d5752b96..92bea514ca4 100644
--- a/source/_cookbook/dim_lights_when_playing_media.markdown
+++ b/source/_cookbook/dim_lights_when_playing_media.markdown
@@ -3,10 +3,11 @@ layout: page
title: "Dim lights when playing media"
description: "Dim lights up or down when playing media"
date: 2015-10-15 19:05
-sidebar: false
+sidebar: true
comments: false
sharing: true
footer: true
+ha_category: Automation Examples
---
Like it how the lights dim up/down at the movies? Do it at home as well!
diff --git a/source/_cookbook/python_component_basic_service.markdown b/source/_cookbook/python_component_basic_service.markdown
new file mode 100644
index 00000000000..56e95cbcf02
--- /dev/null
+++ b/source/_cookbook/python_component_basic_service.markdown
@@ -0,0 +1,56 @@
+---
+layout: page
+title: "Basic Service Example"
+description: ""
+date: 2016-02-07 12:13
+sidebar: true
+comments: false
+sharing: true
+footer: true
+ha_category: Custom Python Component Examples
+---
+
+This is a simple hello world example to show the basics of registering a service. To use this example, create the file `
+This example requires you to have the [MQTT component](/components/mqtt/) up and running.
+
+
+{{page.ha_category}}
+
+ {% for recipe in cookbook %}
+ {% if recipe.ha_category == page.ha_category %}
+
+