Updated notifier documentation.

1) Added missing notifiers to general notifier page and rearranged
notifiers to be in alphabetical order.
2) Added documentation about new name property for notifiers and how it
works into the service call.
This commit is contained in:
Ryan Kraus 2015-08-19 23:54:10 -04:00
parent c0d6ab9105
commit 0b4c6b188b
11 changed files with 59 additions and 14 deletions

View File

@ -25,7 +25,7 @@ automation:
state_to: 'below_horizon'
# Action to be done when trigger activated
execute_service: notify.notify
execute_service: notify.NOTIFIER_NAME
service_data: {"message":"The sun has set"}
```
@ -105,7 +105,7 @@ Currently the only supported action is calling a service. Services are what devi
service_data: {"rgb_color": [255, 0, 0]}
# Notify the user
execute_service: notify.notify
execute_service: notify.NOTIFIER_NAME
service_data: {"message":"YAY"}
```
@ -121,7 +121,7 @@ automation:
state_from: 'above_horizon'
state_to: 'below_horizon'
execute_service: notify.notify
execute_service: notify.NOTIFIER_NAME
service_data: {"message":"The sun has set"}
automation 2:
@ -147,5 +147,5 @@ automation 3:
```
<p class='note'>
All configuration entries have to be sequential. If you have <code>automation:</code>, <code>automation 2:</code> and <code>automation 4:</code> then the last one will not be processed.
All configuration entries have to be sequential. If you have <code>automation:</code>, <code>automation 2:</code> and <code>automation 4:</code> then the last one will not be processed.
</p>

View File

@ -17,11 +17,16 @@ 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: 1 or 0
```
Setting `timestamp` to 1 adds a timestamp to every entry.
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`.
Setting `timestamp` to 1 adds a timestamp to every entry.
To use notifications, please see the [getting started with automation page]({{site_root}}/components/automation.html).

View File

@ -17,6 +17,7 @@ The Instapush [Getting Started page](https://instapush.im/home/start/) will guid
```yaml
# Example configuration.yaml entry
notify:
name: NOTIFIER_NAME
platform: instapush
# Get those by creating a new application, event, and tracker on https://instapush.im
api_key: ABCDEFGHJKLMNOPQRSTUVXYZ
@ -25,8 +26,12 @@ notify:
tracker: ABCDEFGHJKLMNOPQRSTUVXYZ
```
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`.
To retrieve those values for existing settings, log into your account at https://instapush.im and go to your **Dashboard**. Then click **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*.
It's easy to test your Instapush setup outside of Home Assistant. Assuming you have an event *notification* and a tracker *home-assistant*, just fire a request and check the Instapush dashboard for a new entry.
```bash

View File

@ -13,13 +13,15 @@ One of the things most people want at some point in their home automation is to
Home Assistant currently supports a wide range of services for notifications:
- [E-Mail](/components/notify.smtp.html)
- [File](/components/notify.file.html)
- [Instapush](/components/notify.instapush.html)
- [Jabber (XMPP)](/components/notify.xmpp.html)
- [Notify My Android (NMA)](/components/notify.nma.html)
- [PushBullet](/components/notify.pushbullet.html)
- [PushOver](/components/notify.pushover.html)
- [E-Mail](/components/notify.smtp.html)
- [Slack](/components/notify.slack.html)
- [Syslog](/components/notify.syslog.html)
- [Jabber (XMPP)](/components/notify.xmpp.html)
### Automation example
@ -34,7 +36,7 @@ automation:
state_from: above_horizon
state_to: below_horizon
execute_service: notify.notify
execute_service: notify.NOTIFIER_NAME
service_data: {"message":"YAY"}
```

View File

@ -17,9 +17,14 @@ To add NMA to your installation, add the following to your `configuration.yaml`
```yaml
# Example configuration.yaml entry
notify:
name: NOTIFIER_NAME
platform: nma
# Get this by registering a new application on http://www.notifymyandroid.com/
api_key: ABCDEFGHJKLMNOPQRSTUVXYZ
```
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`.
To use notifications, please see the [getting started with automation page]({{site_root}}/components/automation.html).

View File

@ -14,10 +14,15 @@ Home Assistant currently supports the awesome [PushBullet](https://www.pushbulle
To add PushBullet to your installation, add the following to your `configuration.yaml` file:
```
```yaml
notify:
name: NOTIFIER_NAME
platform: pushbullet
api_key: YOUR_API_KEY
```
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`.
For more automation examples, see the [getting started with automation page]({{site_root}}/components/automation.html).

View File

@ -17,6 +17,7 @@ To use PushOver notifications, add the following to your `configuration.yaml` fi
```yaml
# Example configuration.yaml entry
notify:
name: NOTIFIER_NAME
platform: pushover
# Get this by registering a new application on https://pushover.net
api_key: ABCDEFGHJKLMNOPQRSTUVXYZ
@ -24,6 +25,9 @@ notify:
user_key: ABCDEFGHJKLMNOPQRSTUVXYZ
```
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`.
### Automation example
@ -38,7 +42,7 @@ automation:
state_from: above_horizon
state_to: below_horizon
execute_service: notify.notify
execute_service: notify.NOTIFIER_NAME
service_data: {"message":"YAY"}
```

View File

@ -19,8 +19,12 @@ 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'
```
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`.

View File

@ -17,6 +17,7 @@ To enable notification by e-mail in your installation, add the following to your
```yaml
# Example configuration.yaml entry
notify:
name: NOTIFIER_NAME
platform: mail
server: MAIL_SERVER
port: YOUR_SMTP_PORT
@ -27,9 +28,13 @@ notify:
recipient: YOUR_RECIPIENT
```
This platform is fragile and not able to catch all exceptions in a smart way because of the large number of possible configuration combinations.
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`.
A combination that will work properly is port 587 and STARTTLS. It's recommanded to enable STARTTLS, if possible.
This platform is fragile and not able to catch all exceptions in a smart way because of the large number of possible configuration combinations.
A combination that will work properly is port 587 and STARTTLS. It's recommanded to enable STARTTLS, if possible.
Keep in mind that if the password contains a colon, it needs to be wrapped in apostrophes in the `configuration.yaml` file.

View File

@ -17,12 +17,17 @@ 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
```
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`.
The table contains values to use in your `configuration.yaml` file.
| facility | option | priority |

View File

@ -15,12 +15,17 @@ 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
```
All Jabber IDs (JID) must include the domain. Make sure that the password matches the account provided as sender.
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`.
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]({{site_root}}/components/automation.html).