Skip to content

Commit fab9b30

Browse files
fabafffabaff
authored
Minimizing of the configuration sample (#1034)
1 parent a175486 commit fab9b30

29 files changed

+146
-158
lines changed

‎source/_components/notify.aws_lambda.markdown

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -21,14 +21,11 @@ To use this notification platform in your installation, add the following to you
2121
```yaml
2222
# Example configuration.yaml entry
2323
notify:
24-
platform: aws_lambda
25-
name: NOTIFIER_NAME
26-
aws_access_key_id: AWS_ACCESS_KEY_ID
27-
aws_secret_access_key: AWS_SECRET_ACCESS_KEY
28-
profile_name: AWS_PROFILE
29-
region_name: 'us-east-1'
30-
context:
31-
...
24+
- name: NOTIFIER_NAME
25+
platform: aws_lambda
26+
aws_access_key_id: AWS_ACCESS_KEY_ID
27+
aws_secret_access_key: AWS_SECRET_ACCESS_KEY
28+
region_name: 'us-east-1'
3229
```
3330
3431
Configuration variables:

‎source/_components/notify.aws_sns.markdown

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -19,12 +19,11 @@ To use this notification platform in your installation, add the following to you
1919
```yaml
2020
# Example configuration.yaml entry
2121
notify:
22-
platform: aws_sns
23-
name: NOTIFIER_NAME
24-
aws_access_key_id: AWS_ACCESS_KEY_ID
25-
aws_secret_access_key: AWS_SECRET_ACCESS_KEY
26-
profile_name: AWS_PROFILE
27-
region_name: 'us-east-1'
22+
- name: NOTIFIER_NAME
23+
platform: aws_sns
24+
aws_access_key_id: AWS_ACCESS_KEY_ID
25+
aws_secret_access_key: AWS_SECRET_ACCESS_KEY
26+
region_name: 'us-east-1'
2827
```
2928
3029
Configuration variables:

‎source/_components/notify.aws_sqs.markdown

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -19,12 +19,11 @@ To use this notification platform in your installation, add the following to you
1919
```yaml
2020
# Example configuration.yaml entry
2121
notify:
22-
platform: aws_sqs
23-
name: NOTIFIER_NAME
24-
aws_access_key_id: AWS_ACCESS_KEY_ID
25-
aws_secret_access_key: AWS_SECRET_ACCESS_KEY
26-
profile_name: AWS_PROFILE
27-
region_name: 'us-east-1'
22+
- name: NOTIFIER_NAME
23+
platform: aws_sqs
24+
aws_access_key_id: AWS_ACCESS_KEY_ID
25+
aws_secret_access_key: AWS_SECRET_ACCESS_KEY
26+
region_name: 'us-east-1'
2827
```
2928
3029
Configuration variables:

‎source/_components/notify.command_line.markdown

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,9 @@ To enable those notifications in your installation, add the following to your `c
1919
```yaml
2020
# Example configuration.yaml entry
2121
notify:
22-
name: NOTIFIER_NAME
23-
platform: command_line
24-
command: "espeak -vmb/mb-us1"
22+
- name: NOTIFIER_NAME
23+
platform: command_line
24+
command: "espeak -vmb/mb-us1"
2525
```
2626
2727
Configuration variables:

‎source/_components/notify.ecobee.markdown

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,8 @@ To use this notification platform in your installation, add the following to you
1919
```yaml
2020
# Example configuration.yaml entry
2121
notify:
22-
name: NOTIFIER_NAME
23-
platform: ecobee
22+
- name: NOTIFIER_NAME
23+
platform: ecobee
2424
```
2525
2626
Configuration variables:

‎source/_components/notify.file.markdown

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,16 +20,15 @@ To enable file notifications in your installation, add the following to your `co
2020
```yaml
2121
# Example configuration.yaml entry
2222
notify:
23-
name: NOTIFIER_NAME
24-
platform: file
25-
filename: FILENAME
26-
timestamp: true or false
23+
- name: NOTIFIER_NAME
24+
platform: file
25+
filename: FILENAME
2726
```
2827
2928
Configuration variables:
3029
3130
- **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`.
3231
- **filename** (*Required*): Name of the file to use. The file will be created if it doesn't exist and saved in your `config/` folder.
33-
- **timestamp** (*Optional*): Setting `timestamp` to True adds a timestamp to every entry.
32+
- **timestamp** (*Optional*): Setting `timestamp` to `True` adds a timestamp to every entry.
3433

3534
To use notifications, please see the [getting started with automation page](/getting-started/automation/).

‎source/_components/notify.free_mobile.markdown

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,10 @@ To enable SMS notifications in your installation, add the following to your `con
3131
```yaml
3232
# Example configuration.yaml entry
3333
notify:
34-
platform: free_mobile
35-
username: YOUR_ACCOUNT_ID
36-
access_token: TOKEN
34+
- name: NOTIFIER_NAME
35+
platform: free_mobile
36+
username: YOUR_ACCOUNT_ID
37+
access_token: TOKEN
3738
```
3839
3940
Configuration variables:

‎source/_components/notify.gntp.markdown

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,8 @@ To use GNTP notifications, add the following to your `configuration.yaml` file:
2020
```yaml
2121
# Example configuration.yaml entry
2222
notify:
23-
name: NOTIFER_NAME
24-
platform: gntp
23+
- name: NOTIFER_NAME
24+
platform: gntp
2525
```
2626
2727
GNTP will attempt to connect to a local server running on port 23053 if no `hostname` is provided.

‎source/_components/notify.group.markdown

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -19,13 +19,13 @@ To use this notification platform in your installation, add the following to you
1919
```yaml
2020
# Example configuration.yaml entry
2121
notify:
22-
name: MyDevices
23-
platform: group
24-
services:
25-
- service: html5
26-
data:
27-
target: "macbook"
28-
- service: html5_nexus
22+
- name: NOTIFIER_NAME
23+
platform: group
24+
services:
25+
- service: html5
26+
data:
27+
target: "macbook"
28+
- service: html5_nexus
2929
```
3030
3131
Configuration variables:

‎source/_components/notify.html5.markdown

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,10 @@ To enable this platform, add the following lines to your `configuration.yaml` fi
2020
```yaml
2121
# Example configuration.yaml entry
2222
notify:
23-
name: HTML5
24-
platform: html5
25-
gcm_api_key: 'gcm-sender-key'
26-
gcm_sender_id: 'gcm-sender-id'
23+
- name: NOTIFIER_NAME
24+
platform: html5
25+
gcm_api_key: 'gcm-sender-key'
26+
gcm_sender_id: 'gcm-sender-id'
2727
```
2828
2929
Configuration variables:

‎source/_components/notify.instapush.markdown

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -22,20 +22,20 @@ To add Instapush to your installation, add the following to your `configuration.
2222
```yaml
2323
# Example configuration.yaml entry
2424
notify:
25-
name: NOTIFIER_NAME
26-
platform: instapush
27-
api_key: ABCDEFGHJKLMNOPQRSTUVXYZ
28-
app_secret: ABCDEFGHJKLMNOPQRSTUVXYZ
29-
event: ABCDEFGHJKLMNOPQRSTUVXYZ
30-
tracker: ABCDEFGHJKLMNOPQRSTUVXYZ
25+
- name: NOTIFIER_NAME
26+
platform: instapush
27+
api_key: ABCDEFGHJKLMNOPQRSTUVXYZ
28+
app_secret: ABCDEFGHJKLMNOPQRSTUVXYZ
29+
event: ABCDEFGHJKLMNOPQRSTUVXYZ
30+
tracker: ABCDEFGHJKLMNOPQRSTUVXYZ
3131
```
3232
3333
Configuration variables:
3434
3535
- **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`.
3636
- **api_key** (*Required*): Your API key for Instapush.
3737
- **app_secret** (*Required*): The secret for your created application.
38-
- **event** (*Required*): The event
38+
- **event** (*Required*): The event to push to.
3939
- **tracker** (*Required*): The name of tracker inside Instapush.
4040

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

‎source/_components/notify.kodi.markdown

Lines changed: 9 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -15,31 +15,25 @@ ha_release: 0.29
1515

1616
The `Kodi` platform allows you so send messages to your [Kodi](https://kodi.tv/) multimedia system from Home Assistant.
1717

18-
To add Kodi to your installation, add the following to your configuration.yaml file:
18+
To add Kodi to your installation, add the following to your `configuration.yaml` file:
1919

20-
### {% linkable_title Configuration %}
2120
```yaml
2221
# Example configuration.yaml entry
2322
notify:
24-
platform: kodi
25-
name: NOTIFIER_NAME
26-
host: http://192.168.0.123
27-
port: 8080
28-
username: USERNAME
29-
password: PASSWORD
23+
- name: NOTIFIER_NAME
24+
platform: kodi
25+
host: http://192.168.0.123
3026
```
3127
3228
- **name** (*Optional*): Name displayed in the frontend. The notifier will bind to the service `notify.NOTIFIER_NAME`.
3329
- **host** (*Required*): The host name or address of the device that is running Kodi.
34-
- **port** (*optional*): The port number, the default value is `8080`.
30+
- **port** (*Optional*): The port number, the default value is `8080`.
3531
- **username** (*Optional*): The XBMC/Kodi HTTP username.
3632
- **password** (*Optional*): The XBMC/Kodi HTTP password.
3733

3834
### {% linkable_title script.yaml example %}
35+
3936
```yaml
40-
################################################################
41-
## Script / Notify KODI
42-
################################################################
4337
kodi_notification:
4438
sequence:
4539
- service: notify.NOTIFIER_NAME
@@ -50,7 +44,9 @@ kodi_notification:
5044
displaytime: 20000
5145
icon: "warning"
5246
```
53-
#### message variables:
47+
48+
#### {% linkable_title Message variables %}
49+
5450
- **title** (*Optional*): Title that is displayed on the message.
5551
- **message** (*Required*): Message to be displayed.
5652
- **data** (*Optional*)

‎source/_components/notify.llamalab_automate.markdown

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,10 @@ To add Automate to your installation, add the following to your `configuration.y
2222
```yaml
2323
# Example configuration.yaml entry
2424
notify:
25-
name: NOTIFIER_NAME
26-
platform: llamalab_automate
27-
api_key: ABCDEFGHJKLMNOPQRSTUVXYZ
28-
to: example@gmail.com
25+
- name: NOTIFIER_NAME
26+
platform: llamalab_automate
27+
api_key: ABCDEFGHJKLMNOPQRSTUVXYZ
28+
to: example@gmail.com
2929
```
3030
3131
Configuration variables:

‎source/_components/notify.markdown

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -16,11 +16,9 @@ The `notify` component makes it possible to send notifications to a wide variety
1616
```yaml
1717
# Example configuration.yaml entry
1818
notify:
19-
platform: pushbullet
20-
# Optional name for the notify service
21-
name: paulus
22-
# api_key is a required config key by the pushbullet platform
23-
api_key: ABCDEFG
19+
- platform: pushbullet
20+
name: paulus
21+
api_key: ABCDEFG
2422
```
2523
2624
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
8280
}
8381
```
8482

85-
86-

‎source/_components/notify.message_bird.markdown

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,9 @@ To enable MessageBird notifications in your installation, add the following to y
1919
```yaml
2020
# Example configuration.yaml entry
2121
notify:
22-
platform: message_bird
23-
api_key: YOUR_API_KEY
24-
name: NOTIFIER_NAME
25-
sender: SENDER_NAME
22+
- name: NOTIFIER_NAME
23+
platform: message_bird
24+
api_key: YOUR_API_KEY
2625
```
2726
2827
Configuration variables:

‎source/_components/notify.nma.markdown

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,9 @@ To add NMA to your installation, add the following to your `configuration.yaml`
2222
```yaml
2323
# Example configuration.yaml entry
2424
notify:
25-
name: NOTIFIER_NAME
26-
platform: nma
27-
api_key: ABCDEFGHJKLMNOPQRSTUVXYZ
25+
- name: NOTIFIER_NAME
26+
platform: nma
27+
api_key: ABCDEFGHJKLMNOPQRSTUVXYZ
2828
```
2929
3030
Configuration variables:

‎source/_components/notify.pushbullet.markdown

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,9 @@ To enable Pushbullet notifications in your installation, add the following to yo
1919
```yaml
2020
# Example configuration.yaml entry
2121
notify:
22-
platform: pushbullet
23-
api_key: YOUR_API_KEY
24-
name: NOTIFIER_NAME
22+
- name: NOTIFIER_NAME
23+
platform: pushbullet
24+
api_key: YOUR_API_KEY
2525
```
2626
2727
Configuration variables:

‎source/_components/notify.pushetta.markdown

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,10 @@ To enable Pushetta notifications in your installation, add the following to your
2222
```yaml
2323
# Example configuration.yaml entry
2424
notify:
25-
name: NOTIFIER_NAME
26-
platform: pushetta
27-
api_key: YOUR_API_KEY
28-
channel_name: YOUR_CHANNEL_NAME
25+
- name: NOTIFIER_NAME
26+
platform: pushetta
27+
api_key: YOUR_API_KEY
28+
channel_name: YOUR_CHANNEL_NAME
2929
```
3030
3131
Configuration variables:

‎source/_components/notify.pushover.markdown

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,10 @@ To use Pushover notifications, add the following to your `configuration.yaml` fi
2222
```yaml
2323
# Example configuration.yaml entry
2424
notify:
25-
name: NOTIFIER_NAME
26-
platform: pushover
27-
api_key: ABCDEFGHJKLMNOPQRSTUVXYZ
28-
user_key: ABCDEFGHJKLMNOPQRSTUVXYZ
25+
- name: NOTIFIER_NAME
26+
platform: pushover
27+
api_key: ABCDEFGHJKLMNOPQRSTUVXYZ
28+
user_key: ABCDEFGHJKLMNOPQRSTUVXYZ
2929
```
3030
3131
Configuration variables:

‎source/_components/notify.rest.markdown

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -19,13 +19,9 @@ To enable the REST notification in your installation, add the following to your
1919
```yaml
2020
# Example configuration.yaml entry
2121
notify:
22-
name: NOTIFIER_NAME
23-
platform: rest
24-
resource: http://IP_ADDRESS/ENDPOINT
25-
method: GET
26-
message_param_name: MESSAGE_PARAMETER_NAME
27-
title_param_name: TITLE_PARAMETER_NAME
28-
target_param_name: TARGET_PARAMETER_NAME
22+
- name: NOTIFIER_NAME
23+
platform: rest
24+
resource: http://IP_ADDRESS/ENDPOINT
2925
```
3026
3127
Configuration variables:

‎source/_components/notify.sendgrid.markdown

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,11 @@ To enable notification emails via SendGrid in your installation, add the followi
1818
```yaml
1919
# Example configuration.yaml entry
2020
notify:
21-
name: NOTIFIER_NAME
22-
platform: sendgrid
23-
api_key: API_KEY
24-
sender: SENDER_EMAIL_ADDRESS
25-
recipient: YOUR_RECIPIENT
21+
- name: NOTIFIER_NAME
22+
platform: sendgrid
23+
api_key: API_KEY
24+
sender: SENDER_EMAIL_ADDRESS
25+
recipient: YOUR_RECIPIENT
2626
```
2727
2828
Configuration variables:

‎source/_components/notify.slack.markdown

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -26,12 +26,10 @@ To enable the slack notification in your installation, add the following to your
2626
```yaml
2727
# Example configuration.yaml entry
2828
notify:
29-
name: NOTIFIER_NAME
30-
platform: slack
31-
api_key: ABCDEFGHJKLMNOPQRSTUVXYZ
32-
default_channel: '#general'
33-
icon: ':robot_face:'
34-
username: 'Home-Assistant'
29+
- name: NOTIFIER_NAME
30+
platform: slack
31+
api_key: ABCDEFGHJKLMNOPQRSTUVXYZ
32+
default_channel: '#general'
3533
```
3634
3735
Configuration variables:

0 commit comments

Comments
 (0)