Skip to content

Document filtering of sources for Android TV #11816

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

Merged
frenck merged 4 commits into from
Feb 5, 2020
Merged

Document filtering of sources for Android TV #11816

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
152d9c6
Document filtering of sources for Android TV
JeffLIrion Jan 20, 2020
2fa8a8e
Revise documentation for source filtering
JeffLIrion Jan 20, 2020
dcfc7e9
Document 'exclude_unnamed_apps' parameter
JeffLIrion Jan 25, 2020
beaa767
Fix typo
JeffLIrion Jan 25, 2020
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
15 changes: 12 additions & 3 deletions source/_integrations/androidtv.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,10 +77,15 @@ get_sources:
default: true
type: boolean
apps:
description: A dictionary where the keys are app IDs and the values are app names that will be displayed in the UI; see example below. ([These app names](https://github.com/JeffLIrion/python-androidtv/blob/5c39196ade3f88ab453b205fd15b32472d3e0482/androidtv/constants.py#L267-L283) are configured in the backend package and do not need to be included in your configuration.)
description: A dictionary where the keys are app IDs and the values are app names that will be displayed in the UI; see example below. If a name is not provided, the app will never be shown in the sources list. ([These app names](https://github.com/JeffLIrion/python-androidtv/blob/5c39196ade3f88ab453b205fd15b32472d3e0482/androidtv/constants.py#L267-L283) are configured in the backend package and do not need to be included in your configuration.)
required: false
default: {}
type: map
exclude_unnamed_apps:
description: If this is true, then only the apps you specify in the `apps` configuration parameter and [those specified in the backend library](https://github.com/JeffLIrion/python-androidtv/blob/5c39196ade3f88ab453b205fd15b32472d3e0482/androidtv/constants.py#L267-L283) will be shown in the sources list.
required: false
default: false
type: boolean
device_class:
description: "The type of device: `auto` (detect whether it is an Android TV or Fire TV device), `androidtv`, or `firetv`."
required: false
Expand All @@ -107,15 +112,19 @@ turn_off_command:
# Example configuration.yaml entry
media_player:
# Use the Python ADB implementation with a user-provided key to setup an
# Android TV device. Provide an app name, override the default turn on/off
# commands, and provide custom state detection rules.
# Android TV device. Provide some app names and don't display other apps
# in the sources menu. Override the default turn on/off commands, and
# provide custom state detection rules.
- platform: androidtv
name: Android TV
device_class: androidtv
host: 192.168.0.222
adbkey: "/config/android/adbkey"
exclude_unnamed_apps: true
apps:
com.amazon.tv.launcher: "Fire TV"
some.background.app: # this will never show up in the sources list
another.background.app: "" # this will also never show up in the sources list
turn_on_command: "input keyevent 3"
turn_off_command: "input keyevent 223"
state_detection_rules:
Expand Down