mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-22 00:36:49 +00:00
🚜 Merges/Redirects Pushbullet component pages (#9147)
This commit is contained in:
Klaas Schoute
Fabian Affolter
parent
8d20b8ee33
commit
9d708d5400
@ -1,124 +0,0 @@
|
||||
---
|
||||
layout: page
|
||||
title: "Pushbullet"
|
||||
description: "Instructions on how to add user notifications to Home Assistant."
|
||||
date: 2015-01-20 22:36
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: pushbullet.png
|
||||
ha_category: Notifications
|
||||
featured: true
|
||||
ha_release: 0.7
|
||||
---
|
||||
|
||||
The `pushbullet` notification platform sends messages to [Pushbullet](https://www.pushbullet.com/), a free service to send information between your phones, browsers, and friends.
|
||||
|
||||
To enable Pushbullet notifications in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
notify:
|
||||
- name: NOTIFIER_NAME
|
||||
platform: pushbullet
|
||||
api_key: YOUR_API_KEY
|
||||
```
|
||||
|
||||
{% configuration %}
|
||||
api_key:
|
||||
description: Enter the API key for Pushbullet. Go to [https://www.pushbullet.com/#settings/account](https://www.pushbullet.com/#settings/account) to retrieve your API key/access token.
|
||||
required: true
|
||||
type: string
|
||||
name:
|
||||
description: 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`.
|
||||
required: false
|
||||
default: notify
|
||||
type: string
|
||||
{% endconfiguration %}
|
||||
|
||||
### {% linkable_title Usage %}
|
||||
|
||||
Pushbullet is a notify platform and thus can be controlled by calling the notify service [as described here](/components/notify/). It will send a notification to all devices registered in the Pushbullet account. An optional **target** parameter can be given to Pushbullet to specify specific account's devices, contacts or channels.
|
||||
|
||||
Type | Prefix | Suffix | Example
|
||||
---- | ------ | ------ | -------
|
||||
Device | `device/` | Device nickname | `device/iphone`
|
||||
Channel | `channel/` | Channel tag | `channel/my_home`
|
||||
Email | `email/` | Contact's email address | `email/email@example.com`
|
||||
|
||||
If using targets, your own account's email address functions as 'send to all devices'. All targets are verified (if exists) before sending, except email.
|
||||
|
||||
#### {% linkable_title Example service payload %}
|
||||
|
||||
```json
|
||||
{
|
||||
"message": "A message for many people",
|
||||
"target": [
|
||||
"device/telephone",
|
||||
"email/hello@example.com",
|
||||
"channel/my_home"
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
To use notifications, please see the [getting started with automation page](/getting-started/automation/).
|
||||
|
||||
### {% linkable_title URL support %}
|
||||
|
||||
```yaml
|
||||
action:
|
||||
service: notify.NOTIFIER_NAME
|
||||
data:
|
||||
title: Send URL
|
||||
message: This is an url
|
||||
data:
|
||||
url: google.com
|
||||
```
|
||||
|
||||
- **url** (*Required*): Page URL to send with Pushbullet.
|
||||
|
||||
### {% linkable_title File support %}
|
||||
|
||||
```yaml
|
||||
action:
|
||||
service: notify.NOTIFIER_NAME
|
||||
data:
|
||||
title: Send file
|
||||
message: This is a file
|
||||
data:
|
||||
file: /path/to/my/file
|
||||
```
|
||||
|
||||
- **file** (*Required*): File to send with Pushbullet.
|
||||
|
||||
### {% linkable_title File URL support %}
|
||||
|
||||
```yaml
|
||||
action:
|
||||
service: notify.NOTIFIER_NAME
|
||||
data:
|
||||
title: Send file
|
||||
message: This is a file URL
|
||||
data:
|
||||
file_url: https://cdn.pixabay.com/photo/2014/06/03/19/38/test-361512_960_720.jpg
|
||||
```
|
||||
|
||||
- **file_url** (*Required*): File to send with Pushbullet.
|
||||
|
||||
### {% linkable_title Single target %}
|
||||
|
||||
```yaml
|
||||
action:
|
||||
service: notify.NOTIFIER_NAME
|
||||
data:
|
||||
title: "Send to one device"
|
||||
message: "This only goes to one specific device"
|
||||
target: device/DEVICE_NAME
|
||||
```
|
||||
|
||||
- **target**: Pushbullet device to recive the notification.
|
||||
|
||||
<p class='note'>
|
||||
Don't forget to [whitelist external directories](/docs/configuration/basic/), so Home Assistant has access to them.
|
||||
</p>
|
||||
@ -8,22 +8,32 @@ comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: pushbullet.png
|
||||
ha_category: Sensor
|
||||
ha_category:
|
||||
- Sensor
|
||||
- Notifications
|
||||
ha_release: 0.44
|
||||
ha_iot_class: Cloud Polling
|
||||
redirect_from:
|
||||
- /components/sensor.pushbullet/
|
||||
- /components/notify.pushbullet/
|
||||
---
|
||||
|
||||
There is currently support for the following device types within Home Assistant:
|
||||
|
||||
- [Sensor](#sensor)
|
||||
- [Notifications](#notifications)
|
||||
|
||||
### {% linkable_title Sensor %}
|
||||
|
||||
The `pushbullet` sensor platform reads messages from [Pushbullet](https://www.pushbullet.com/), a free service to send information between your phones, browsers, and friends. This sensor platform provides sensors that show the properties of the latest received Pushbullet notification mirror.
|
||||
|
||||
## {% linkable_title Setup %}
|
||||
### {% linkable_title Setup %}
|
||||
|
||||
Notification Mirroring allows users to see their Android device's notifications on their computer. It must be first enabled in the app and is currently only available on the Android platform. For more information, please see [this announcement](https://blog.pushbullet.com/2013/11/12/real-time-notification-mirroring-from-android-to-your-computer/) on the Pushbullet Blog.
|
||||
|
||||
Go to [https://www.pushbullet.com/#settings/account](https://www.pushbullet.com/#settings/account) to retrieve your API key/access token.
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
### {% linkable_title Configuration %}
|
||||
|
||||
To enable the Pushbullet sensor in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
@ -70,3 +80,115 @@ monitored_conditions:
|
||||
{% endconfiguration %}
|
||||
|
||||
All properties will be displayed as attributes. The properties array are just for logging the sensor readings for multiple properties.
|
||||
|
||||
## {% linkable_title Notifications %}
|
||||
|
||||
The `pushbullet` notification platform sends messages to [Pushbullet](https://www.pushbullet.com/), a free service to send information between your phones, browsers, and friends.
|
||||
|
||||
To enable Pushbullet notifications in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
notify:
|
||||
- name: NOTIFIER_NAME
|
||||
platform: pushbullet
|
||||
api_key: YOUR_API_KEY
|
||||
```
|
||||
|
||||
{% configuration %}
|
||||
api_key:
|
||||
description: Enter the API key for Pushbullet. Go to [https://www.pushbullet.com/#settings/account](https://www.pushbullet.com/#settings/account) to retrieve your API key/access token.
|
||||
required: true
|
||||
type: string
|
||||
name:
|
||||
description: 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`.
|
||||
required: false
|
||||
default: notify
|
||||
type: string
|
||||
{% endconfiguration %}
|
||||
|
||||
### {% linkable_title Usage %}
|
||||
|
||||
Pushbullet is a notify platform and thus can be controlled by calling the notify service [as described here](/components/notify/). It will send a notification to all devices registered in the Pushbullet account. An optional **target** parameter can be given to Pushbullet to specify specific account's devices, contacts or channels.
|
||||
|
||||
Type | Prefix | Suffix | Example
|
||||
---- | ------ | ------ | -------
|
||||
Device | `device/` | Device nickname | `device/iphone`
|
||||
Channel | `channel/` | Channel tag | `channel/my_home`
|
||||
Email | `email/` | Contact's email address | `email/email@example.com`
|
||||
|
||||
If using targets, your own account's email address functions as 'send to all devices'. All targets are verified (if exists) before sending, except email.
|
||||
|
||||
#### {% linkable_title Example service payload %}
|
||||
|
||||
```json
|
||||
{
|
||||
"message": "A message for many people",
|
||||
"target": [
|
||||
"device/telephone",
|
||||
"email/hello@example.com",
|
||||
"channel/my_home"
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
To use notifications, please see the [getting started with automation page](/getting-started/automation/).
|
||||
|
||||
### {% linkable_title URL support %}
|
||||
|
||||
```yaml
|
||||
action:
|
||||
service: notify.NOTIFIER_NAME
|
||||
data:
|
||||
title: Send URL
|
||||
message: This is an url
|
||||
data:
|
||||
url: google.com
|
||||
```
|
||||
|
||||
- **url** (*Required*): Page URL to send with Pushbullet.
|
||||
|
||||
### {% linkable_title File support %}
|
||||
|
||||
```yaml
|
||||
action:
|
||||
service: notify.NOTIFIER_NAME
|
||||
data:
|
||||
title: Send file
|
||||
message: This is a file
|
||||
data:
|
||||
file: /path/to/my/file
|
||||
```
|
||||
|
||||
- **file** (*Required*): File to send with Pushbullet.
|
||||
|
||||
### {% linkable_title File URL support %}
|
||||
|
||||
```yaml
|
||||
action:
|
||||
service: notify.NOTIFIER_NAME
|
||||
data:
|
||||
title: Send file
|
||||
message: This is a file URL
|
||||
data:
|
||||
file_url: https://cdn.pixabay.com/photo/2014/06/03/19/38/test-361512_960_720.jpg
|
||||
```
|
||||
|
||||
- **file_url** (*Required*): File to send with Pushbullet.
|
||||
|
||||
### {% linkable_title Single target %}
|
||||
|
||||
```yaml
|
||||
action:
|
||||
service: notify.NOTIFIER_NAME
|
||||
data:
|
||||
title: "Send to one device"
|
||||
message: "This only goes to one specific device"
|
||||
target: device/DEVICE_NAME
|
||||
```
|
||||
|
||||
- **target**: Pushbullet device to recive the notification.
|
||||
|
||||
<p class='note'>
|
||||
Don't forget to [whitelist external directories](/docs/configuration/basic/), so Home Assistant has access to them.
|
||||
</p>
|
||||
Loading…
x
Reference in New Issue
Block a user