034c831324
* Persistant changed to persistent * Added log_attributes to the config documentation for statsd (#625) * Fix AsusWRT docs to prevent SSH key confusion (#623) pxssh is expecting the path to a private key, not a public key * add yahoo weather support (#621) * add yahoo weather * update with woeid not longer required * Doc for simplisafe alarm (#613) * Minor fixes * Rename the blog post for 0.24 * Initial blog post for 0.24 * Update sensor.apcupsd docs to reflect changes (#617) * Update sensor.apcupsd docs to reflect changes * Remove "type:" from configuration * Add apcupsd sensor breaking change * Added samsung models to the list of supported Samsung Smart TV's (#630) * Add IMAP sensor docs * Add IMAP sensor * add joaoapps join component and platform. (#633) * Add join * Added documentation of the KNX component (#611) * Added set_brightness to website docs. (#582) * Added configuration for card order to customize docs * Added configuration options to docs for the set_brightness command. * Revert "Added configuration for card order to customize docs" This reverts commit bd310fbd115c76bc49d994fff4ff3e1a0d0e9540. * Add new contributors * Add TP-Link smart plug docs * Sync with PR * update service (#634) * Move KNX docs to right folder * Fix typos and layout * Add missing KNX logo * Fix logo name * Fix category * Revert "Added set_brightness to website docs." (#636) * Add initial KNX docs for binary sensors and switches * Update title, desc, and date * Rename blog post * Update for 0.24 * pyhomematic update 0.1.9 * add example * Example config (#638) * Added dynamic entity tracking documentation (#641) * Change ordering * Added dynamic entity tracking documentation * Add more details * Add sqlalchemy as dep * Add various db_url * Added bah2830 configuration (#644) * update media_player.markdown (#643) * Rename release blog post * Add CARTO * Hide sensor.imap until stable * Typo edits (#642) * Update demo * Minor tweaking * Add additional example * Add simple example for renaming * Make it raw * Update camera.rpi_camera.markdown (#537) * Add link to binary version * Fix indent * Minor change for #537 * Update date
59 lines
2.6 KiB
Markdown
59 lines
2.6 KiB
Markdown
---
|
|
layout: page
|
|
title: "Notifications"
|
|
description: "Instructions how to add user notifications to Home Assistant."
|
|
date: 2015-01-20 22:36
|
|
sidebar: true
|
|
comments: false
|
|
sharing: true
|
|
footer: true
|
|
---
|
|
|
|
The `notify` component makes it possible to send notifications to a wide variety of platforms. Please check the sidebar for a full list of platforms that are supported.
|
|
|
|
## {% linkable_title Configuration %}
|
|
|
|
```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
|
|
```
|
|
|
|
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.
|
|
|
|
### {% linkable_title Service %}
|
|
|
|
Once loaded, the `notify` platform will expose a service that can be called to send notifications.
|
|
|
|
| Service data attribute | Optional | Description |
|
|
| ---------------------- | -------- | ----------- |
|
|
| `message` | no | Body of the notification.
|
|
| `title` | yes | Title of the notification. Default is `Home Assistant`.
|
|
| `target` | yes | Some platforms will allow specifying a recipient that will receive the notification. See your platform page if it is supported.
|
|
| `data` | yes | On platforms who have extended functionality. See your platform page if it is supported.
|
|
|
|
The notification component supports specifying [templates](/topics/templating/) for both the `message` and the `title`. This will allow you to use the current state of Home Assistant in your notifications.
|
|
|
|
In an [action](https://home-assistant.io/getting-started/automation-action/) of your [automation setup](/getting-started/automation/) it could look like this with a customized subject.
|
|
|
|
```yaml
|
|
action:
|
|
service: notify.notify
|
|
data:
|
|
message: "Your message goes here"
|
|
title: "Custom subject"
|
|
```
|
|
|
|
### {% linkable_title Test if it works %}
|
|
|
|
A simple way to test if you have set up your notify platform correctly is to use <img src='/images/screenshots/developer-tool-services-icon.png' alt='service developer tool icon' class="no-shadow" height="38" /> **Services** from the **Developer Tools**. Choose your service (*notify/xyz*) from the list of **Available services:** and enter something like the sample below into the **Service Data** field and hit **CALL SERVICE**.
|
|
|
|
```json
|
|
{
|
|
"message": "The sun is {% raw %}{% if is_state('sun.sun', 'above_horizon') %}up{% else %}down{% endif %}{% endraw %}!"
|
|
}
|
|
```
|