From 842fe6a784845579c0db8fa4bf51f261512db201 Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Mon, 23 Nov 2015 14:50:34 +0100 Subject: [PATCH 1/3] Make titles linkable --- source/_components/notify.markdown | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/source/_components/notify.markdown b/source/_components/notify.markdown index b7a3f04920c..7082d2f4b37 100644 --- a/source/_components/notify.markdown +++ b/source/_components/notify.markdown @@ -11,7 +11,7 @@ footer: true The `notify` component makes it possible to send notifications to a wide variety of platforms. Please check the sidebar for a full list of platforms that are supported. -### Configuration +## {% linkable_title Configuration %} ```yaml # Example configuration.yaml entry @@ -25,7 +25,7 @@ notify: The **name** parameter is optional but needed if you want to use multiple platforms. The platform will be exposed as service `notify/`. The name will default to `notify` if not supplied. -### Service +### {% linkable_title Service %} Once loaded, the `notify` platform will expose a service that can be called to send notifications. @@ -35,8 +35,7 @@ Once loaded, the `notify` platform will expose a service that can be called to s | `title` | yes | Title of the notification. Default is `Home Assistant`. | `target` | yes | Some platforms will allow specifying a recipient that will receive the notification. See your platform page if it is supported. - -### Test if it works +### {% linkable_title Test if it works %} A simple way to test if you have set up your notify platform correctly is to use **Call Service** from the **Developer Tools** to call your notify service. Choose your service (*notify/xyz*) from the list of **Available services:** and enter something like the sample below into the **Service Data** field and hit **CALL SERVICE**. From e005f5b1c46fc7ea827a085030c2ee9a35c79d94 Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Mon, 23 Nov 2015 15:41:10 +0100 Subject: [PATCH 2/3] Rephrase the multiple entries part --- source/getting-started/devices.markdown | 44 ++++++++++++++++++++++--- 1 file changed, 39 insertions(+), 5 deletions(-) diff --git a/source/getting-started/devices.markdown b/source/getting-started/devices.markdown index 99a3346eff8..93e2a0c0a6e 100644 --- a/source/getting-started/devices.markdown +++ b/source/getting-started/devices.markdown @@ -11,13 +11,47 @@ footer: true Home Assistant will be able to automatically discover and configure any Google Chromecasts, Netgear routers, Belkin WeMo switches, Philips Hue bridges and Sonos speakers in your network if you have [the discovery component]({{site_root}}/components/discovery/) enabled (which is by default). -See the [components overview page](/components/) to find installation instructions for your devices and services. Many components use the `sensor` platform. Sensors need to be added into the `configuration.yaml` as `sensor:`, `sensor 2:`, `sensor 3:`, etc. There should not be gaps in the sequence or your sensors might not load correctly. +See the [components overview page](/components/) to find installation instructions for your devices and services. If you can't find support for your favorite device or service, [consider adding support](/developers/add_new_platform/). -

-Most components that support multiple entries within the configuration.yaml follow the component:, component 2: format. -

+Usually every entity needs its own entry in the `configuration.yaml` file. There are two kind of styles for multiple entries: -If you can't find support for your favorite device or service, [consider adding support](/developers/add_new_platform/) +#### {% linkable_title Style 1 %} + +Collect every entity under the "parent". + +```yaml +sensor: + - platform: mqtt + state_topic: "home/bedroom/temperature" + name: "MQTT Sensor 1" + - platform: mqtt + state_topic: "home/bedroom/temperature" + name: "MQTT Sensor 2" + - platform: rest + resource: http://IP_ADDRESS/ENDPOINT + +switch: + - platform: vera +``` + +#### {% linkable_title Style 2 %} + +If you prefer to place your entries somewhere in the `configuration.yaml` file then you just choose this style. There should not be gaps in the sequence when you use numbers or your entities might not load correctly. Instead of numbers you are free to use strings (like `media_player livingroom:` or `media_player kitchen:`) to differentiate the entries as long as the appended strings are unique. + +```yaml +media_player 1: + platform: mpd + server: IP_ADDRESS + +media_player 2: + platform: plex + +camera: + platform: generic + +media_player 3: + platform: sonos +``` ### {% linkable_title Grouping devices %} From bfaac10796f3e762714ce3fde1bf11eba5ff888d Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Tue, 24 Nov 2015 08:09:44 +0100 Subject: [PATCH 3/3] Remove sequential requirement and add a note --- source/getting-started/devices.markdown | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/source/getting-started/devices.markdown b/source/getting-started/devices.markdown index 93e2a0c0a6e..a026836a85b 100644 --- a/source/getting-started/devices.markdown +++ b/source/getting-started/devices.markdown @@ -25,7 +25,7 @@ sensor: state_topic: "home/bedroom/temperature" name: "MQTT Sensor 1" - platform: mqtt - state_topic: "home/bedroom/temperature" + state_topic: "home/kitchen/temperature" name: "MQTT Sensor 2" - platform: rest resource: http://IP_ADDRESS/ENDPOINT @@ -36,7 +36,7 @@ switch: #### {% linkable_title Style 2 %} -If you prefer to place your entries somewhere in the `configuration.yaml` file then you just choose this style. There should not be gaps in the sequence when you use numbers or your entities might not load correctly. Instead of numbers you are free to use strings (like `media_player livingroom:` or `media_player kitchen:`) to differentiate the entries as long as the appended strings are unique. +If you prefer to place your entries somewhere in the `configuration.yaml` file then you just choose this style. You need to append numbers (see example below) or strings (like `media_player livingroom:` or `media_player kitchen:`) to differentiate the entries. The appended number or string must be unique. ```yaml media_player 1: @@ -53,6 +53,10 @@ media_player 3: platform: sonos ``` +

+If your devices are not showing up in the frontend then check the entries in your configuration.yaml file for duplicates. +

+ ### {% linkable_title Grouping devices %} Once you get a bunch of devices set up, it is time to organize them. This can be done using groups. Each group exists of a name and a list of entity IDs. Entity IDs can be retrieved from the web interface by using the Set State page in the Developer Tools (icon in the middle).