mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-19 15:26:59 +00:00
Add config flow to pushbullet
(#24773)
Co-authored-by: Franck Nijhof <frenck@frenck.nl> Co-authored-by: Martin Hjelmare <marhje52@gmail.com>
This commit is contained in:
parent
92d7205f6c
commit
19842c3b03
@ -5,12 +5,15 @@ ha_category:
|
|||||||
- Notifications
|
- Notifications
|
||||||
- Sensor
|
- Sensor
|
||||||
ha_release: 0.44
|
ha_release: 0.44
|
||||||
|
ha_config_flow: true
|
||||||
ha_iot_class: Cloud Polling
|
ha_iot_class: Cloud Polling
|
||||||
ha_domain: pushbullet
|
ha_domain: pushbullet
|
||||||
ha_platforms:
|
ha_platforms:
|
||||||
- notify
|
- notify
|
||||||
- sensor
|
- sensor
|
||||||
ha_integration_type: integration
|
ha_integration_type: integration
|
||||||
|
ha_codeowners:
|
||||||
|
- '@engrbm87'
|
||||||
---
|
---
|
||||||
|
|
||||||
There is currently support for the following device types within Home Assistant:
|
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>
|
</div>
|
||||||
|
|
||||||
### Sensor
|
## Prerequisites
|
||||||
|
|
||||||
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
|
|
||||||
|
|
||||||
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.
|
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.
|
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
|
The following sensors are created after setting up the integration:
|
||||||
# Example configuration.yaml entry
|
|
||||||
sensor:
|
|
||||||
- platform: pushbullet
|
|
||||||
api_key: YOUR_API_KEY
|
|
||||||
monitored_conditions:
|
|
||||||
- body
|
|
||||||
```
|
|
||||||
|
|
||||||
{% configuration %}
|
- Application name: The application sending the push.
|
||||||
api_key:
|
- Body: The notification message body.
|
||||||
description: Your Pushbullet API key.
|
- Notification ID: The ID of the notification.
|
||||||
required: true
|
- Tag: The notification tag (if the application sending supports it).
|
||||||
type: string
|
- Package name: The name of the sender’s package.
|
||||||
monitored_conditions:
|
- Receiver Email: The email of the push’s target.
|
||||||
description: Properties of the push to monitor.
|
- Sender Email: The email of the sender.
|
||||||
required: false
|
- Sender device ID: The ID of the sender’s device.
|
||||||
default: "`body` and `title`"
|
- Title: The title of the push.
|
||||||
type: list
|
- Type: The type of the push.
|
||||||
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 %}
|
|
||||||
|
|
||||||
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
|
## 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.
|
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 %}
|
|
||||||
|
|
||||||
### Usage
|
### Usage
|
||||||
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user