jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-18 23:06:58 +00:00
Code Issues Packages Projects Releases Wiki Activity

Minimizing of the configuration sample (#1034)

Browse Source
This commit is contained in:
Fabian Affolter 2016-10-02 17:12:58 +02:00 committed by GitHub
parent a175486bb3
commit fab9b3034e
29 changed files with 146 additions and 158 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
source/_components/notify.aws_lambda.markdown
View File

@ -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:

11
source/_components/notify.aws_sns.markdown
View File

@ -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:

11
source/_components/notify.aws_sqs.markdown
View File

@ -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:

6
source/_components/notify.command_line.markdown
View File

@ -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:

4
source/_components/notify.ecobee.markdown
View File

@ -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:

9
source/_components/notify.file.markdown
View File

@ -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/).

7
source/_components/notify.free_mobile.markdown
View File

@ -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:

4
source/_components/notify.gntp.markdown
View File

@ -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.

14
source/_components/notify.group.markdown
View File

@ -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:

8
source/_components/notify.html5.markdown
View File

@ -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:

14
source/_components/notify.instapush.markdown
View File

@ -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*.

22
source/_components/notify.kodi.markdown
View File

@ -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*)

8
source/_components/notify.llamalab_automate.markdown
View File

@ -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:

10
source/_components/notify.markdown
View File

@ -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
}
```

7
source/_components/notify.message_bird.markdown
View File

@ -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:

6
source/_components/notify.nma.markdown
View File

@ -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:

6
source/_components/notify.pushbullet.markdown
View File

@ -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:

8
source/_components/notify.pushetta.markdown
View File

@ -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:

8
source/_components/notify.pushover.markdown
View File

@ -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:

10
source/_components/notify.rest.markdown
View File

@ -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:

10
source/_components/notify.sendgrid.markdown
View File

@ -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:

10
source/_components/notify.slack.markdown
View File

@ -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:

35
source/_components/notify.smtp.markdown
View File

@ -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

7
source/_components/notify.syslog.markdown
View File

@ -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:

8
source/_components/notify.telegram.markdown
View File

@ -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:

10
source/_components/notify.twilio_sms.markdown
View File

@ -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:

12
source/_components/notify.twitter.markdown
View File

@ -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:

12
source/_components/notify.webostv.markdown
View File

@ -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:

14
source/_components/notify.xmpp.markdown
View File

@ -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/).