mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-07 17:36:50 +00:00
Add documentation for updated Fire TV component (#7062)
* Add documentation for updated Fire TV component * Add the default locations for the adbkey files * Use configuration tags, change 'setup' to 'set up' * Add hyperlink * Fixed a typo * Put the 'Important' message in a note box
This commit is contained in:
Jeff Irion
Franck Nijhof
parent
28a7c84c21
commit
12cda23e02
@ -14,9 +14,7 @@ ha_iot_class: "Local Polling"
|
||||
---
|
||||
|
||||
|
||||
The `firetv` platform allows you to control a [Amazon Fire TV/stick](https://www.amazon.com/b/?node=8521791011).
|
||||
|
||||
The python-firetv Python 2.x module with its helper script that exposes an HTTP server to fetch state and perform actions is used.
|
||||
The `firetv` platform allows you to control an [Amazon Fire TV/stick](https://www.amazon.com/b/?node=8521791011).
|
||||
|
||||
Steps to configure your Amazon Fire TV stick with Home Assistant:
|
||||
|
||||
@ -27,59 +25,85 @@ Steps to configure your Amazon Fire TV stick with Home Assistant:
|
||||
- Find Amazon Fire TV device IP:
|
||||
- From the main (Launcher) screen, select Settings.
|
||||
- Select System > About > Network.
|
||||
- The following commands must be run in a Python 2.x environment. They will allow the component to function in an Ubuntu 16.04/Hassbian environment.
|
||||
- `apt-get install swig libssl-dev python-dev libusb-1.0-0 python-yaml`
|
||||
- `pip install flask`
|
||||
- `pip install https://pypi.python.org/packages/source/M/M2Crypto/M2Crypto-0.24.0.tar.gz`
|
||||
- `pip install firetv[firetv-server]`
|
||||
- `firetv-server -d <fire tv device IP>:5555`, background the process
|
||||
- Navigate to http://localhost:5556/devices/list
|
||||
- You will get an output similar to below:
|
||||
```json
|
||||
{
|
||||
"devices": {
|
||||
"default": {
|
||||
"host": "192.168.1.153:5555",
|
||||
"state": "play"
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
- The `"default"` above is the device name you will need to use for your `configuration.yaml`
|
||||
- Configure Home Assistant as follows:
|
||||
|
||||
To add FireTV to your installation, Note your device name, and add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# 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
|
||||
```
|
||||
|
||||
{% configuration %}
|
||||
host:
|
||||
description: "The host where `firetv-server` is running."
|
||||
required: false
|
||||
description: The IP address for your Fire TV device.
|
||||
required: true
|
||||
type: string
|
||||
default: localhost
|
||||
port:
|
||||
description: "The port where `firetv-server` is running."
|
||||
required: false
|
||||
type: integer
|
||||
default: 5556
|
||||
device:
|
||||
description: The device ID.
|
||||
required: false
|
||||
type: string
|
||||
default: default
|
||||
name:
|
||||
description: The friendly name of the device.
|
||||
required: false
|
||||
type: string
|
||||
default: Amazon Fire TV
|
||||
type: string
|
||||
port:
|
||||
description: The port for your Fire TV device.
|
||||
required: false
|
||||
default: 5555
|
||||
type: integer
|
||||
adbkey:
|
||||
description: The path to your `adbkey` file. Note that the file `adbkey.pub` must be in the same directory.
|
||||
required: false
|
||||
type: string
|
||||
get_source:
|
||||
description: Whether or not to retrieve the current app as the source.
|
||||
required: false
|
||||
default: true
|
||||
type: boolean
|
||||
get_sources:
|
||||
description: Whether or not to retrieve the running apps as the list of sources.
|
||||
required: false
|
||||
default: true
|
||||
type: boolean
|
||||
{% endconfiguration %}
|
||||
|
||||
### {% linkable_title ADB Authentication (for Fire TV devices with recent software) %}
|
||||
|
||||
If you get a "Device authentication required, no keys available" error when trying to set up Fire TV, then you'll need to create an adbkey and add its path to your configuration. Follow the instructions on this page to connect to your Fire TV from your computer: [Connecting to Fire TV Through adb](https://developer.amazon.com/zh/docs/fire-tv/connecting-adb-to-device.html).
|
||||
|
||||
<p class='note warning'>
|
||||
Note that python-firetv has support for multiple Amazon Fire TV devices. If you have more than one configured, be sure to specify the device ID in `device`. Run `firetv-server -h` and/or view the source for complete capabilities.
|
||||
In the dialog appearing on your Fire TV, you must check the box that says "always allow connections from this device." ADB authentication in Home Assistant will only work using a trusted key.
|
||||
</p>
|
||||
|
||||
Once you've successfully connected to your Fire TV via the command `adb connect <ipaddress>`, the files `adbkey` and `adbkey.pub` will be created on your computer. The default locations for these files are (from [https://developer.android.com/studio/command-line/adb](https://developer.android.com/studio/command-line/adb)):
|
||||
|
||||
* Linux and Mac: `$HOME/.android.`
|
||||
* Windows: `%USERPOFILE%\.android.`
|
||||
|
||||
Copy the `adbkey` and `adbkey.pub` files to your Home Assistant folder and add the path to the `adbkey` file to your configuration.
|
||||
|
||||
#### ADB Troubleshooting
|
||||
|
||||
If you receive the error message `Issue: Error while setting up platform firetv` in your log when trying to set up a Fire TV device with an ADB key, then there is probably an issue with your ADB key. Here are some possible causes.
|
||||
|
||||
1. ADB is not enabled on your Fire TV. To remedy this, enable ADB by following the instructions above.
|
||||
|
||||
2. Your key is not pre-authenticated. Before using the `adbkey` in Home Assistant, you _**must**_ connect to your Fire TV device using the ADB binary and tell the Fire TV to always allow connections from this computer. For more information, see the section "ADB Authentication (for Fire TV devices with recent software)" above.
|
||||
|
||||
3. Home Assistant does not have the appropriate permissions for the `adbkey` file and so it is not able to use it. Once you fix the permissions, the component should work.
|
||||
|
||||
4. You are already connected to the Fire TV via ADB from another device. Only one device can be connected, so disconnect the other device, restart the Fire TV (for good measure), and then restart Home Assistant.
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user