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 15:26:59 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add ha_release and minor updates

Browse Source
This commit is contained in:
Fabian Affolter 2016-10-22 10:41:43 +02:00
parent 00a95156a3
commit 1158adb408
No known key found for this signature in database
GPG Key ID: DDF3D6F44AAB1336
1 changed files with 8 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -8,21 +8,19 @@ comments: false
sharing: true sharing: true
footer: true footer: true
ha_category: Notifications ha_category: Notifications
ha_release: 0.31
--- ---
The `APNS` platform uses the Apple Push Notification service (APNS) to deliver notifications from Home Assistant. The `apns` platform uses the Apple Push Notification service (APNS) to deliver notifications from Home Assistant.
To use the APNS service you will need an apple developer account 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.
and you will need to create an App to receive push notifications.
For more information see the apple developer documentation.
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
notify: notify:
name: NOTIFIER_NAME name: NOTIFIER_NAME
platform: apns platform: apns
sandbox: true or false
cert_file: cert_file.pem cert_file: cert_file.pem
``` ```
@ -32,11 +30,11 @@ Configuration variables:
- **sandbox** (*Optional*): If true notifications will be sent to the sandbox (test) notification service. Default false. - **sandbox** (*Optional*): If true notifications will be sent to the sandbox (test) notification service. Default false.
- **cert_file** (*Required*): The certificate to use to authenticate with the APNS service. - **cert_file** (*Required*): The certificate to use to authenticate with the APNS service.
The APNS platform will register two services, `notify.NOTIFIER_NAME` and `apns.NOTIFIER_NAME`. The APNS platform will register two services, `notify.NOTIFIER_NAME` and `apns.NOTIFIER_NAME`.
### apns.NOTIFIER_NAME ### apns.NOTIFIER_NAME
This service will register device id's 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`. This service will register device id's 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. 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.
@ -46,10 +44,10 @@ This service will send messages to a registered device. The following parameters
- **message**: The message to send - **message**: The message to send
- **target**: The desired state of the device, only devices that match the state will receive messages. To enable state tracking a registered device must have a `tracking_device_id` attribute added to the `[NOTIFIER_NAME]_apns.yaml` file. If this id matches a device in known_devices.yaml the device state will be tracked. - **target**: The desired state of the device, only devices that match the state will receive messages. To enable state tracking a registered device must have a `tracking_device_id` attribute added to the `[NOTIFIER_NAME]_apns.yaml` file. If this ID matches a device in `known_devices.yaml` the device state will be tracked.
- **data**: - **data**:
* **badge**: The number to display as the badge of the app ic * **badge**: The number to display as the badge of the app ic.
* **sound**: The name of a sound file in the app bundle or in the Library/Sounds folder. * **sound**: The name of a sound file in the app bundle or in the Library/Sounds folder.
* **category**: Provide this key with a string value that represents the identifier property of the UIMutableUserNotificationCategory * **category**: Provide this key with a string value that represents the identifier property of the UIMutableUserNotificationCategory.
* **content_available**: Provide this key with a value of 1 to indicate that new content is available. * **content_available**: Provide this key with a value of 1 to indicate that new content is available.