Support for Apple Push Notification Service #3756
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
balloobbot
reviewed
Oct 8, 2016
| hass = get_test_home_assistant() | ||
| self.assertFalse(notify.setup(hass, config)) | ||
|
|
||
| def test_register_new_device(self): |
There was a problem hiding this comment.
- D102: Missing docstring in public method
|
How can I re-run the build? Seems like a random failure. |
|
Is this the successor of #2984? |
|
Yes |
|
awesome work here. you and @robbiet480 should chat, potentially. |
|
@robbiet480 do you want me to do anything else to this or is it ok to merge? |
|
I just skimmed this, it looks fine. Need to take a closer look at the code first though. Will try my best to get that done today. |
pvizeli
requested changes
Oct 16, 2016
| def get_service(hass, config): | ||
| """Return push service.""" | ||
| descriptions = load_yaml_config_file( | ||
| os.path.join(os.path.dirname(__file__), 'apns_services.yaml')) |
There was a problem hiding this comment.
Dont use a own service yaml. Add to service.yaml like other platform do...
balloob
reviewed
Oct 16, 2016
| DOMAIN = "apns" | ||
| APNS_DEVICES = "apns.yaml" | ||
| DEVICE_TRACKER_DOMAIN = "device_tracker" | ||
| SERVICE_REGISTER = "register" |
There was a problem hiding this comment.
Can you rename it apns_register to indicate that it is part of the apns platform?
pvizeli
approved these changes
Oct 17, 2016
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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 and you will need to create an App to receive push notifications. For more information see the apple developer documentation.
Pull request in home-assistant.io with documentation (if applicable): home-assistant/home-assistant.io#905
Example entry for
configuration.yaml(if applicable):Configuration Variables:
name: The name of the app.
sandbox: If true notifications will be sent to the sandbox (test) notification service.
cert_file: The certificate to use to authenticate with the APNS service.
Usage:
The APNS platform will register two services, notify/[app_name] and apns/[app_name].
apns/app_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 its id during startup, the id will be stored in the [app_name]_apns.yaml.
See didRegisterForRemoteNotificationsWithDeviceToken in the apple developer documentation for more information.
notify/app_name
This service will send messages to a registered device. The following parameters can be used:
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 device_tracking_id added to the [app_name]_apns.yaml file. If this id matches a device in known_devices.yaml its state will be tracked.
data:
badge: The number to display as the badge of the app.
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
content_available: Provide this key with a value of 1 to indicate that new content is available.
Checklist:
If user exposed functionality or configuration variables are added/changed:
If the code communicates with devices, web services, or third-party tools:
toxrun successfully. Your PR cannot be merged unless tests passREQUIREMENTSvariable (example).requirements_all.txtby runningscript/gen_requirements_all.py..coveragerc.If the code does not interact with devices:
toxrun successfully. Your PR cannot be merged unless tests pass