jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-19 07:17:14 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add config flow to pushbullet (#24773)

Browse Source 
Co-authored-by: Franck Nijhof <frenck@frenck.nl>
Co-authored-by: Martin Hjelmare <marhje52@gmail.com>
This commit is contained in:
Rami Mosleh 2022-11-03 13:44:20 +02:00 committed by GitHub
parent 92d7205f6c
commit 19842c3b03
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 19 additions and 71 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

90
source/_integrations/pushbullet.markdown
View File

@ -5,12 +5,15 @@ ha_category:
- Notifications
- Sensor
ha_release: 0.44
ha_config_flow: true
ha_iot_class: Cloud Polling
ha_domain: pushbullet
ha_platforms:
- notify
- sensor
ha_integration_type: integration
ha_codeowners:
- '@engrbm87'
---
There is currently support for the following device types within Home Assistant:
@ -24,89 +27,34 @@ The free tier is [limited](https://docs.pushbullet.com/#push-limit) to 500 pushe
</div>
### 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.
### Setup
## Prerequisites
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.
### Configuration
{% include integrations/config_flow.md %}
To enable the Pushbullet sensor in your installation, add the following to your `configuration.yaml` file:
## Sensors
```yaml
# Example configuration.yaml entry
sensor:
- platform: pushbullet
api_key: YOUR_API_KEY
monitored_conditions:
- body
```
The following sensors are created after setting up the integration:
{% configuration %}
api_key:
description: Your Pushbullet API key.
required: true
type: string
monitored_conditions:
description: Properties of the push to monitor.
required: false
default: "`body` and `title`"
type: list
keys:
application_name:
description: The application sending the push.
body:
description: Body of the message.
notification_id:
description: ID of the notification.
notification_tag:
description: Tag (if the application sending supports it).
package_name:
description: Name of the sender's package.
receiver_email:
description: The email of the push's target.
sender_email:
description: The sender of the push.
source_device_iden:
description: ID of the sender's device.
title:
description: Title of the push.
type:
description: Type of push.
{% endconfiguration %}
- Application name: The application sending the push.
- Body: The notification message body.
- Notification ID: The ID of the notification.
- Tag: The notification tag (if the application sending supports it).
- Package name: The name of the sender’s package.
- Receiver Email: The email of the push’s target.
- Sender Email: The email of the sender.
- Sender device ID: The ID of the sender’s device.
- Title: The title of the push.
- Type: The type of the push.
All properties will be displayed as attributes. The properties array are just for logging the sensor readings for multiple properties.
"Body" and "Title" are enabled by default. The rest can be enabled from the UI.
## 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. The free tier is [limited](https://docs.pushbullet.com/#push-limit) to 500 pushes per month.
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 %}
The Pushbullet notification platform sends messages to [Pushbullet](https://www.pushbullet.com/), a free service to send information between your phones, browsers, and friends. The free tier is [limited](https://docs.pushbullet.com/#push-limit) to 500 pushes per month.
### Usage