Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation for Local Push #539

Merged
merged 4 commits into from
Jun 20, 2021
Merged

Documentation for Local Push #539

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
e8d58e9
Documentation for Local Push
zacwest Jun 7, 2021
d2075d0
Fix broken link
zacwest Jun 7, 2021
b1cd518
Local push redirect
zacwest Jun 20, 2021
93c7376
Document configuration and statuses
zacwest Jun 20, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions docs/core/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -306,6 +306,13 @@ Not all features are supported by Android at the moment but eventually most feat
<td></td>
<td></td>
</tr>
<tr>
<td><a href="/docs/notifications/notification-local">Local Push</a></td>
<td></td>
<td></td>
<td>✅</td>
<td>✅</td>
</tr>
<tr>
<td><a href="/docs/notifications/notifications-basic">Message</a></td>
<td>✅</td>
Expand Down
28 changes: 28 additions & 0 deletions docs/notifications/local.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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 (<span class="beta">BETA</span>) |
| ![macOS](/assets/macOS.svg) | 2021.7 (<span class="beta">BETA</span>) |

:::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).
4 changes: 3 additions & 1 deletion sidebars.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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',
Expand Down