From cc2ae23d80c75f975e0e1a28fb61a58bd9b0e63f Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Sat, 1 Oct 2016 23:17:11 +0200 Subject: [PATCH] Minimizing of the configuration sample --- source/_components/notify.aws_lambda.markdown | 13 +++---- source/_components/notify.aws_sns.markdown | 11 +++--- source/_components/notify.aws_sqs.markdown | 11 +++--- .../_components/notify.command_line.markdown | 6 ++-- source/_components/notify.ecobee.markdown | 4 +-- source/_components/notify.file.markdown | 9 +++-- .../_components/notify.free_mobile.markdown | 7 ++-- source/_components/notify.gntp.markdown | 4 +-- source/_components/notify.group.markdown | 14 ++++---- source/_components/notify.html5.markdown | 8 ++--- source/_components/notify.instapush.markdown | 14 ++++---- source/_components/notify.kodi.markdown | 22 +++++------- .../notify.llamalab_automate.markdown | 8 ++--- source/_components/notify.markdown | 10 ++---- .../_components/notify.message_bird.markdown | 7 ++-- source/_components/notify.nma.markdown | 6 ++-- source/_components/notify.pushbullet.markdown | 6 ++-- source/_components/notify.pushetta.markdown | 8 ++--- source/_components/notify.pushover.markdown | 8 ++--- source/_components/notify.rest.markdown | 10 ++---- source/_components/notify.sendgrid.markdown | 10 +++--- source/_components/notify.slack.markdown | 10 +++--- source/_components/notify.smtp.markdown | 35 +++++++++++++------ source/_components/notify.syslog.markdown | 7 ++-- source/_components/notify.telegram.markdown | 8 ++--- source/_components/notify.twilio_sms.markdown | 10 +++--- source/_components/notify.twitter.markdown | 12 +++---- source/_components/notify.webostv.markdown | 12 +++---- source/_components/notify.xmpp.markdown | 14 ++++---- 29 files changed, 146 insertions(+), 158 deletions(-) diff --git a/source/_components/notify.aws_lambda.markdown b/source/_components/notify.aws_lambda.markdown index 64c9c2299260..21ef850da95d 100644 --- 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 index 82ad8bc3a794..21a6b48cc550 100644 --- 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 index d4a6c836eb08..e40e81050b1f 100644 --- 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 index b6f7a2ce9e11..a5d3b6a59425 100644 --- 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 index f079b783f807..18ba15b94b23 100644 --- 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 index 531d0fa4a1b2..b2c3a07d0515 100644 --- 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 index ed79113add43..0123c7fec5d9 100644 --- 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 index bf84923a0edc..f319a5980c24 100644 --- 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 index 69c3ab8088d7..01ef1d7dc8bb 100644 --- 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 index b3af87aa6985..4053acc1549b 100644 --- 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 index fb027e59e0a0..427991e60dcd 100644 --- a/source/_components/notify.instapush.markdown +++ b/source/_components/notify.instapush.markdown @@ -22,12 +22,12 @@ 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: @@ -35,7 +35,7 @@ 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 index a803d35aa2c4..a5ba6e0bacc9 100644 --- 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 index d875142005f9..3b5d5d2dd5a1 100644 --- 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 index 378e3e759454..6279291a69a3 100644 --- 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/`. 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 index 3a48b2d9f043..d8baf5fa0d7e 100644 --- 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 index 1d42cd28b2fe..c16a7ae04e48 100644 --- 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 index 1d58f8bf1936..0736697f3233 100644 --- 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 index 8b3a68c818ae..34b1adcc1ab4 100644 --- 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 index 20a7ca491317..4712c6acd7f2 100644 --- 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 index 253b78096d61..f0fa96ec6b49 100644 --- 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 index 1ba53da012a8..16bf7e992a13 100644 --- 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 index ca7861883cf3..040e070dcd9f 100644 --- 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 index d47604532ee8..bd6d47cdb468 100644 --- a/source/_components/notify.smtp.markdown +++ b/source/_components/notify.smtp.markdown @@ -20,22 +20,17 @@ To enable notification by e-mail in your installation, add the following to your ```yaml # Example configuration.yaml entry notify: - name: NOTIFIER_NAME - platform: smtp - server: MAIL_SERVER - port: YOUR_SMTP_PORT - sender: SENDER_EMAIL_ADDRESS - starttls: true or false - username: YOUR_SMTP_USERNAME - password: YOUR_SMTP_PASSWORD - recipient: YOUR_RECIPIENT + - name: NOTIFIER_NAME + platform: smtp + server: MAIL_SERVER + recipient: YOUR_RECIPIENT ``` 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`. -- **server** (*Optional*): SMTP server which is used to end the notifications. For Google Mail, eg. smtp.gmail.com. Keep in mind that Google has some extra layers of protection which need special attention (Hint: 'Less secure apps'). Defaults to `localhost`. -- **port** (*Optional*): The port that the SMTP server is using, eg. 587 for Google Mail and STARTTLS or 465/993 depending on your SMTP servers. Defaults to 25. +- **server** (*Optional*): SMTP server which is used to end the notifications. Defaults to `localhost`. +- **port** (*Optional*): The port that the SMTP server is using. Defaults to 25. - **sender** (*Optional*): E-mail address of the sender. - **username** (*Optional*): Username for the SMTP account. - **password** (*Optional*): Password for the SMTP server that belongs to the given username. If the password contains a colon it need to be wrapped in apostrophes. @@ -43,6 +38,24 @@ Configuration variables: - **starttls** (*Optional*): Enables STARTTLS, eg. True or False. Defaults to False. - **debug** (*Optional*): Enables Debug, eg. True or False. Defaults to False. +A sample configuration entry for Google Mail. + +```yaml +# Example configuration.yaml entry +notify: + - name: NOTIFIER_NAME + platform: smtp + server: smtp.gmail.com + port: 587 + sender: john@gmail.com + starttls: true + username: john@gmail.com + password: thePassword + recipient: james@gmail.com +``` + +Keep in mind that Google has some extra layers of protection which need special attention (Hint: 'Less secure apps'). + To use the SMTP notification, refer to it in an automation or script like in this example: ```yaml diff --git a/source/_components/notify.syslog.markdown b/source/_components/notify.syslog.markdown index 89f7f3b22463..0869e16039be 100644 --- a/source/_components/notify.syslog.markdown +++ b/source/_components/notify.syslog.markdown @@ -19,11 +19,8 @@ To enable syslog notifications in your installation, add the following to your ` ```yaml # Example configuration.yaml entry notify: - name: NOTIFIER_NAME - platform: syslog - facility: SYSLOG_FACILITY - option: SYSLOG_LOG_OPTION - priority: SYSLOG_PRIORITY + - name: NOTIFIER_NAME + platform: syslog ``` Configuration variables: diff --git a/source/_components/notify.telegram.markdown b/source/_components/notify.telegram.markdown index 4044f9ff3f1f..12de007003ef 100644 --- a/source/_components/notify.telegram.markdown +++ b/source/_components/notify.telegram.markdown @@ -44,10 +44,10 @@ To enable Telegram notifications in your installation, add the following to your ```yaml # Example configuration.yaml entry notify: - name: NOTIFIER_NAME - platform: telegram - api_key: ABCDEFGHJKLMNOPQRSTUVXYZ - chat_id: YOUR_CHAT_ID + - name: NOTIFIER_NAME + platform: telegram + api_key: ABCDEFGHJKLMNOPQRSTUVXYZ + chat_id: YOUR_CHAT_ID ``` Configuration variables: diff --git a/source/_components/notify.twilio_sms.markdown b/source/_components/notify.twilio_sms.markdown index f8865443eeae..6931d2507eb6 100644 --- a/source/_components/notify.twilio_sms.markdown +++ b/source/_components/notify.twilio_sms.markdown @@ -19,11 +19,11 @@ To use this notification platform in your installation, add the following to you ```yaml # Example configuration.yaml entry notify: - platform: twilio_sms - name: NOTIFIER_NAME - account_sid: ACCOUNT_SID_FROM_TWILIO - auth_token: AUTH_TOKEN_FROM_TWILIO - from_number: E164_PHONE_NUMBER + - name: NOTIFIER_NAME + platform: twilio_sms + account_sid: ACCOUNT_SID_FROM_TWILIO + auth_token: AUTH_TOKEN_FROM_TWILIO + from_number: E164_PHONE_NUMBER ``` Configuration variables: diff --git a/source/_components/notify.twitter.markdown b/source/_components/notify.twitter.markdown index c8f22d3ffc3a..8948669bfab3 100644 --- a/source/_components/notify.twitter.markdown +++ b/source/_components/notify.twitter.markdown @@ -22,12 +22,12 @@ To add Twitter to your installation, add the following to your `configuration.ya ```yaml # Example configuration.yaml entry notify: - name: NOTIFIER_NAME - platform: twitter - consumer_key: ABCDEFGHJKLMNOPQRSTUVXYZ - consumer_secret: ABCDEFGHJKLMNOPQRSTUVXYZ - access_token: ABCDEFGHJKLMNOPQRSTUVXYZ - access_token_secret: ABCDEFGHJKLMNOPQRSTUVXYZ + - name: NOTIFIER_NAME + platform: twitter + consumer_key: ABCDEFGHJKLMNOPQRSTUVXYZ + consumer_secret: ABCDEFGHJKLMNOPQRSTUVXYZ + access_token: ABCDEFGHJKLMNOPQRSTUVXYZ + access_token_secret: ABCDEFGHJKLMNOPQRSTUVXYZ ``` Configuration variables: diff --git a/source/_components/notify.webostv.markdown b/source/_components/notify.webostv.markdown index f69708da52ec..3c7a6113d200 100644 --- a/source/_components/notify.webostv.markdown +++ b/source/_components/notify.webostv.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: webos.png ha_category: Notifications -ha_iot_class: "Local Poll" +ha_iot_class: "Local Polling" ha_release: 0.18 --- @@ -22,15 +22,15 @@ To add a TV to your installation, add the following to your `configuration.yaml` ```yaml # Example configuration.yaml entry notify: - platform: webostv - host: 192.168.0.112 - name: livingroom_tv + - platform: webostv + host: 192.168.0.112 + name: livingroom_tv ``` Configuration variables: -- **host** *Required*: The IP of the LG WebOS Smart TV, e.g. 192.168.0.10 -- **name** *Required*: The name you would like to give to the LG WebOS Smart TV. +- **host** (*Required*): The IP of the LG WebOS Smart TV, e.g. 192.168.0.10 +- **name** (*Required*): The name you would like to give to the LG WebOS Smart TV. A possible automation could be: diff --git a/source/_components/notify.xmpp.markdown b/source/_components/notify.xmpp.markdown index 8d09f3e4b0f0..6ebdc4383bd8 100644 --- a/source/_components/notify.xmpp.markdown +++ b/source/_components/notify.xmpp.markdown @@ -18,12 +18,11 @@ The `xmpp` platform allows you to deliver notifications from Home Assistant to a ```yaml # Example configuration.yaml entry notify: - name: NOTIFIER_NAME - platform: xmpp - sender: YOUR_JID - password: YOUR_JABBER_ACCOUNT_PASSWORD - recipient: YOUR_RECIPIENT - tls: False + - name: NOTIFIER_NAME + platform: xmpp + sender: YOUR_JID + password: YOUR_JABBER_ACCOUNT_PASSWORD + recipient: YOUR_RECIPIENT ``` Configuration variables: @@ -32,9 +31,8 @@ Configuration variables: - **sender** (*Required*): The Jabber ID (JID) that will act as origin of the messages. Add your JID including the domain, eg. your_name@jabber.org. - **password** (*Required*): The password for your given Jabber account. - **recipient** (*Required*): The Jabber ID (JID) that will receive the messages. -- **tls** (*Optional*): Allow to disable TLS. Defaults to true. +- **tls** (*Optional*): Allow to disable TLS. Defaults to `true`. All Jabber IDs (JID) must include the domain. Make sure that the password matches the account provided as sender. - To use notifications, please see the [getting started with automation page](/getting-started/automation/).