Update android-shortcuts.md #1138
Open
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
Extended description for adding shortcuts to self-created dashboards.
dshokouhi
reviewed
Nov 13, 2024
| @@ -7,7 +7,7 @@ id: 'android-shortcuts' | |||
|
|
|||
| The Android app offers support for both dynamic and pinned [shortcuts](https://developer.android.com/guide/topics/ui/shortcuts). Shortcuts allow users to navigate to a specific dashboard page or entity directly from the home screen without needing to first launch the app. Supported devices will see a Manage Shortcuts section under Companion App in [Settings](https://my.home-assistant.io/redirect/config/). From there users must supply the Label which appears in the launcher (Google recommends 10 characters). The description must also be provided as some launchers may prefer to display it (Google recommends 25 characters). | |||
|
|
|||
| There are currently 2 supported shortcut types: Dashboard or Entity. The default shortcut type is Dashboard and you must enter the Dashboard path (ex: `/lovelace/default_view` or `/lovelace-dashboardname/viewname`) in order to create the shortcut. If you selected Entity then you will be presented with a new Entity field that will contain a list of all entities from your Home Assistant server to select. Once selected you will be able to create the shortcut. | |||
| There are currently 2 supported shortcut types: Dashboard or Entity. The default shortcut type is Dashboard and you must enter the Dashboard path (ex: `/lovelace/default_view` or `/lovelace-dashboardname/viewname`) in order to create the shortcut. It is also possible to specify a direct URL as it is displayed in the browser (e.g. `/dashboard-mushroom/0` if your own dashboard is called 'Mushroom'). If a specific subpage (e.g. kitchen) of the dashboard 'Mushroom' is to be addressed, `/dashboard-mushroom/kitchen` can be entered. If you selected Entity then you will be presented with a new Entity field that will contain a list of all entities from your Home Assistant server to select. Once selected you will be able to create the shortcut. | |||
There was a problem hiding this comment.
While this does provide an extra example mentioning direct URL may be confusing still. The app actually accepts the relative URL which we should call out here. Not sure we need to provide examples of each and every type of relative URL one can have but we can add to the list of current examples if need be. The concept of relative URLs is used in a few different places already in the docs.
https://companion.home-assistant.io/docs/notifications/notifications-basic/#opening-a-url
https://companion.home-assistant.io/docs/notifications/actionable-notifications#uri-values
https://companion.home-assistant.io/docs/notifications/notification-commands#webview
https://companion.home-assistant.io/docs/integrations/url-handler#navigate
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Extended description for adding shortcuts to self-created dashboards.