mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-18 23:06:58 +00:00
Minimizing of the configuration sample (#1034)
This commit is contained in:
parent
a175486bb3
commit
fab9b3034e
@ -21,14 +21,11 @@ To use this notification platform in your installation, add the following to you
|
|||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
notify:
|
notify:
|
||||||
|
- name: NOTIFIER_NAME
|
||||||
platform: aws_lambda
|
platform: aws_lambda
|
||||||
name: NOTIFIER_NAME
|
|
||||||
aws_access_key_id: AWS_ACCESS_KEY_ID
|
aws_access_key_id: AWS_ACCESS_KEY_ID
|
||||||
aws_secret_access_key: AWS_SECRET_ACCESS_KEY
|
aws_secret_access_key: AWS_SECRET_ACCESS_KEY
|
||||||
profile_name: AWS_PROFILE
|
|
||||||
region_name: 'us-east-1'
|
region_name: 'us-east-1'
|
||||||
context:
|
|
||||||
...
|
|
||||||
```
|
```
|
||||||
|
|
||||||
Configuration variables:
|
Configuration variables:
|
||||||
|
@ -19,11 +19,10 @@ To use this notification platform in your installation, add the following to you
|
|||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
notify:
|
notify:
|
||||||
|
- name: NOTIFIER_NAME
|
||||||
platform: aws_sns
|
platform: aws_sns
|
||||||
name: NOTIFIER_NAME
|
|
||||||
aws_access_key_id: AWS_ACCESS_KEY_ID
|
aws_access_key_id: AWS_ACCESS_KEY_ID
|
||||||
aws_secret_access_key: AWS_SECRET_ACCESS_KEY
|
aws_secret_access_key: AWS_SECRET_ACCESS_KEY
|
||||||
profile_name: AWS_PROFILE
|
|
||||||
region_name: 'us-east-1'
|
region_name: 'us-east-1'
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -19,11 +19,10 @@ To use this notification platform in your installation, add the following to you
|
|||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
notify:
|
notify:
|
||||||
|
- name: NOTIFIER_NAME
|
||||||
platform: aws_sqs
|
platform: aws_sqs
|
||||||
name: NOTIFIER_NAME
|
|
||||||
aws_access_key_id: AWS_ACCESS_KEY_ID
|
aws_access_key_id: AWS_ACCESS_KEY_ID
|
||||||
aws_secret_access_key: AWS_SECRET_ACCESS_KEY
|
aws_secret_access_key: AWS_SECRET_ACCESS_KEY
|
||||||
profile_name: AWS_PROFILE
|
|
||||||
region_name: 'us-east-1'
|
region_name: 'us-east-1'
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -19,7 +19,7 @@ To enable those notifications in your installation, add the following to your `c
|
|||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
notify:
|
notify:
|
||||||
name: NOTIFIER_NAME
|
- name: NOTIFIER_NAME
|
||||||
platform: command_line
|
platform: command_line
|
||||||
command: "espeak -vmb/mb-us1"
|
command: "espeak -vmb/mb-us1"
|
||||||
```
|
```
|
||||||
|
@ -19,7 +19,7 @@ To use this notification platform in your installation, add the following to you
|
|||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
notify:
|
notify:
|
||||||
name: NOTIFIER_NAME
|
- name: NOTIFIER_NAME
|
||||||
platform: ecobee
|
platform: ecobee
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -20,16 +20,15 @@ To enable file notifications in your installation, add the following to your `co
|
|||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
notify:
|
notify:
|
||||||
name: NOTIFIER_NAME
|
- name: NOTIFIER_NAME
|
||||||
platform: file
|
platform: file
|
||||||
filename: FILENAME
|
filename: FILENAME
|
||||||
timestamp: true or false
|
|
||||||
```
|
```
|
||||||
|
|
||||||
Configuration variables:
|
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`.
|
- **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.
|
- **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/).
|
To use notifications, please see the [getting started with automation page](/getting-started/automation/).
|
||||||
|
@ -31,6 +31,7 @@ To enable SMS notifications in your installation, add the following to your `con
|
|||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
notify:
|
notify:
|
||||||
|
- name: NOTIFIER_NAME
|
||||||
platform: free_mobile
|
platform: free_mobile
|
||||||
username: YOUR_ACCOUNT_ID
|
username: YOUR_ACCOUNT_ID
|
||||||
access_token: TOKEN
|
access_token: TOKEN
|
||||||
|
@ -20,7 +20,7 @@ To use GNTP notifications, add the following to your `configuration.yaml` file:
|
|||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
notify:
|
notify:
|
||||||
name: NOTIFER_NAME
|
- name: NOTIFER_NAME
|
||||||
platform: gntp
|
platform: gntp
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -19,7 +19,7 @@ To use this notification platform in your installation, add the following to you
|
|||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
notify:
|
notify:
|
||||||
name: MyDevices
|
- name: NOTIFIER_NAME
|
||||||
platform: group
|
platform: group
|
||||||
services:
|
services:
|
||||||
- service: html5
|
- service: html5
|
||||||
|
@ -20,7 +20,7 @@ To enable this platform, add the following lines to your `configuration.yaml` fi
|
|||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
notify:
|
notify:
|
||||||
name: HTML5
|
- name: NOTIFIER_NAME
|
||||||
platform: html5
|
platform: html5
|
||||||
gcm_api_key: 'gcm-sender-key'
|
gcm_api_key: 'gcm-sender-key'
|
||||||
gcm_sender_id: 'gcm-sender-id'
|
gcm_sender_id: 'gcm-sender-id'
|
||||||
|
@ -22,7 +22,7 @@ To add Instapush to your installation, add the following to your `configuration.
|
|||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
notify:
|
notify:
|
||||||
name: NOTIFIER_NAME
|
- name: NOTIFIER_NAME
|
||||||
platform: instapush
|
platform: instapush
|
||||||
api_key: ABCDEFGHJKLMNOPQRSTUVXYZ
|
api_key: ABCDEFGHJKLMNOPQRSTUVXYZ
|
||||||
app_secret: ABCDEFGHJKLMNOPQRSTUVXYZ
|
app_secret: ABCDEFGHJKLMNOPQRSTUVXYZ
|
||||||
@ -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`.
|
- **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.
|
- **api_key** (*Required*): Your API key for Instapush.
|
||||||
- **app_secret** (*Required*): The secret for your created application.
|
- **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.
|
- **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*.
|
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*.
|
||||||
|
@ -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.
|
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
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
notify:
|
notify:
|
||||||
|
- name: NOTIFIER_NAME
|
||||||
platform: kodi
|
platform: kodi
|
||||||
name: NOTIFIER_NAME
|
|
||||||
host: http://192.168.0.123
|
host: http://192.168.0.123
|
||||||
port: 8080
|
|
||||||
username: USERNAME
|
|
||||||
password: PASSWORD
|
|
||||||
```
|
```
|
||||||
|
|
||||||
- **name** (*Optional*): Name displayed in the frontend. The notifier will bind to the service `notify.NOTIFIER_NAME`.
|
- **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.
|
- **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.
|
- **username** (*Optional*): The XBMC/Kodi HTTP username.
|
||||||
- **password** (*Optional*): The XBMC/Kodi HTTP password.
|
- **password** (*Optional*): The XBMC/Kodi HTTP password.
|
||||||
|
|
||||||
### {% linkable_title script.yaml example %}
|
### {% linkable_title script.yaml example %}
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
################################################################
|
|
||||||
## Script / Notify KODI
|
|
||||||
################################################################
|
|
||||||
kodi_notification:
|
kodi_notification:
|
||||||
sequence:
|
sequence:
|
||||||
- service: notify.NOTIFIER_NAME
|
- service: notify.NOTIFIER_NAME
|
||||||
@ -50,7 +44,9 @@ kodi_notification:
|
|||||||
displaytime: 20000
|
displaytime: 20000
|
||||||
icon: "warning"
|
icon: "warning"
|
||||||
```
|
```
|
||||||
#### message variables:
|
|
||||||
|
#### {% linkable_title Message variables %}
|
||||||
|
|
||||||
- **title** (*Optional*): Title that is displayed on the message.
|
- **title** (*Optional*): Title that is displayed on the message.
|
||||||
- **message** (*Required*): Message to be displayed.
|
- **message** (*Required*): Message to be displayed.
|
||||||
- **data** (*Optional*)
|
- **data** (*Optional*)
|
||||||
|
@ -22,7 +22,7 @@ To add Automate to your installation, add the following to your `configuration.y
|
|||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
notify:
|
notify:
|
||||||
name: NOTIFIER_NAME
|
- name: NOTIFIER_NAME
|
||||||
platform: llamalab_automate
|
platform: llamalab_automate
|
||||||
api_key: ABCDEFGHJKLMNOPQRSTUVXYZ
|
api_key: ABCDEFGHJKLMNOPQRSTUVXYZ
|
||||||
to: example@gmail.com
|
to: example@gmail.com
|
||||||
|
@ -16,10 +16,8 @@ The `notify` component makes it possible to send notifications to a wide variety
|
|||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
notify:
|
notify:
|
||||||
platform: pushbullet
|
- platform: pushbullet
|
||||||
# Optional name for the notify service
|
|
||||||
name: paulus
|
name: paulus
|
||||||
# api_key is a required config key by the pushbullet platform
|
|
||||||
api_key: ABCDEFG
|
api_key: ABCDEFG
|
||||||
```
|
```
|
||||||
|
|
||||||
@ -82,5 +80,3 @@ If the service support sending the location, the data from this sample can be us
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
@ -19,10 +19,9 @@ To enable MessageBird notifications in your installation, add the following to y
|
|||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
notify:
|
notify:
|
||||||
|
- name: NOTIFIER_NAME
|
||||||
platform: message_bird
|
platform: message_bird
|
||||||
api_key: YOUR_API_KEY
|
api_key: YOUR_API_KEY
|
||||||
name: NOTIFIER_NAME
|
|
||||||
sender: SENDER_NAME
|
|
||||||
```
|
```
|
||||||
|
|
||||||
Configuration variables:
|
Configuration variables:
|
||||||
|
@ -22,7 +22,7 @@ To add NMA to your installation, add the following to your `configuration.yaml`
|
|||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
notify:
|
notify:
|
||||||
name: NOTIFIER_NAME
|
- name: NOTIFIER_NAME
|
||||||
platform: nma
|
platform: nma
|
||||||
api_key: ABCDEFGHJKLMNOPQRSTUVXYZ
|
api_key: ABCDEFGHJKLMNOPQRSTUVXYZ
|
||||||
```
|
```
|
||||||
|
@ -19,9 +19,9 @@ To enable Pushbullet notifications in your installation, add the following to yo
|
|||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
notify:
|
notify:
|
||||||
|
- name: NOTIFIER_NAME
|
||||||
platform: pushbullet
|
platform: pushbullet
|
||||||
api_key: YOUR_API_KEY
|
api_key: YOUR_API_KEY
|
||||||
name: NOTIFIER_NAME
|
|
||||||
```
|
```
|
||||||
|
|
||||||
Configuration variables:
|
Configuration variables:
|
||||||
|
@ -22,7 +22,7 @@ To enable Pushetta notifications in your installation, add the following to your
|
|||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
notify:
|
notify:
|
||||||
name: NOTIFIER_NAME
|
- name: NOTIFIER_NAME
|
||||||
platform: pushetta
|
platform: pushetta
|
||||||
api_key: YOUR_API_KEY
|
api_key: YOUR_API_KEY
|
||||||
channel_name: YOUR_CHANNEL_NAME
|
channel_name: YOUR_CHANNEL_NAME
|
||||||
|
@ -22,7 +22,7 @@ To use Pushover notifications, add the following to your `configuration.yaml` fi
|
|||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
notify:
|
notify:
|
||||||
name: NOTIFIER_NAME
|
- name: NOTIFIER_NAME
|
||||||
platform: pushover
|
platform: pushover
|
||||||
api_key: ABCDEFGHJKLMNOPQRSTUVXYZ
|
api_key: ABCDEFGHJKLMNOPQRSTUVXYZ
|
||||||
user_key: ABCDEFGHJKLMNOPQRSTUVXYZ
|
user_key: ABCDEFGHJKLMNOPQRSTUVXYZ
|
||||||
|
@ -19,13 +19,9 @@ To enable the REST notification in your installation, add the following to your
|
|||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
notify:
|
notify:
|
||||||
name: NOTIFIER_NAME
|
- name: NOTIFIER_NAME
|
||||||
platform: rest
|
platform: rest
|
||||||
resource: http://IP_ADDRESS/ENDPOINT
|
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
|
|
||||||
```
|
```
|
||||||
|
|
||||||
Configuration variables:
|
Configuration variables:
|
||||||
|
@ -18,7 +18,7 @@ To enable notification emails via SendGrid in your installation, add the followi
|
|||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
notify:
|
notify:
|
||||||
name: NOTIFIER_NAME
|
- name: NOTIFIER_NAME
|
||||||
platform: sendgrid
|
platform: sendgrid
|
||||||
api_key: API_KEY
|
api_key: API_KEY
|
||||||
sender: SENDER_EMAIL_ADDRESS
|
sender: SENDER_EMAIL_ADDRESS
|
||||||
|
@ -26,12 +26,10 @@ To enable the slack notification in your installation, add the following to your
|
|||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
notify:
|
notify:
|
||||||
name: NOTIFIER_NAME
|
- name: NOTIFIER_NAME
|
||||||
platform: slack
|
platform: slack
|
||||||
api_key: ABCDEFGHJKLMNOPQRSTUVXYZ
|
api_key: ABCDEFGHJKLMNOPQRSTUVXYZ
|
||||||
default_channel: '#general'
|
default_channel: '#general'
|
||||||
icon: ':robot_face:'
|
|
||||||
username: 'Home-Assistant'
|
|
||||||
```
|
```
|
||||||
|
|
||||||
Configuration variables:
|
Configuration variables:
|
||||||
|
@ -20,22 +20,17 @@ To enable notification by e-mail in your installation, add the following to your
|
|||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
notify:
|
notify:
|
||||||
name: NOTIFIER_NAME
|
- name: NOTIFIER_NAME
|
||||||
platform: smtp
|
platform: smtp
|
||||||
server: MAIL_SERVER
|
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
|
recipient: YOUR_RECIPIENT
|
||||||
```
|
```
|
||||||
|
|
||||||
Configuration variables:
|
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`.
|
- **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`.
|
- **server** (*Optional*): SMTP server which is used to end the notifications. 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.
|
- **port** (*Optional*): The port that the SMTP server is using. Defaults to 25.
|
||||||
- **sender** (*Optional*): E-mail address of the sender.
|
- **sender** (*Optional*): E-mail address of the sender.
|
||||||
- **username** (*Optional*): Username for the SMTP account.
|
- **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.
|
- **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.
|
- **starttls** (*Optional*): Enables STARTTLS, eg. True or False. Defaults to False.
|
||||||
- **debug** (*Optional*): Enables Debug, 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:
|
To use the SMTP notification, refer to it in an automation or script like in this example:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
|
@ -19,11 +19,8 @@ To enable syslog notifications in your installation, add the following to your `
|
|||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
notify:
|
notify:
|
||||||
name: NOTIFIER_NAME
|
- name: NOTIFIER_NAME
|
||||||
platform: syslog
|
platform: syslog
|
||||||
facility: SYSLOG_FACILITY
|
|
||||||
option: SYSLOG_LOG_OPTION
|
|
||||||
priority: SYSLOG_PRIORITY
|
|
||||||
```
|
```
|
||||||
|
|
||||||
Configuration variables:
|
Configuration variables:
|
||||||
|
@ -44,7 +44,7 @@ To enable Telegram notifications in your installation, add the following to your
|
|||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
notify:
|
notify:
|
||||||
name: NOTIFIER_NAME
|
- name: NOTIFIER_NAME
|
||||||
platform: telegram
|
platform: telegram
|
||||||
api_key: ABCDEFGHJKLMNOPQRSTUVXYZ
|
api_key: ABCDEFGHJKLMNOPQRSTUVXYZ
|
||||||
chat_id: YOUR_CHAT_ID
|
chat_id: YOUR_CHAT_ID
|
||||||
|
@ -19,8 +19,8 @@ To use this notification platform in your installation, add the following to you
|
|||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
notify:
|
notify:
|
||||||
|
- name: NOTIFIER_NAME
|
||||||
platform: twilio_sms
|
platform: twilio_sms
|
||||||
name: NOTIFIER_NAME
|
|
||||||
account_sid: ACCOUNT_SID_FROM_TWILIO
|
account_sid: ACCOUNT_SID_FROM_TWILIO
|
||||||
auth_token: AUTH_TOKEN_FROM_TWILIO
|
auth_token: AUTH_TOKEN_FROM_TWILIO
|
||||||
from_number: E164_PHONE_NUMBER
|
from_number: E164_PHONE_NUMBER
|
||||||
|
@ -22,7 +22,7 @@ To add Twitter to your installation, add the following to your `configuration.ya
|
|||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
notify:
|
notify:
|
||||||
name: NOTIFIER_NAME
|
- name: NOTIFIER_NAME
|
||||||
platform: twitter
|
platform: twitter
|
||||||
consumer_key: ABCDEFGHJKLMNOPQRSTUVXYZ
|
consumer_key: ABCDEFGHJKLMNOPQRSTUVXYZ
|
||||||
consumer_secret: ABCDEFGHJKLMNOPQRSTUVXYZ
|
consumer_secret: ABCDEFGHJKLMNOPQRSTUVXYZ
|
||||||
|
@ -9,7 +9,7 @@ sharing: true
|
|||||||
footer: true
|
footer: true
|
||||||
logo: webos.png
|
logo: webos.png
|
||||||
ha_category: Notifications
|
ha_category: Notifications
|
||||||
ha_iot_class: "Local Poll"
|
ha_iot_class: "Local Polling"
|
||||||
ha_release: 0.18
|
ha_release: 0.18
|
||||||
---
|
---
|
||||||
|
|
||||||
@ -22,15 +22,15 @@ To add a TV to your installation, add the following to your `configuration.yaml`
|
|||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
notify:
|
notify:
|
||||||
platform: webostv
|
- platform: webostv
|
||||||
host: 192.168.0.112
|
host: 192.168.0.112
|
||||||
name: livingroom_tv
|
name: livingroom_tv
|
||||||
```
|
```
|
||||||
|
|
||||||
Configuration variables:
|
Configuration variables:
|
||||||
|
|
||||||
- **host** *Required*: The IP of the LG WebOS Smart TV, e.g. 192.168.0.10
|
- **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.
|
- **name** (*Required*): The name you would like to give to the LG WebOS Smart TV.
|
||||||
|
|
||||||
A possible automation could be:
|
A possible automation could be:
|
||||||
|
|
||||||
|
@ -18,12 +18,11 @@ The `xmpp` platform allows you to deliver notifications from Home Assistant to a
|
|||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
notify:
|
notify:
|
||||||
name: NOTIFIER_NAME
|
- name: NOTIFIER_NAME
|
||||||
platform: xmpp
|
platform: xmpp
|
||||||
sender: YOUR_JID
|
sender: YOUR_JID
|
||||||
password: YOUR_JABBER_ACCOUNT_PASSWORD
|
password: YOUR_JABBER_ACCOUNT_PASSWORD
|
||||||
recipient: YOUR_RECIPIENT
|
recipient: YOUR_RECIPIENT
|
||||||
tls: False
|
|
||||||
```
|
```
|
||||||
|
|
||||||
Configuration variables:
|
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.
|
- **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.
|
- **password** (*Required*): The password for your given Jabber account.
|
||||||
- **recipient** (*Required*): The Jabber ID (JID) that will receive the messages.
|
- **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.
|
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/).
|
To use notifications, please see the [getting started with automation page](/getting-started/automation/).
|
||||||
|
Loading…
x
Reference in New Issue
Block a user