Minimizing of the configuration sample (home-assistant#1034)

fabaff · web-flow · commit fab9b3034e14 · 2016-10-02T17:12:58.000+02:00
diff --git a/source/_components/notify.aws_lambda.markdown b/source/_components/notify.aws_lambda.markdown
@@ -21,14 +21,11 @@ To use this notification platform in your installation, add the following to you
 ```yaml
 # Example configuration.yaml entry
 notify:
-  platform: aws_lambda
-  name: NOTIFIER_NAME
-  aws_access_key_id: AWS_ACCESS_KEY_ID
-  aws_secret_access_key: AWS_SECRET_ACCESS_KEY
-  profile_name: AWS_PROFILE
-  region_name: 'us-east-1'
-  context:
-    ...
+  - name: NOTIFIER_NAME
+    platform: aws_lambda
+    aws_access_key_id: AWS_ACCESS_KEY_ID
+    aws_secret_access_key: AWS_SECRET_ACCESS_KEY
+    region_name: 'us-east-1'
 ```
 
 Configuration variables:
diff --git a/source/_components/notify.aws_sns.markdown b/source/_components/notify.aws_sns.markdown
@@ -19,12 +19,11 @@ To use this notification platform in your installation, add the following to you
 ```yaml
 # Example configuration.yaml entry
 notify:
-  platform: aws_sns
-  name: NOTIFIER_NAME
-  aws_access_key_id: AWS_ACCESS_KEY_ID
-  aws_secret_access_key: AWS_SECRET_ACCESS_KEY
-  profile_name: AWS_PROFILE
-  region_name: 'us-east-1'
+  - name: NOTIFIER_NAME
+    platform: aws_sns
+    aws_access_key_id: AWS_ACCESS_KEY_ID
+    aws_secret_access_key: AWS_SECRET_ACCESS_KEY
+    region_name: 'us-east-1'
 ```
 
 Configuration variables:
diff --git a/source/_components/notify.aws_sqs.markdown b/source/_components/notify.aws_sqs.markdown
@@ -19,12 +19,11 @@ To use this notification platform in your installation, add the following to you
 ```yaml
 # Example configuration.yaml entry
 notify:
-  platform: aws_sqs
-  name: NOTIFIER_NAME
-  aws_access_key_id: AWS_ACCESS_KEY_ID
-  aws_secret_access_key: AWS_SECRET_ACCESS_KEY
-  profile_name: AWS_PROFILE
-  region_name: 'us-east-1'
+  - name: NOTIFIER_NAME
+    platform: aws_sqs
+    aws_access_key_id: AWS_ACCESS_KEY_ID
+    aws_secret_access_key: AWS_SECRET_ACCESS_KEY
+    region_name: 'us-east-1'
 ```
 
 Configuration variables:
diff --git a/source/_components/notify.command_line.markdown b/source/_components/notify.command_line.markdown
@@ -19,9 +19,9 @@ To enable those notifications in your installation, add the following to your `c
 ```yaml
 # Example configuration.yaml entry
 notify:
-  name: NOTIFIER_NAME
-  platform: command_line
-  command: "espeak -vmb/mb-us1"
+  - name: NOTIFIER_NAME
+    platform: command_line
+    command: "espeak -vmb/mb-us1"
 ```
 
 Configuration variables:
diff --git a/source/_components/notify.ecobee.markdown b/source/_components/notify.ecobee.markdown
@@ -19,8 +19,8 @@ To use this notification platform in your installation, add the following to you
 ```yaml
 # Example configuration.yaml entry
 notify:
-  name: NOTIFIER_NAME
-  platform: ecobee
+  - name: NOTIFIER_NAME
+    platform: ecobee
 ```
 
 Configuration variables:
diff --git a/source/_components/notify.file.markdown b/source/_components/notify.file.markdown
@@ -20,16 +20,15 @@ To enable file notifications in your installation, add the following to your `co
 ```yaml
 # Example configuration.yaml entry
 notify:
-  name: NOTIFIER_NAME
-  platform: file
-  filename: FILENAME
-  timestamp: true or false
+  - name: NOTIFIER_NAME
+    platform: file
+    filename: FILENAME
 ```
 
 Configuration variables:
 
 - **name** (*Optional*): Setting the optional parameter `name` allows multiple notifiers to be created. The default value is `notify`. The notifier will bind to the service `notify.NOTIFIER_NAME`.
 - **filename** (*Required*): Name of the file to use. The file will be created if it doesn't exist and saved in your `config/` folder.
-- **timestamp** (*Optional*): Setting `timestamp` to True adds a timestamp to every entry.
+- **timestamp** (*Optional*): Setting `timestamp` to `True` adds a timestamp to every entry.
 
 To use notifications, please see the [getting started with automation page](/getting-started/automation/).
diff --git a/source/_components/notify.free_mobile.markdown b/source/_components/notify.free_mobile.markdown
@@ -31,9 +31,10 @@ To enable SMS notifications in your installation, add the following to your `con
 ```yaml
 # Example configuration.yaml entry
 notify:
-  platform: free_mobile
-  username: YOUR_ACCOUNT_ID
-  access_token: TOKEN
+  - name: NOTIFIER_NAME
+    platform: free_mobile
+    username: YOUR_ACCOUNT_ID
+    access_token: TOKEN
 ```
 
 Configuration variables:
diff --git a/source/_components/notify.gntp.markdown b/source/_components/notify.gntp.markdown
@@ -20,8 +20,8 @@ To use GNTP notifications, add the following to your `configuration.yaml` file:
 ```yaml
 # Example configuration.yaml entry
 notify:
-  name: NOTIFER_NAME
-  platform: gntp
+  - name: NOTIFER_NAME
+    platform: gntp
 ```
 
 GNTP will attempt to connect to a local server running on port 23053 if no `hostname` is provided.
diff --git a/source/_components/notify.group.markdown b/source/_components/notify.group.markdown
@@ -19,13 +19,13 @@ To use this notification platform in your installation, add the following to you
 ```yaml
 # Example configuration.yaml entry
 notify:
-  name: MyDevices
-  platform: group
-  services:
-    - service: html5
-      data:
-        target: "macbook"
-    - service: html5_nexus
+  - name: NOTIFIER_NAME
+    platform: group
+    services:
+      - service: html5
+        data:
+          target: "macbook"
+      - service: html5_nexus
 ```
 
 Configuration variables:
diff --git a/source/_components/notify.html5.markdown b/source/_components/notify.html5.markdown
@@ -20,10 +20,10 @@ To enable this platform, add the following lines to your `configuration.yaml` fi
 ```yaml
 # Example configuration.yaml entry
 notify:
-  name: HTML5
-  platform: html5
-  gcm_api_key: 'gcm-sender-key'
-  gcm_sender_id: 'gcm-sender-id'
+  - name: NOTIFIER_NAME
+    platform: html5
+    gcm_api_key: 'gcm-sender-key'
+    gcm_sender_id: 'gcm-sender-id'
 ```
 
 Configuration variables:
diff --git a/source/_components/notify.instapush.markdown b/source/_components/notify.instapush.markdown
@@ -22,20 +22,20 @@ To add Instapush to your installation, add the following to your `configuration.
 ```yaml
 # Example configuration.yaml entry
 notify:
-  name: NOTIFIER_NAME
-  platform: instapush
-  api_key: ABCDEFGHJKLMNOPQRSTUVXYZ
-  app_secret: ABCDEFGHJKLMNOPQRSTUVXYZ
-  event: ABCDEFGHJKLMNOPQRSTUVXYZ
-  tracker: ABCDEFGHJKLMNOPQRSTUVXYZ
+  - name: NOTIFIER_NAME
+    platform: instapush
+    api_key: ABCDEFGHJKLMNOPQRSTUVXYZ
+    app_secret: ABCDEFGHJKLMNOPQRSTUVXYZ
+    event: ABCDEFGHJKLMNOPQRSTUVXYZ
+    tracker: ABCDEFGHJKLMNOPQRSTUVXYZ
 ```
 
 Configuration variables:
 
 - **name** (*Optional*): Setting the optional parameter `name` allows multiple notifiers to be created. The default value is `notify`. The notifier will bind to the service `notify.NOTIFIER_NAME`.
 - **api_key** (*Required*): Your API key for Instapush.
 - **app_secret** (*Required*): The secret for your created application.
-- **event** (*Required*): The event
+- **event** (*Required*): The event to push to.
 - **tracker** (*Required*): The name of tracker inside Instapush.
 
 To retrieve the needed values for existing settings, log into your account at [https://instapush.im](https://instapush.im) and go to your **Dashboard**. Then click the **APPS** tab, choose an app, and check the **Basic Info** section. The *Application ID* is the `api_key` and `app_secret` is the *Application Secret*.
diff --git a/source/_components/notify.kodi.markdown b/source/_components/notify.kodi.markdown
@@ -15,31 +15,25 @@ ha_release: 0.29
 
 The `Kodi` platform allows you so send messages to your  [Kodi](https://kodi.tv/) multimedia system from Home Assistant.
 
-To add Kodi to your installation, add the following to your configuration.yaml file:
+To add Kodi to your installation, add the following to your `configuration.yaml` file:
 
-### {% linkable_title Configuration %}
 ```yaml
 # Example configuration.yaml entry
 notify:
-  platform: kodi
-  name: NOTIFIER_NAME
-  host: http://192.168.0.123
-  port: 8080
-  username: USERNAME
-  password: PASSWORD
+  - name: NOTIFIER_NAME
+    platform: kodi
+    host: http://192.168.0.123
 ```
 
 - **name** (*Optional*): Name displayed in the frontend. The notifier will bind to the service `notify.NOTIFIER_NAME`.
 - **host** (*Required*): The host name or address of the device that is running Kodi.
-- **port** (*optional*): The port number, the default value is `8080`.
+- **port** (*Optional*): The port number, the default value is `8080`.
 - **username** (*Optional*): The XBMC/Kodi HTTP username.
 - **password** (*Optional*): The XBMC/Kodi HTTP password.
 
 ### {% linkable_title script.yaml example %}
+
 ```yaml
-################################################################
-## Script / Notify KODI
-################################################################
 kodi_notification:
   sequence:
   - service: notify.NOTIFIER_NAME
@@ -50,7 +44,9 @@ kodi_notification:
         displaytime: 20000
         icon: "warning"
 ```
-#### message variables:
+
+#### {% linkable_title Message variables %}
+
 - **title** (*Optional*): Title that is displayed on the message.
 - **message** (*Required*): Message to be displayed.
 - **data** (*Optional*)
diff --git a/source/_components/notify.llamalab_automate.markdown b/source/_components/notify.llamalab_automate.markdown
@@ -22,10 +22,10 @@ To add Automate to your installation, add the following to your `configuration.y
 ```yaml
 # Example configuration.yaml entry
 notify:
-  name: NOTIFIER_NAME
-  platform: llamalab_automate
-  api_key: ABCDEFGHJKLMNOPQRSTUVXYZ
-  to: example@gmail.com
+  - name: NOTIFIER_NAME
+    platform: llamalab_automate
+    api_key: ABCDEFGHJKLMNOPQRSTUVXYZ
+    to: example@gmail.com
 ```
 
 Configuration variables:
diff --git a/source/_components/notify.markdown b/source/_components/notify.markdown
@@ -16,11 +16,9 @@ The `notify` component makes it possible to send notifications to a wide variety
 ```yaml
 # Example configuration.yaml entry
 notify:
-  platform: pushbullet
-  # Optional name for the notify service
-  name: paulus
-  # api_key is a required config key by the pushbullet platform
-  api_key: ABCDEFG
+  - platform: pushbullet
+    name: paulus
+    api_key: ABCDEFG
 ```
 
 The **name** parameter is optional but needed if you want to use multiple platforms. The platform will be exposed as service `notify/<name>`. The name will default to `notify` if not supplied.
@@ -82,5 +80,3 @@ If the service support sending the location, the data from this sample can be us
 }
 ```
 
-
-
diff --git a/source/_components/notify.message_bird.markdown b/source/_components/notify.message_bird.markdown
@@ -19,10 +19,9 @@ To enable MessageBird notifications in your installation, add the following to y
 ```yaml
 # Example configuration.yaml entry
 notify:
-  platform: message_bird
-  api_key: YOUR_API_KEY
-  name: NOTIFIER_NAME
-  sender: SENDER_NAME
+  - name: NOTIFIER_NAME
+    platform: message_bird
+    api_key: YOUR_API_KEY
 ```
 
 Configuration variables:
diff --git a/source/_components/notify.nma.markdown b/source/_components/notify.nma.markdown
@@ -22,9 +22,9 @@ To add NMA to your installation, add the following to your `configuration.yaml`
 ```yaml
 # Example configuration.yaml entry
 notify:
-  name: NOTIFIER_NAME
-  platform: nma
-  api_key: ABCDEFGHJKLMNOPQRSTUVXYZ
+  - name: NOTIFIER_NAME
+    platform: nma
+    api_key: ABCDEFGHJKLMNOPQRSTUVXYZ
 ```
 
 Configuration variables:
diff --git a/source/_components/notify.pushbullet.markdown b/source/_components/notify.pushbullet.markdown
@@ -19,9 +19,9 @@ To enable Pushbullet notifications in your installation, add the following to yo
 ```yaml
 # Example configuration.yaml entry
 notify:
-  platform: pushbullet
-  api_key: YOUR_API_KEY
-  name: NOTIFIER_NAME
+  - name: NOTIFIER_NAME
+    platform: pushbullet
+    api_key: YOUR_API_KEY
 ```
 
 Configuration variables:
diff --git a/source/_components/notify.pushetta.markdown b/source/_components/notify.pushetta.markdown
@@ -22,10 +22,10 @@ To enable Pushetta notifications in your installation, add the following to your
 ```yaml
 # Example configuration.yaml entry
 notify:
-  name: NOTIFIER_NAME
-  platform: pushetta
-  api_key: YOUR_API_KEY
-  channel_name: YOUR_CHANNEL_NAME
+  - name: NOTIFIER_NAME
+    platform: pushetta
+    api_key: YOUR_API_KEY
+    channel_name: YOUR_CHANNEL_NAME
 ```
 
 Configuration variables:
diff --git a/source/_components/notify.pushover.markdown b/source/_components/notify.pushover.markdown
@@ -22,10 +22,10 @@ To use Pushover notifications, add the following to your `configuration.yaml` fi
 ```yaml
 # Example configuration.yaml entry
 notify:
-  name: NOTIFIER_NAME
-  platform: pushover
-  api_key: ABCDEFGHJKLMNOPQRSTUVXYZ
-  user_key: ABCDEFGHJKLMNOPQRSTUVXYZ
+  - name: NOTIFIER_NAME
+    platform: pushover
+    api_key: ABCDEFGHJKLMNOPQRSTUVXYZ
+    user_key: ABCDEFGHJKLMNOPQRSTUVXYZ
 ```
 
 Configuration variables:
diff --git a/source/_components/notify.rest.markdown b/source/_components/notify.rest.markdown
@@ -19,13 +19,9 @@ To enable the REST notification in your installation, add the following to your
 ```yaml
 # Example configuration.yaml entry
 notify:
-  name: NOTIFIER_NAME
-  platform: rest
-  resource: http://IP_ADDRESS/ENDPOINT
-  method: GET
-  message_param_name: MESSAGE_PARAMETER_NAME
-  title_param_name: TITLE_PARAMETER_NAME
-  target_param_name: TARGET_PARAMETER_NAME
+  - name: NOTIFIER_NAME
+    platform: rest
+    resource: http://IP_ADDRESS/ENDPOINT
 ```
 
 Configuration variables:
diff --git a/source/_components/notify.sendgrid.markdown b/source/_components/notify.sendgrid.markdown
@@ -18,11 +18,11 @@ To enable notification emails via SendGrid in your installation, add the followi
 ```yaml
 # Example configuration.yaml entry
 notify:
-  name: NOTIFIER_NAME
-  platform: sendgrid
-  api_key: API_KEY
-  sender: SENDER_EMAIL_ADDRESS
-  recipient: YOUR_RECIPIENT
+  - name: NOTIFIER_NAME
+    platform: sendgrid
+    api_key: API_KEY
+    sender: SENDER_EMAIL_ADDRESS
+    recipient: YOUR_RECIPIENT
 ```
 
 Configuration variables:
diff --git a/source/_components/notify.slack.markdown b/source/_components/notify.slack.markdown
@@ -26,12 +26,10 @@ To enable the slack notification in your installation, add the following to your
 ```yaml
 # Example configuration.yaml entry
 notify:
-  name: NOTIFIER_NAME
-  platform: slack
-  api_key: ABCDEFGHJKLMNOPQRSTUVXYZ
-  default_channel: '#general'
-  icon: ':robot_face:' 
-  username: 'Home-Assistant'
+  - name: NOTIFIER_NAME
+    platform: slack
+    api_key: ABCDEFGHJKLMNOPQRSTUVXYZ
+    default_channel: '#general'
 ```
 
 Configuration variables:
diff --git a/source/_components/notify.smtp.markdown b/source/_components/notify.smtp.markdown
diff --git a/source/_components/notify.syslog.markdown b/source/_components/notify.syslog.markdown
diff --git a/source/_components/notify.telegram.markdown b/source/_components/notify.telegram.markdown
diff --git a/source/_components/notify.twilio_sms.markdown b/source/_components/notify.twilio_sms.markdown
diff --git a/source/_components/notify.twitter.markdown b/source/_components/notify.twitter.markdown
diff --git a/source/_components/notify.webostv.markdown b/source/_components/notify.webostv.markdown
diff --git a/source/_components/notify.xmpp.markdown b/source/_components/notify.xmpp.markdown
