From e8d58e9d2dc8a44005b3cc083effa6941f73c66a Mon Sep 17 00:00:00 2001 From: Zac West Date: Sun, 6 Jun 2021 18:36:02 -0700 Subject: [PATCH 1/4] Documentation for Local Push --- docs/core/index.md | 7 +++++++ docs/notifications/local.md | 28 ++++++++++++++++++++++++++++ sidebars.js | 4 +++- 3 files changed, 38 insertions(+), 1 deletion(-) create mode 100644 docs/notifications/local.md diff --git a/docs/core/index.md b/docs/core/index.md index a83b21bee1d..235125031fe 100644 --- a/docs/core/index.md +++ b/docs/core/index.md @@ -306,6 +306,13 @@ Not all features are supported by Android at the moment but eventually most feat + + Local Push + + + ✅ + ✅ + Message ✅ diff --git a/docs/notifications/local.md b/docs/notifications/local.md new file mode 100644 index 00000000000..7fc66a2248e --- /dev/null +++ b/docs/notifications/local.md @@ -0,0 +1,28 @@ +--- +title: "Local Push" +id: "notification-local" +--- + +Local Push uses the [WebSocket API](https://developers.home-assistant.io/docs/api/websocket) to deliver notifications to your device instead of using Apple's Push Notification Service or Google's Firebase Cloud Messaging. + +| Platform | Version | +| -------- | ------- | +| ![iOS](/assets/iOS.svg) | 2021.7 (BETA) | +| ![macOS](/assets/macOS.svg) | 2021.7 (BETA) | + +:::info +Local Push requires HA core-2021.6 or later in combination with a supported platform above. +::: + +## Requirements + +![iOS](/assets/iOS.svg) has a few limitations: + +1. Local Push will only occur when connected via Internal URL, and requires configuring SSIDs to consider internal. This is an Operating System limitation as this feature is designed for low or minimal connectivity situations. +2. Although small, battery usage will be increased by a small amount when Local Push is enabled as it maintains an ongoing connection to your HA server. You can disable it in the connection settings for your server. + +![macOS](/assets/macOS.svg) will always maintain a Local Push connection as long as the app is running and has no additional battery impact. + +## Rate limits + +Notifications delivered via Local Push do not count against [Rate Limits](details.md). diff --git a/sidebars.js b/sidebars.js index a3c85a295fd..83d62ddccce 100644 --- a/sidebars.js +++ b/sidebars.js @@ -31,7 +31,9 @@ module.exports = { 'notifications/notification-details', 'notifications/notification-cleared', 'notifications/notification-commands', - 'notifications/notification-sounds'], + 'notifications/notification-sounds', + 'notifications/notification-local', + ], 'Integrations': [ 'integrations/integrations', 'integrations/android-power-menu', From d2075d046cb372cb03c666910d09b09073219f4f Mon Sep 17 00:00:00 2001 From: Zac West Date: Sun, 6 Jun 2021 18:45:49 -0700 Subject: [PATCH 2/4] Fix broken link --- docs/core/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/core/index.md b/docs/core/index.md index 235125031fe..93e0c57ec3c 100644 --- a/docs/core/index.md +++ b/docs/core/index.md @@ -307,7 +307,7 @@ Not all features are supported by Android at the moment but eventually most feat - Local Push + Local Push ✅ From b1cd518269ae8b2a8b5623167e6098aa90fd16fd Mon Sep 17 00:00:00 2001 From: Zac West Date: Sat, 19 Jun 2021 23:11:58 -0700 Subject: [PATCH 3/4] Local push redirect --- static/_redirects | 1 + 1 file changed, 1 insertion(+) diff --git a/static/_redirects b/static/_redirects index 1157d271d71..740724ff478 100644 --- a/static/_redirects +++ b/static/_redirects @@ -22,6 +22,7 @@ /app/mac/latest https://github.com/home-assistant/iOS/releases/latest /app/ios/notifications-sounds /docs/notifications/notification-sounds /app/ios/notifications /docs/notifications/notifications-basic +/app/ios/local-push /docs/notifications/notification-local # Documentation restructuring redirects From 93c7376e42aef377d3450b5f583ac2942035c9d7 Mon Sep 17 00:00:00 2001 From: Zac West Date: Sat, 19 Jun 2021 23:47:38 -0700 Subject: [PATCH 4/4] Document configuration and statuses --- docs/notifications/local.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/docs/notifications/local.md b/docs/notifications/local.md index 7fc66a2248e..a91ab18beac 100644 --- a/docs/notifications/local.md +++ b/docs/notifications/local.md @@ -26,3 +26,19 @@ Local Push requires HA core-2021.6 or later in combination with a supported plat ## Rate limits Notifications delivered via Local Push do not count against [Rate Limits](details.md). + +## Configuration + +![iOS](/assets/iOS.svg) can disable Local Push by editing the internal connection settings for the server. Go to App Configuration, tap on the server row, then tap Internal URL. + +![macOS](/assets/macOS.svg) does not have an option to disable Local Push, see requirements above for more information. + +## Viewing Status + +You can view the status of Local Push under App Configuration in the Notifications section. This will show one of a few statuses: + +* Disabled, when toggled off by the connection setting or not currently on the internal network. +* Unsupported, when the iOS version does not support Local Push. +* Unavailable, when the core version does not support Local Push. +* Establishing, when it is initially connecting to the server. +* Available, when it is connected and ready for pushes. The number after indicates the number of messages received since the connection began, which can be useful for debugging.