Skip to content

Commit

Permalink
Add some more integration stubs and knowledge only I posess. #35 #36 #28
Browse files Browse the repository at this point in the history
  • Loading branch information
robbiet480 committed Apr 26, 2019
1 parent 2fe4d8d commit 460bf6a
Show file tree
Hide file tree
Showing 8 changed files with 86 additions and 8 deletions.
13 changes: 13 additions & 0 deletions docs/integrations/actions.md
Original file line number Diff line number Diff line change
@@ -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
5 changes: 2 additions & 3 deletions docs/integrations/apple-watch.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
26 changes: 22 additions & 4 deletions docs/integrations/siri-shortcuts.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,30 @@ title: "Siri Shortcuts"



# Generic Shortcuts

## Send Location
# Actions

## Call Service

## Fire Event

## Render Template
## 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.
11 changes: 11 additions & 0 deletions docs/integrations/theming.md
Original file line number Diff line number Diff line change
@@ -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.
13 changes: 13 additions & 0 deletions docs/integrations/universal-links.md
Original file line number Diff line number Diff line change
@@ -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=<a URL you could use with the existing URL handler>`

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.
Empty file.
18 changes: 18 additions & 0 deletions website/i18n/en.json
Original file line number Diff line number Diff line change
Expand Up @@ -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"
},
Expand Down
8 changes: 7 additions & 1 deletion website/sidebars.json
Original file line number Diff line number Diff line change
Expand Up @@ -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": {
Expand Down

0 comments on commit 460bf6a

Please sign in to comment.