Skip to content

Update android-shortcuts.md #1138

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

Open
icebaer12 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update android-shortcuts.md #1138

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion docs/integrations/android-shortcuts.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Copy link
Copy Markdown
Member

@dshokouhi dshokouhi Nov 13, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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


Dynamic shortcuts are supported on devices with Android 7.1+. These shortcuts need to be added from Companion App in [Settings](https://my.home-assistant.io/redirect/config/) so users can drag them on their home screen after long pressing the app icon. It is important to note that Android only supports displaying 5 dynamic shortcuts under the long press menu however, most launchers only support showing 4. All 5 shortcuts can be updated and also deleted from the app long press menu.

Expand Down