Skip to content

Add config flow to simplepush documentation #23175

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
MartinHjelmare merged 2 commits into from
Jun 24, 2022
Merged

Add config flow to simplepush documentation #23175

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a99995f
Add config flow to simplepush documentation
engrbm87 Jun 22, 2022
f65b54e
Tweak
frenck Jun 22, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 5 additions & 32 deletions source/_integrations/simplepush.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ ha_category:
- Notifications
ha_iot_class: Cloud Polling
ha_release: 0.29
ha_config_flow: true
ha_domain: simplepush
ha_platforms:
- notify
Expand All @@ -13,43 +14,15 @@ ha_integration_type: integration

The `simplepush` platform uses [Simplepush](https://simplepush.io/) to delivery notifications from Home Assistant to your Android device. Unlike similar apps the Simplepush app requires no registration.

To add Simplepush to your installation, add the following to your `configuration.yaml` file:

```yaml
# Example configuration.yaml entry
notify:
- name: NOTIFIER_NAME
platform: simplepush
device_key: ABCDE
```

{% configuration %}
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
type: string
device_key:
description: The device key of your device.
required: true
type: string
event:
description: The event for the events.
required: false
type: string
password:
description: The password of the encryption used by your device.
required: inclusive
type: string
salt:
description: The salt used by your device.
required: inclusive
type: string
{% endconfiguration %}
{% include integrations/config_flow.md %}

To test if the service works, just send a message with `curl` from the command-line.

```bash
curl 'https://api.simplepush.io/send/device_key/title/message'
```
## Notifications

Simplepush can send a notification by calling the [`notify` service](/integrations/notify/). You can specify the `event` under the `data` key. This will override the event configured in YAML when imported.

To use notifications, please see the [getting started with automation page](/getting-started/automation/).