- Media Player
- Services
- Media control services
- Service media_player.volume_mute
- Service media_player.volume_set
- Service media_player.media_seek
- Service media_player.play_media
- Configuration Variables
- Service media_player.select_source
- Service media_player.select_sound_mode
- Service media_player.shuffle_set
- Service media_player.repeat_set
- Service media_player.join
- Service media_player.unjoin
- Device Class
- Android TV
- Device preparation
- Configuration
- Configuration Variables
- Full Configuration
- ADB Setup
- 1. Python ADB Implementation
- 2. ADB Server
- ADB Troubleshooting
- Services
- media_player.select_source
- androidtv.adb_command
- androidtv.learn_sendevent (for faster ADB commands)
- androidtv.download and androidtv.upload
- Custom State Detection
Media Player
Interacts with media players on your network.
Services
Media control services
Available services: turn_on , turn_off , toggle , volume_up , volume_down , volume_set , volume_mute , media_play_pause , media_play , media_pause , media_stop , media_next_track , media_previous_track , clear_playlist , shuffle_set , repeat_set , play_media , select_source , select_sound_mode , join , unjoin
Service data attribute | Optional | Description |
---|---|---|
entity_id | yes | Target a specific media player. To target all media players, use all . |
Service media_player.volume_mute
Service data attribute | Optional | Description |
---|---|---|
entity_id | yes | Target a specific media player. To target all media players, use all . |
is_volume_muted | no | True/false for mute/unmute |
Service media_player.volume_set
Service data attribute | Optional | Description |
---|---|---|
entity_id | yes | Target a specific media player. To target all media players, use all . |
volume_level | no | Float for volume level. Range 0..1 |
Service media_player.media_seek
Service data attribute | Optional | Description |
---|---|---|
entity_id | yes | Target a specific media player. To target all media players, use all . |
seek_position | no | Position to seek to. The format is platform dependent. |
Service media_player.play_media
Service data attribute | Optional | Description |
---|---|---|
entity_id | yes | Target a specific media player. To target all media players, use all . |
media_content_id | no | A media identifier. The format of this is integration dependent. For example, you can provide URLs to Sonos and Cast but only a playlist ID to iTunes. |
media_content_type | no | A media type. Must be one of music , tvshow , video , episode , channel or playlist . For example, to play music you would set media_content_type to music . |
extra | yes | Extra dictionary data to send, e.g., title, thumbnail. Possible values can be found below. |
Extra dictionary data
Configuration Variables
Title of the media.
Thumbnail image URL.
Seconds since the beginning of the content. If the content is live content, and the position is not specified, the stream will start at the live position.
Whether the media will automatically play.
Describes the type of media artifact as one of the following: NONE , BUFFERED , LIVE .
URL of subtitle file to be shown on chromecast.
Language for subtitles.
Mimetype of subtitles.
ID of subtitle to be loaded.
If True, enqueue the media instead of play it.
Additional MediaInformation attributes not explicitly listed.
Media metadata object, one of the following: GenericMediaMetadata , MovieMediaMetadata , TvShowMediaMetadata , MusicTrackMediaMetadata , PhotoMediaMetadata .
Example of calling media_player service with title and image set:
Service media_player.select_source
Service data attribute | Optional | Description |
---|---|---|
entity_id | yes | Target a specific media player. To target all media players, use all . |
source | no | Name of the source to switch to. Platform dependent. |
Service media_player.select_sound_mode
Currently only supported on Denon AVR and Songpal.
Service data attribute | Optional | Description |
---|---|---|
entity_id | yes | Target a specific media player. For example media_player.marantz |
sound_mode | no | Name of the sound mode to switch to. Platform dependent. |
Service media_player.shuffle_set
Service data attribute | Optional | Description |
---|---|---|
entity_id | yes | Target a specific media player. For example media_player.spotify |
shuffle | no | true / false for enabling/disabling shuffle |
Service media_player.repeat_set
Service data attribute | Optional | Description |
---|---|---|
entity_id | yes | Target a specific media player. For example media_player.kitchen |
repeat | no | off / all / one for setting repeat mode |
Service media_player.join
Allows to group media players together for synchronous playback. Only works on supported multiroom audio systems.
Service data attribute | Optional | Description |
---|---|---|
entity_id | yes | The media player entity whose playback will be expanded to the players specified in group_members . |
group_members | no | The player entities which will be synced with the playback from entity_id . |
Service media_player.unjoin
Service data attribute | Optional | Description |
---|---|---|
entity_id | yes | Unjoin this media player from any player groups. |
Device Class
The way media players are displayed in the frontend can be modified in the customize section. The following device classes are supported for media players:
- tv : Device is a television type device.
- speaker : Device is speaker or stereo type device.
- receiver : Device is audio video receiver type device taking audio and outputting to speakers and video to some display.
Источник
Android TV
The androidtv platform allows you to control an Android TV device or Amazon Fire TV device.
When setting up this integration, it is recommended that you do NOT use an ADB server and instead use the built-in Python ADB implementation. This simplifies the setup and makes it easier to troubleshoot issues. If there are stability issues with this approach, then you may wish to try using an ADB server. See the ADB Setup section for more information.
Device preparation
To set up your device, you will need to find its IP address and enable ADB debugging. For Android TV devices, please consult the documentation for your device.
For Fire TV devices, the instructions are as follows:
- Turn on ADB Debugging on your Amazon Fire TV:
- From the main (Launcher) screen, select Settings.
- Select My Fire TV > Developer Options.
- Select ADB Debugging.
- Find Amazon Fire TV device IP address:
- From the main (Launcher) screen, select Settings.
- Select My Fire TV > About > Network.
Configuration
Configuration Variables
The IP address for your Android TV / Fire TV device.
The friendly name of the device.
The port for your Android TV / Fire TV device.
The path to your adbkey file; if not provided, Home Assistant will generate a key for you (if necessary).
The IP address of the ADB server. If this is provided, the integration will utilize an ADB server to communicate with the device.
The port for the ADB server.
Whether or not to retrieve the running apps as the list of sources.
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 are configured in the backend package and do not need to be included in your configuration.)
If this is true, then only the apps you specify in the apps configuration parameter and those specified in the backend library will be shown in the sources list.
The type of device: auto (detect whether it is an Android TV or Fire TV device), androidtv , or firetv .
A dictionary whose keys are app IDs and whose values are lists of state detection rules; see the section Custom State Detection for more info.
An ADB shell command that will override the default turn_on command.
An ADB shell command that will override the default turn_off command.
Determines if album art should be pulled from what is shown onscreen.
Full Configuration
ADB Setup
This integration works by sending ADB commands to your Android TV / Fire TV device. There are two ways to accomplish this.
1. Python ADB Implementation
The default approach is to connect to your device using the adb-shell Python package. As of Home Assistant 0.101, if a key is needed for authentication and it is not provided by the adbkey configuration option, then Home Assistant will generate a key for you.
Prior to Home Assistant 0.101, this approach did not work well for newer devices. Efforts have been made to resolve these issues, but if you experience problems then you should use the ADB server option.
2. ADB Server
The second option is to use an ADB server to connect to your Android TV and Fire TV devices.
Using this approach, Home Assistant will send the ADB commands to the server, which will then send them to the Android TV / Fire TV device and report back to Home Assistant. To use this option, add the adb_server_ip option to your configuration. If you are running the server on the same machine as Home Assistant, you can use 127.0.0.1 for this value.
ADB Troubleshooting
If the setup for your Android TV or Fire TV device fails, then there is probably an issue with your ADB connection. Here are some possible causes.
You have the wrong IP address for the device.
ADB is not enabled on your device.
You are already connected to the Android TV / Fire TV via ADB from another device. Only one device can be connected, so disconnect the other device, restart the Android TV / Fire TV (for good measure), and then restart Home Assistant.
You need to approve the ADB connection; see the note in the ADB Setup section above.
Some Android TV devices (e.g., Philips TVs running Android TV) only accept the initial ADB connection request over their Wi-Fi interface. If you have the TV wired, you need to connect it to Wi-Fi and try the initial connection again. Once the authentication has been granted via Wi-Fi, you can connect to the TV over the wired interface as well.
If your device drops off WiFi, breaking the ADB connection and causing the entity to become unavailable in Home Assistant, you could install a wake lock utility (such as Wakelock) to prevent this from happening. Some users have reported this problem with Xiaomi Mi Box devices.
If you are using the Python ADB implementation approach, as mentioned above, there may be some issues with newer devices. In this case, you should use the ADB server approach instead.
Services
media_player.select_source
You can launch an app on your device using the media_player.select_source command. Simply provide the app ID as the source . You can also stop an app by prefixing the app ID with a ! . For example, you could define scripts to start and stop Netflix as follows:
androidtv.adb_command
The service androidtv.adb_command allows you to send either keys or ADB shell commands to your Android TV / Fire TV device. If there is any output, it will be stored in the ‘adb_response’ attribute (i.e., state_attr(‘media_player.android_tv_living_room’, ‘adb_response’) in a template) and logged at the INFO level.
Service data attribute | Optional | Description |
---|---|---|
entity_id | no | Name(s) of Android TV / Fire TV entities. |
command | no | Either a key command or an ADB shell command. |
In an action of your automation setup it could look like this:
Available key commands include:
The full list of key commands can be found here.
You can also use the command GET_PROPERTIES to retrieve the properties used by Home Assistant to update the device’s state. These will be stored in the media player’s ‘adb_response’ attribute and logged at the INFO level. This information can be used to help improve state detection in the backend androidtv package, and also to define your own custom state detection rules.
A list of various intents can be found here.
androidtv.learn_sendevent (for faster ADB commands)
When sending commands like UP, DOWN, HOME, etc. via ADB, the device can be slow to respond. The problem isn’t ADB, but rather the Android command input that is used to perform those actions. A faster way to send these commands is using the Android sendevent command. The challenge is that these commands are device-specific. To assist users in learning commands for their device, the Android TV integration provides the androidtv.learn_sendevent service. Its usage is as follows:
Service data attribute | Optional | Description |
---|---|---|
entity_id | no | Name(s) of Android TV / Fire TV entities. |
- Call the androidtv.learn_sendevent service.
- Within 8 seconds, hit a single button on your Android TV / Fire TV remote.
- After 8 seconds, a persistent notification will appear that contains the equivalent command that can be sent via the androidtv.adb_command service. This command can also be found in the adb_response attribute of the media player in Home Assistant, and it will be logged at the INFO level.
As an example, a service call in a script could be changed from this:
androidtv.download and androidtv.upload
You can use the androidtv.download service to download a file from your Android TV / Fire TV device to your Home Assistant instance.
Service data attribute | Optional | Description |
---|---|---|
entity_id | no | Name of Android TV / Fire TV entity. |
device_path | no | The filepath on the Android TV / Fire TV device. |
local_path | no | The filepath on your Home Assistant instance. |
Similarly, you can use the androidtv.upload service to upload a file from Home Assistant instance to Android TV / Fire TV devices.
Service data attribute | Optional | Description |
---|---|---|
entity_id | no | Name(s) of Android TV / Fire TV entities. |
device_path | no | The filepath on the Android TV / Fire TV device. |
local_path | no | The filepath on your Home Assistant instance. |
Custom State Detection
The Android TV integration works by polling the Android TV / Fire TV device at a regular interval and collecting a handful of properties. Unfortunately, there is no standard API for determining the state of the device to which all apps adhere. Instead, the backend androidtv package uses three of the properties that it collects to determine the state: audio_state , media_session_state , and wake_lock_size . The correct logic for determining the state differs depending on the current app, and the backend androidtv package implements app-specific state detection logic for a handful of apps. Of course, it is not feasible to implement custom logic for each and every app in the androidtv package. Moreover, the correct state detection logic may differ across devices and device configurations.
The solution to this problem is the state_detection_rules configuration parameter, which allows you to provide your own rules for state detection. The keys are app IDs, and the values are lists of rules that are evaluated in order. Valid rules are:
- ‘standby’ , ‘playing’ , ‘paused’ , ‘idle’ , or ‘off’
- If this is not a map, then this state will always be reported when this app is the current app
- If this is a map, then its entries are conditions that will be checked. If all of the conditions are true, then this state will be reported. Valid conditions pertain to 3 properties (see the example configuration above):
- ‘media_session_state’
- ‘audio_state’
- ‘wake_lock_size’
- ‘media_session_state’ = try to use the media_session_state property to determine the state
- ‘audio_state’ = try to use the audio_state property to determine the state
Источник