-
-
Notifications
You must be signed in to change notification settings - Fork 350
Add UnifiedPush documentation #1202
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.
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
Open
lone-faerie
wants to merge
2
commits into
home-assistant:master
Choose a base branch
from
lone-faerie:master
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| --- | ||
| title: "UnifiedPush" | ||
| id: "notification-unifiedpush" | ||
| --- | ||
| <span class='beta'>BETA</span> | ||
|
|
||
| [UnifiedPush](https://unifiedpush.org/) is a decentralized system to deliver notifications to your device instead of using Google's Firebase Cloud Messaging. | ||
|
|
||
| | Platform | Version | | ||
| | -------- | ------- | | ||
| |  | 2025.3 | | ||
|
|
||
| :::info | ||
| UnifiedPush is not supported on Apple devices as they do not support running services in the background | ||
| ::: | ||
|
|
||
| ## Requirements | ||
|
|
||
|  requires a UnifiedPush distributor to be installed, such as [ntfy](https://play.google.com/store/apps/details?id=io.heckel.ntfy) or [Sunup](https://f-droid.org/en/packages/org.unifiedpush.distributor.sunup/) and the distributor app should be exempted from battery optimization. | ||
|
|
||
| ## Rate limits | ||
|
|
||
| Notifications delivered via UnifiedPush may be rate limited by the selected server, independent of Home Assistant's [Rate Limits](https://companion.home-assistant.io/docs/notifications/notification-details). | ||
|
|
||
| ## Configuration | ||
|
|
||
|  can configure UnifiedPush settings in [Settings](https://my.home-assistant.io/redirect/config/) then Companion App and tap UnifiedPush in the Notifications section, then select the distributor app to use, or `Disabled` to disable UnifiedPush. Some UnifiedPush distributors allow for the use of a custom server, which can be configured from within the distributor app. |
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,85 +1,86 @@ | ||
| /** | ||
| * Copyright (c) 2017-present, Facebook, Inc. | ||
| * | ||
| * This source code is licensed under the MIT license found in the | ||
| * LICENSE file in the root directory of this source tree. | ||
| */ | ||
|
|
||
| module.exports = { | ||
| docs: { | ||
| 'Getting Started': [ | ||
| 'getting_started/getting-started'], | ||
| 'Core Features': [ | ||
| 'core/core', | ||
| 'core/actions', | ||
| 'core/android-flavors', | ||
| 'core/location', | ||
| 'core/sensors'], | ||
| 'Notifications': [ | ||
| 'notifications/notifications-basic', | ||
| 'notifications/actionable-notifications', | ||
| { | ||
| 'type': 'category', | ||
| 'label': 'Attachments', | ||
| 'items': [ | ||
| 'notifications/notification-attachments', | ||
| 'notifications/dynamic-content' | ||
| ] | ||
| }, | ||
| 'notifications/critical-notifications', | ||
| 'notifications/notification-details', | ||
| 'notifications/notification-cleared', | ||
| 'notifications/notification-commands', | ||
| 'notifications/notification-sounds', | ||
| 'notifications/notification-local', | ||
| 'notifications/notification-received', | ||
| ], | ||
| 'Integrations': [ | ||
| 'integrations/integrations', | ||
| 'integrations/android-device-controls', | ||
| 'integrations/android-quick-settings', | ||
| 'integrations/android-shortcuts', | ||
| 'integrations/android-webview', | ||
| 'integrations/android-widgets', | ||
| 'integrations/app-events', | ||
| 'integrations/haptics', | ||
| 'integrations/sharing', | ||
| 'integrations/ios-widgets', | ||
| 'integrations/siri-shortcuts', | ||
| 'integrations/theming', | ||
| 'integrations/universal-links', | ||
| 'integrations/url-handler', | ||
| 'integrations/x-callback-url'], | ||
| 'Apple Watch': [ | ||
| 'apple-watch/apple-watch', | ||
| 'apple-watch/watch-actions', | ||
| 'apple-watch/complications' | ||
| ], | ||
| 'Wear OS': [ | ||
| 'wear-os/wear-os', | ||
| 'wear-os/sensors' | ||
| ], | ||
| 'Android Auto/Automotive': [ | ||
| 'android-auto/android-auto' | ||
| ], | ||
| 'CarPlay': [ | ||
| 'carplay/carplay' | ||
| ], | ||
| 'Meta Quest': [ | ||
| 'meta-quest/meta-quest' | ||
| ], | ||
| 'Troubleshooting': [ | ||
| 'troubleshooting/faqs', | ||
| 'troubleshooting/errors', | ||
| 'troubleshooting/networking', | ||
| 'troubleshooting/resetting', | ||
| 'troubleshooting/troubleshooting-integrations', | ||
| 'troubleshooting/more-help' | ||
| ] | ||
| }, | ||
| gallery: { | ||
| 'Gallery': [ | ||
| 'gallery/android' | ||
| ] | ||
| }, | ||
| }; | ||
| /** | ||
| * Copyright (c) 2017-present, Facebook, Inc. | ||
| * | ||
| * This source code is licensed under the MIT license found in the | ||
| * LICENSE file in the root directory of this source tree. | ||
| */ | ||
|
|
||
| module.exports = { | ||
| docs: { | ||
| 'Getting Started': [ | ||
| 'getting_started/getting-started'], | ||
| 'Core Features': [ | ||
| 'core/core', | ||
| 'core/actions', | ||
| 'core/android-flavors', | ||
| 'core/location', | ||
| 'core/sensors'], | ||
| 'Notifications': [ | ||
| 'notifications/notifications-basic', | ||
| 'notifications/actionable-notifications', | ||
| { | ||
| 'type': 'category', | ||
| 'label': 'Attachments', | ||
| 'items': [ | ||
| 'notifications/notification-attachments', | ||
| 'notifications/dynamic-content' | ||
| ] | ||
| }, | ||
| 'notifications/critical-notifications', | ||
| 'notifications/notification-details', | ||
| 'notifications/notification-cleared', | ||
| 'notifications/notification-commands', | ||
| 'notifications/notification-sounds', | ||
| 'notifications/notification-local', | ||
| 'notifications/notification-unifiedpush', | ||
| 'notifications/notification-received', | ||
| ], | ||
| 'Integrations': [ | ||
| 'integrations/integrations', | ||
| 'integrations/android-device-controls', | ||
| 'integrations/android-quick-settings', | ||
| 'integrations/android-shortcuts', | ||
| 'integrations/android-webview', | ||
| 'integrations/android-widgets', | ||
| 'integrations/app-events', | ||
| 'integrations/haptics', | ||
| 'integrations/sharing', | ||
| 'integrations/ios-widgets', | ||
| 'integrations/siri-shortcuts', | ||
| 'integrations/theming', | ||
| 'integrations/universal-links', | ||
| 'integrations/url-handler', | ||
| 'integrations/x-callback-url'], | ||
| 'Apple Watch': [ | ||
| 'apple-watch/apple-watch', | ||
| 'apple-watch/watch-actions', | ||
| 'apple-watch/complications' | ||
| ], | ||
| 'Wear OS': [ | ||
| 'wear-os/wear-os', | ||
| 'wear-os/sensors' | ||
| ], | ||
| 'Android Auto/Automotive': [ | ||
| 'android-auto/android-auto' | ||
| ], | ||
| 'CarPlay': [ | ||
| 'carplay/carplay' | ||
| ], | ||
| 'Meta Quest': [ | ||
| 'meta-quest/meta-quest' | ||
| ], | ||
| 'Troubleshooting': [ | ||
| 'troubleshooting/faqs', | ||
| 'troubleshooting/errors', | ||
| 'troubleshooting/networking', | ||
| 'troubleshooting/resetting', | ||
| 'troubleshooting/troubleshooting-integrations', | ||
| 'troubleshooting/more-help' | ||
| ] | ||
| }, | ||
| gallery: { | ||
| 'Gallery': [ | ||
| 'gallery/android' | ||
| ] | ||
| }, | ||
| }; |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please move this to be inside the table cell next to the name as it currently breaks the table