jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-09 18:36:51 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update nfandroidtv.markdown (#20400)

Browse Source
This commit is contained in:
Redah 2021-11-30 16:18:59 +01:00 committed by GitHub
parent d3edbad329
commit b544e84d6d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 39 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

52
source/_integrations/nfandroidtv.markdown
View File

@ -13,7 +13,7 @@ ha_codeowners:
- '@tkdrob'
---
Notification integration for [Notifications for Android TV](https://play.google.com/store/apps/details?id=de.cyberdream.androidtv.notifications.google) and [Notifications for Fire TV](https://www.amazon.com/Christian-Fees-Notifications-for-Fire/dp/B00OESCXEK). You can use this integration to send notifications to your Android TV device. An overlay with the message content will appear for a configurable amount of seconds and then disappear again. Sending images (e.g., security cam) is supported too.
Notification integration for [Notifications for Android TV](https://play.google.com/store/apps/details?id=de.cyberdream.androidtv.notifications.google) and [Notifications for Fire TV](https://www.amazon.com/Christian-Fees-Notifications-for-Fire/dp/B00OESCXEK). You can use this integration to send notifications to your Android TV device. An overlay with the message content will appear for a configurable amount of seconds and then disappear again. Sending images (e.g., security cam) and custom icons is supported too. Icons are essentially the same as images (any image format supported by Android TV is supported), but are displayed small and to the left of the notification whereas images are large and above the notification.
The notifications are in the global scope of your Android TV device. They will be displayed regardless of which application is running.
@ -69,34 +69,60 @@ color: "red"
interrupt: 1
```
## Service data for sending images
## Service data for sending images and icons
The following attributes can be placed inside `data` to send images.
The following attributes can be placed inside `data` to send images and icons.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `file` | yes | Groups the attributes for file upload. If present, either `url` or `path` have to be provided.
| `path` | yes | Local path of an image file. Is placed inside `file`.
| `url` | yes | URL of an image file. Is placed inside `file`.
| `username` | yes | Username if the URL requires authentication. Is placed inside `file`.
| `password` | yes | Password if the URL requires authentication. Is placed inside `file`.
| `auth` | yes | If set to `digest` HTTP-Digest-Authentication is used. If missing, HTTP-BASIC-Authentication is used and is placed inside `file`.
| `image` | yes | Groups the attributes for image upload. If present, either `url` or `path` have to be provided.
| `icon` | yes | Groups the attributes for icon upload. If present, either `url` or `path` have to be provided.
| `path` | yes | Local path of an image file. Is placed inside `image`, `icon` or both.
| `url` | yes | URL of an image file. Is placed inside `image`, `icon` or both.
| `username` | yes | Username if the URL requires authentication. Is placed inside `image`, `icon` or both`.
| `password` | yes | Password if the URL requires authentication. Is placed inside `image`, `icon` or both.
| `auth` | yes | If set to `digest` HTTP-Digest-Authentication is used. If missing, HTTP-BASIC-Authentication is used and is placed inside `image`, `icon` or both.
Example for posting file from URL:
Example for posting image from URL:
```yaml
file:
image:
url: "http://[url to image file]"
username: "optional user, if necessary"
password: "optional password, if necessary"
auth: "digest"
```
Example for posting file from local path:
Example for posting image from local path:
```yaml
file:
image:
path: "/path/to/file.ext"
```
Example for posting icon from URL:
```yaml
icon:
url: "http://[url to image file]"
username: "optional user, if necessary"
password: "optional password, if necessary"
auth: "digest"
```
Example for posting both image and icon from URL:
```yaml
image:
url: "http://[url to image file]"
username: "optional user, if necessary"
password: "optional password, if necessary"
auth: "digest"
icon:
url: "http://[url to image file]"
username: "optional user, if necessary"
password: "optional password, if necessary"
auth: "digest"
```
Please note that `path` is validated against the `allowlist_external_dirs` in the `configuration.yaml`.