From e26c5cd5713b6fd8fa6bb620e83d644222dbd444 Mon Sep 17 00:00:00 2001 From: Travis Sanderson Date: Fri, 10 Jan 2025 10:19:43 -0600 Subject: [PATCH 1/4] Remove lovelace from url-handler docs --- docs/integrations/url-handler.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/integrations/url-handler.md b/docs/integrations/url-handler.md index 547a5ec6d8d..b8320dc1c74 100644 --- a/docs/integrations/url-handler.md +++ b/docs/integrations/url-handler.md @@ -14,13 +14,13 @@ If multiple servers are connected to an app, you will be prompted to select a se ## Navigate This allows you to update the frontend page location via a deeplink. -For example: if you had a dashboard at `/lovelace/webcams` you can use `homeassistant://navigate/lovelace/webcams` to launch the app there. +For example: if you had a dashboard at `/webcams` you can use `homeassistant://navigate/webcams` to launch the app there. Similarly, you can navigate to a subview named `example` under your `/webcams` dashboard using `homeassistant://navigate/webcams/example`. #### Define server ![iOS](/assets/iOS.svg) BETA
By default the App will ask which server you want to navigate to in case you have multiple servers. To define which server you want to navigate to, use the query param `?server=` like the example below:

-`homeassistant://navigate/lovelace/webcams?server=My%20home` when your server name is `My Home`, or use `?server=default` if you want to navigate to the first server available. +`homeassistant://navigate/webcams?server=My%20home` when your server name is `My Home`, or use `?server=default` if you want to navigate to the first server available. ## Call service ![iOS](/assets/iOS.svg)
From acccf0475c8c92625ee9c567b30710b31a436baf Mon Sep 17 00:00:00 2001 From: Travis Sanderson Date: Fri, 10 Jan 2025 11:13:49 -0600 Subject: [PATCH 2/4] Add step-by-step for crafting a navigate URL --- docs/integrations/url-handler.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/docs/integrations/url-handler.md b/docs/integrations/url-handler.md index b8320dc1c74..c440bebf7a5 100644 --- a/docs/integrations/url-handler.md +++ b/docs/integrations/url-handler.md @@ -12,9 +12,12 @@ If multiple servers are connected to an app, you will be prompted to select a se ::: ## Navigate -This allows you to update the frontend page location via a deeplink. +This allows you to update the frontend page location via a deeplink. To build a deeplink, follow these steps: -For example: if you had a dashboard at `/webcams` you can use `homeassistant://navigate/webcams` to launch the app there. Similarly, you can navigate to a subview named `example` under your `/webcams` dashboard using `homeassistant://navigate/webcams/example`. +1. Navigate to the link you'd like to deeplink to in the web app, e.g. `http://homeassistant.local:8123/dashboard-mobile/my-subview` +2. Copy the path portion of the URL, in this example that would be `/dashboard-mobile/my-subview` +3. Craft your URL by starting with `homeassistant://navigate` and adding the path, e.g. `homeassistant://navigate/dashboard-mobile/my-subview` +4. Optional: if you have multiple servers and want to link to one directly, add `?server=My%20Server%20Name` to the end (note that %20 is how you represent a space in a URL, commonly called URL encoding), e.g. `homeassistant://navigate/dashboard-mobile/my-subview?server=My%20House` #### Define server ![iOS](/assets/iOS.svg) BETA
From 42b76d289c6afd56210f1025c45167cfccdf48fa Mon Sep 17 00:00:00 2001 From: Travis Sanderson Date: Fri, 10 Jan 2025 11:58:36 -0600 Subject: [PATCH 3/4] Deeplink to specific server is iOS only as of now --- docs/integrations/url-handler.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/integrations/url-handler.md b/docs/integrations/url-handler.md index c440bebf7a5..67e9b229022 100644 --- a/docs/integrations/url-handler.md +++ b/docs/integrations/url-handler.md @@ -17,7 +17,7 @@ This allows you to update the frontend page location via a deeplink. To build a 1. Navigate to the link you'd like to deeplink to in the web app, e.g. `http://homeassistant.local:8123/dashboard-mobile/my-subview` 2. Copy the path portion of the URL, in this example that would be `/dashboard-mobile/my-subview` 3. Craft your URL by starting with `homeassistant://navigate` and adding the path, e.g. `homeassistant://navigate/dashboard-mobile/my-subview` -4. Optional: if you have multiple servers and want to link to one directly, add `?server=My%20Server%20Name` to the end (note that %20 is how you represent a space in a URL, commonly called URL encoding), e.g. `homeassistant://navigate/dashboard-mobile/my-subview?server=My%20House` +4. ![iOS](/assets/iOS.svg) Optional (iOS only): if you have multiple servers and want to link to one directly, add `?server=My%20Server%20Name` to the end (note that %20 is how you represent a space in a URL, commonly called URL encoding), e.g. `homeassistant://navigate/dashboard-mobile/my-subview?server=My%20House` #### Define server ![iOS](/assets/iOS.svg) BETA
From 6b627ffb169681c3fa8c9cb5fd46bd5f6f72a843 Mon Sep 17 00:00:00 2001 From: Travis Sanderson Date: Fri, 10 Jan 2025 12:08:54 -0600 Subject: [PATCH 4/4] Remove step 4 since it is redundant with the Specify server section --- docs/integrations/url-handler.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/integrations/url-handler.md b/docs/integrations/url-handler.md index 67e9b229022..de83395c927 100644 --- a/docs/integrations/url-handler.md +++ b/docs/integrations/url-handler.md @@ -17,9 +17,8 @@ This allows you to update the frontend page location via a deeplink. To build a 1. Navigate to the link you'd like to deeplink to in the web app, e.g. `http://homeassistant.local:8123/dashboard-mobile/my-subview` 2. Copy the path portion of the URL, in this example that would be `/dashboard-mobile/my-subview` 3. Craft your URL by starting with `homeassistant://navigate` and adding the path, e.g. `homeassistant://navigate/dashboard-mobile/my-subview` -4. ![iOS](/assets/iOS.svg) Optional (iOS only): if you have multiple servers and want to link to one directly, add `?server=My%20Server%20Name` to the end (note that %20 is how you represent a space in a URL, commonly called URL encoding), e.g. `homeassistant://navigate/dashboard-mobile/my-subview?server=My%20House` -#### Define server +### Specify server to navigate to ![iOS](/assets/iOS.svg) BETA
By default the App will ask which server you want to navigate to in case you have multiple servers. To define which server you want to navigate to, use the query param `?server=` like the example below: