Enable native support + ADB authentication for Fire TV

[JeffLIrion]

Description:

Related issue (if applicable): fixes #13482

Pull request in home-assistant.io with documentation (if applicable): home-assistant/home-assistant.io#7062

Forum thread: https://community.home-assistant.io/t/native-support-for-fire-tv/64448

Example entry for configuration.yaml (if applicable):

# Example configuration.yaml entry
media_player:
  # a device that does not require ADB authentication
  - platform: firetv
    name: Fire TV 1
    host: 192.168.0.111

  # a device that does require ADB authentication
  - platform: firetv
    name: Fire TV 2
    host: 192.168.0.222
    adbkey: "/config/android/adbkey"

  # a device for which getting the current app (source) and the running apps (sources) cause issues
  - platform: firetv
    name: Fire TV 3
    host: 192.168.0.123
    get_source: false
    get_sources: false

If user exposed functionality or configuration variables are added/changed:

• Documentation added/updated in home-assistant.io

If the code communicates with devices, web services, or third-party tools:

• New dependencies have been added to the REQUIREMENTS variable ([example][ex-requir]).
• New dependencies are only imported inside functions that use them ([example][ex-import]).
• New or updated dependencies have been added to requirements_all.txt by running script/gen_requirements_all.py.
• New files were added to .coveragerc.

Breaking Changes (short version)

The host and port configuration variables now refer to the Fire TV device itself, whereas before they referred to the firetv server running in a Python 2 environment.

Breaking Changes (longer version)

Previously, the Fire TV component required the user to run a firetv server in a Python 2 environment, and Home Assistant would poll that server for information about the Fire TV device(s). In this setup, the host and port configuration variables referred to the firetv server.

Recent updates to the firetv and adb libraries have enabled the firetv package to run in a Python 3 environment. In this update, Fire TV devices are monitored and controlled directly by Home Assistant itself -- no third party Python 2 firetv server required! Accordingly, the host and port configuration variables now refer to the Fire TV device itself.

Furthermore, this update provides support for ADB authentication, which nearly all Fire TV devices now require. To enable ADB authentication, the user must follow the instructions in home-assistant/home-assistant.io#7062 and add the adbkey configuration variable.

[JeffLIrion]

I believe this needs a "breaking-change" label, since the user's configuration will need to be updated.

[rytilahti]

Thanks for the PR, this is a very welcome effort! I did a brief testing and the basics (changing apps, playing & pausing) seemed to be working at first, but suddenly it stopped updating the play/pause state. Could be that me trying to connect with another adb instance to the same device got it confused (stays in 'playing' even when being paused, in both netflix and amazon videos).

[JeffLIrion]

So I guess this PR is just waiting for packages to be published on pypi. Aside from that, are there any other changes that need to be made?

[houndci-bot]

Some files could not be reviewed due to errors:

Traceback (most recent call last):

Traceback (most recent call last):
  File "/home/linters/.local/bin/flake8", line 7, in 
    from flake8.main.cli import main
ModuleNotFoundError: No module named 'flake8'

[houndci-bot]

Some files could not be reviewed due to errors:

Traceback (most recent call last):

Traceback (most recent call last):
  File "/home/linters/.local/bin/flake8", line 7, in 
    from flake8.main.cli import main
ModuleNotFoundError: No module named 'flake8'

[JeffLIrion]

OK, so the lint and pylint tests aren't passing. Here is what I saw in the test logs that looks important. Advice on how to pass these tests would be appreciated.

lint

******* ERROR
requirements_all.txt is not up to date
Please run script/gen_requirements_all.py
ERROR: InvocationError for command '/home/travis/build/home-assistant/home-assistant/.tox/lint/bin/python script/gen_requirements_all.py validate' (exited with code 1)

When I ran python script/gen_requirements_all.py on my machine it made a bunch of changes to the requirements_all.txt and requirements_test.txt files, but it didn't add anything about the adb-homeassistant or firetv packages. I'm not sure what the problem is here...

pylint

************* Module homeassistant.components.media_player.firetv
homeassistant/components/media_player/firetv.py:64:11: W0212: Access to a protected member _adb of a client class (protected-access)
homeassistant/components/media_player/firetv.py:64:11: W0212: Access to a protected member _firetv of a client class (protected-access)
homeassistant/components/media_player/firetv.py:115:8: E0611: No name 'FireTV' in module 'firetv' (no-name-in-module)
homeassistant/components/media_player/firetv.py:224:8: W0702: No exception type(s) specified (bare-except)
homeassistant/components/media_player/firetv.py:162:19: W0212: Access to a protected member _adb of a client class (protected-access)
homeassistant/components/media_player/firetv.py:171:21: W0212: Access to a protected member _screen_on of a client class (protected-access)
homeassistant/components/media_player/firetv.py:177:21: W0212: Access to a protected member _awake of a client class (protected-access)
homeassistant/components/media_player/firetv.py:209:25: W0212: Access to a protected member _wake_lock of a client class (protected-access)
homeassistant/components/media_player/firetv.py:217:21: W0212: Access to a protected member _wake_lock of a client class (protected-access)
homeassistant/components/media_player/firetv.py:225:12: W1201: Specify string format arguments as logging function parameters (logging-not-lazy)
homeassistant/components/media_player/firetv.py:227:12: W0212: Access to a protected member _adb of a client class (protected-access)
------------------------------------
Your code has been rated at 10.00/10

The errors are:

• W0212: Access to a protected member _adb of a client class (protected-access)
  • I could have pylint ignore this error
• E0611: No name 'FireTV' in module 'firetv' (no-name-in-module)
  • It thinks it's importing itself...
• W0702: No exception type(s) specified (bare-except)
  • I did this as a catch-all
• W1201: Specify string format arguments as logging function parameters (logging-not-lazy)
  • I think that's a false positive

[JeffLIrion]

@rytilahti, please let me know what you'd like me to change so that I can get this PR approved.

[rytilahti]

Looking at the requirements.txt diff, there are lots of unwanted changes there, so that's why it is complaining.

[JeffLIrion]

If firetv 1.0.7 becomes available on pypi, the build will pass. Would you then be willing to merge this PR?

[JeffLIrion]

I switched from using a boolean to using threading.Lock(). If everything looks good now, then I'll request that my PR for firetv 1.0.7 gets merged. Does anything else need to be changed?

[JeffLIrion]

Is it ready to be merged once firetv 1.0.7 is released?

[JeffLIrion]

@MartinHjelmare is this ready to be merged once firetv 1.0.7 gets released on pypi?

[MartinHjelmare]

I think so. 👍

[JeffLIrion]

firetv 1.0.7 is released on pypi! How can I re-retrigger a build?

[MartinHjelmare]

I've restarted the failed job.

[JeffLIrion]

The build passed! Can we merge this PR?

[JeffLIrion]

Thanks @MartinHjelmare! And thanks to @rytilahti for the reviews and @happyleavesaoc for approving my PRs for firetv and releasing new versions on pypi!

[KarimGeiger]

Hi - sorry if this is the wrong place to put this, but I can't quite get this component to work with my setup. I've installed adb by running apt-get install android-tools-adb on my HASS server. Then, I connected using adb connect [ip] to the FireTV, which worked flawlessly. Then, after configuring the component (and setting the adbkey path), I get the following errors:

16:27 components/media_player/firetv.py (ERROR)

Couldn't connect to host: [ip]:5555, error: Connection reset by peer
16:27 components/media_player/firetv.py (WARNING)

I'm running version 0.83.3. I've already checked the permissions on the key file and tried starting/stopping the adb server manually by running adb kill-server or adb connecting again. Interestingly, if I'm not mistaken, it sometimes, for a brief moment, seems to work:

Thanks for your help, and again, sorry if this isn't the right place.

[MartinHjelmare]

Please open an issue if you suspect a bug. If you need help please use our help channels:
https://home-assistant.io/help/#communication-channels

Merged PRs should not be used for support or bug reports. Thanks!