Add config flow to simplepush documentation (#23175)

* Add config flow to simplepush documentation

* Tweak

Co-authored-by: Franck Nijhof <frenck@frenck.nl>
This commit is contained in:
Rami Mosleh 2022-06-24 09:43:06 +03:00 committed by GitHub
parent aef6ebe9dd
commit ad8a07bc67
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -5,6 +5,7 @@ ha_category:
- Notifications - Notifications
ha_iot_class: Cloud Polling ha_iot_class: Cloud Polling
ha_release: 0.29 ha_release: 0.29
ha_config_flow: true
ha_domain: simplepush ha_domain: simplepush
ha_platforms: ha_platforms:
- notify - notify
@ -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. 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: {% include integrations/config_flow.md %}
```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 %}
To test if the service works, just send a message with `curl` from the command-line. To test if the service works, just send a message with `curl` from the command-line.
```bash ```bash
curl 'https://api.simplepush.io/send/device_key/title/message' 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/). To use notifications, please see the [getting started with automation page](/getting-started/automation/).