From 460bf6a94d6bb4a1705ec321f5f3b688ff566e67 Mon Sep 17 00:00:00 2001 From: Robbie Trencheny Date: Fri, 26 Apr 2019 00:42:30 -0700 Subject: [PATCH] Add some more integration stubs and knowledge only I posess. #35 #36 #28 #27 #25 #21 #19 #18 #16 --- docs/integrations/actions.md | 13 +++++++++++++ docs/integrations/apple-watch.md | 5 ++--- docs/integrations/siri-shortcuts.md | 26 ++++++++++++++++++++++---- docs/integrations/theming.md | 11 +++++++++++ docs/integrations/universal-links.md | 13 +++++++++++++ docs/integrations/x-callback-url.md | 0 website/i18n/en.json | 18 ++++++++++++++++++ website/sidebars.json | 8 +++++++- 8 files changed, 86 insertions(+), 8 deletions(-) create mode 100644 docs/integrations/actions.md create mode 100644 docs/integrations/theming.md create mode 100644 docs/integrations/universal-links.md create mode 100644 docs/integrations/x-callback-url.md diff --git a/docs/integrations/actions.md b/docs/integrations/actions.md new file mode 100644 index 00000000000..b7e337c81ab --- /dev/null +++ b/docs/integrations/actions.md @@ -0,0 +1,13 @@ +--- +title: "Actions" +--- + +Actions is a generic system that allows you to easily integration the Home Assistant automations system into multiple areas of iOS. + +# Apple Watch + +# Home Screen Quick Actions + +[Home Screen Quick Actions](https://developer.apple.com/design/human-interface-guidelines/ios/extensions/home-screen-actions/) appear when 3D Touching the app icon on your home screen. + +# Today Widget diff --git a/docs/integrations/apple-watch.md b/docs/integrations/apple-watch.md index 5a59db7c092..27676299700 100644 --- a/docs/integrations/apple-watch.md +++ b/docs/integrations/apple-watch.md @@ -4,7 +4,6 @@ title: "Apple Watch" Home Assistant has deep integration with the Apple Watch. You can display Home Assistant information as complications directly on your watch face or launch actions from the Watch app. -# Complications - - # Actions + +# Complications diff --git a/docs/integrations/siri-shortcuts.md b/docs/integrations/siri-shortcuts.md index c325c19d23c..b88110c4ecd 100644 --- a/docs/integrations/siri-shortcuts.md +++ b/docs/integrations/siri-shortcuts.md @@ -4,12 +4,30 @@ title: "Siri Shortcuts" -# Generic Shortcuts - -## Send Location +# Actions ## Call Service ## Fire Event -## Render Template \ No newline at end of file +## Get Camera Snapshot + +## Render Template + +## Send Location + +# Using Shortcuts + +You can send a special push notification to your device, that when tapped, will open the Shortcut of your choosing and run it. Here's an example payload: + +```yaml +--- +data: + push: + shortcut: + name: XCU + input: text1 + text: soup1 +``` + +The `input` key will be passed into the shortcut as well and accepts a dictionary. diff --git a/docs/integrations/theming.md b/docs/integrations/theming.md new file mode 100644 index 00000000000..14017b44717 --- /dev/null +++ b/docs/integrations/theming.md @@ -0,0 +1,11 @@ +--- +title: Theming +--- + +The app attempts to match the theme that the frontend is currently using. Theme keys that the app will use are: + +- `primary-background-color` for the background color of the web view +- `primary-color` for the status bar background color +- `text-primary-color` for the pull to refresh tint color + +Themes should update in real time. Only system themes, not user themes, are supported. diff --git a/docs/integrations/universal-links.md b/docs/integrations/universal-links.md new file mode 100644 index 00000000000..c78d9f38423 --- /dev/null +++ b/docs/integrations/universal-links.md @@ -0,0 +1,13 @@ +--- +title: "Universal Links" +--- + +Universal links are a alternative to the [URL Handler](integrations/url-handler.md) and [X-Callback-URL](integrations/x-callback-url.md). + +The app has registered all URLs under `https://www.home-assistant.io/ios/` as valid Universal Links. However, at this time, there is only one Universal Link that the app understands: + +`https://www.home-assistant.io/ios/nfc/?url=` + +What this allows for is NFC support. You can write a NFC tag with a NDEF URL like the above and whenever your device sees that NFC tag, a notification will appear for you to open the app with. + +Once you open the app, it will do whatever action you told it to in the URL. diff --git a/docs/integrations/x-callback-url.md b/docs/integrations/x-callback-url.md new file mode 100644 index 00000000000..e69de29bb2d diff --git a/website/i18n/en.json b/website/i18n/en.json index 909f3b3c369..bc623f04eac 100644 --- a/website/i18n/en.json +++ b/website/i18n/en.json @@ -8,12 +8,30 @@ "getting_started/index": { "title": "Welcome" }, + "integrations/actions": { + "title": "Actions" + }, + "integrations/apple-watch": { + "title": "Apple Watch" + }, "integrations/index": { "title": "Integrations" }, + "integrations/siri-shortcuts": { + "title": "Siri Shortcuts" + }, + "integrations/theming": { + "title": "Theming" + }, + "integrations/universal-links": { + "title": "Universal Links" + }, "integrations/url-handler": { "title": "URL Handler" }, + "integrations/x-callback-url": { + "title": "integrations/x-callback-url" + }, "location/index": { "title": "Location" }, diff --git a/website/sidebars.json b/website/sidebars.json index 31e22dcdf36..471b83b89e4 100644 --- a/website/sidebars.json +++ b/website/sidebars.json @@ -21,7 +21,13 @@ "Integrations": { "Integrations": [ "integrations/index", - "integrations/url-handler" + "integrations/actions", + "integrations/apple-watch", + "integrations/siri-shortcuts", + "integrations/theming", + "integrations/universal-links", + "integrations/url-handler", + "integrations/x-callback-url" ] }, "Misc": {