jeena/home-assistant.github.io
1
0
Fork 0
Code Issues Pull requests Projects Packages Wiki Activity Actions

Update notify docs

Browse source
This commit is contained in:
Paulus Schoutsen 2015-11-15 23:30:46 -08:00
parent 81b4d8701c
commit 804aa8d9bc
2 changed files with 55 additions and 16 deletions
Download patch file Download diff file Expand all files Collapse all files

34
source/_components/notify.pushbullet.markdown
View file

@ -12,22 +12,44 @@ ha_category: Notifications
featured: true
---
[PushBullet](https://www.pushbullet.com/) is a free service to send information between your phones, browsers and friends.
Home Assistant currently supports the awesome [PushBullet](https://www.pushbullet.com/), a free service to send information between your phones, browsers and friends.
To add PushBullet to your installation, add the following to your `configuration.yaml` file:
### Configuration
```yaml
# Example configuration.yaml entry
notify:
name: NOTIFIER_NAME
platform: pushbullet
api_key: YOUR_API_KEY
# Optional
name: NOTIFIER_NAME
```
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*): Enter the API key for PushBullet. Go to https://www.pushbullet.com/ to retrieve your API key.
- **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`.
For more automation examples, see the [getting started with automation page]({{site_root}}/components/automation/).
### Usage
PushBullet is a notify platform and thus can be controlled by calling the notify service [as described here](/components/notify/). An optional **target** parameter can be given to PushBullet to specify one or many account's devices, contacts or channels to notify.
Type | Prefix | Suffix | Example
---- | ------ | ------ | -------
All devices | `device` | -- | `device`
Device | `device/` | Device nickname | `device/iphone`
Contact | `contact/` | Contact e-mail | `contact/email@example.com`
Channel | `channel/` | Channel tag | `channel/my_home`
#### Example service payload
```json
{
"message": "A message for many people",
"target": [
"device",
"contact/hello@example.com",
"channel/my_home"
]
}
```