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-15 05:16:49 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update Apns notify component configuration (#7239)

Browse Source 
* Update Apns notify component configuration

* Add titles

* Fix typos
This commit is contained in:
Klaas Schoute 2018-10-29 23:23:31 +01:00 committed by Fabian Affolter
parent c943546a62
commit 1a38f41c64
1 changed files with 27 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
source/_components/notify.apns.markdown
View File

@ -11,11 +11,16 @@ ha_category: Notifications
ha_release: 0.31
---
The `apns` platform uses the Apple Push Notification service (APNS) to deliver notifications from Home Assistant.
## {% linkable_title Setup %}
To use the APNS service you will need an Apple developer account and you will need to create an app to receive push notifications. For more information, see the Apple developer documentation.
## {% linkable_title Configuration %}
To enable APNS notifications, add the following lines to your `configuration.yaml`:
```yaml
# Example configuration.yaml entry
notify:
@ -25,22 +30,35 @@ notify:
topic: topic
```
Configuration variables:
- **name** (*Required*): The name of the notifier. The notifier will bind to the service `notify.NOTIFIER_NAME`.
- **cert_file** (*Required*): The certificate to use to authenticate with the APNS service.
- **topic** (*Required*): The app bundle ID specified in the certificate.
- **sandbox** (*Optional*): If true notifications will be sent to the sandbox (test) notification service. Default false.
{% configuration %}
name:
description: he name of the notifier. The notifier will bind to the service `notify.NOTIFIER_NAME`.
required: true
type: string
cert_file:
description: The certificate to use to authenticate with the APNS service.
required: true
type: string
topic:
description: The app bundle ID specified in the certificate.
required: true
type: string
sandbox:
description: If true notifications will be sent to the sandbox (test) notification service.
required: false
default: false
type: boolean
{% endconfiguration %}
The APNS platform will register two services, `notify.NOTIFIER_NAME` and `notify.apns_NOTIFIER_NAME`.
### notify.apns_NOTIFIER_NAME
### {% linkable_title notify.apns_NOTIFIER_NAME %}
This service will register device IDs with Home Assistant. In order to receive a notification a device must be registered. The app on the device can use this service to send an ID to Home Assistant during startup, the ID will be stored in `[NOTIFIER_NAME]_apns.yaml`.
See `didRegisterForRemoteNotificationsWithDeviceToken` in the [Apple developer documentation](https://developer.apple.com/library/ios/documentation/UIKit/Reference/UIApplicationDelegate_Protocol/#//apple_ref/occ/intfm/UIApplicationDelegate/application:didRegisterForRemoteNotificationsWithDeviceToken:) for more information about how to obtain a device ID.
### notify.NOTIFIER_NAME
### {% linkable_title notify.NOTIFIER_NAME %}
This service will send messages to a registered device. The following parameters can be used: