https://github.com/happyleavesaoc/python-firetv
https://github.com/happyleavesaoc/python-firetv
adb firetv python2
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/happyleavesaoc/python-firetv
- Owner: happyleavesaoc
- License: mit
- Created: 2015-10-07T19:32:26.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2020-10-16T18:47:35.000Z (over 4 years ago)
- Last Synced: 2025-03-30T11:08:55.005Z (about 2 months ago)
- Topics: adb, firetv, python2
- Language: Python
- Size: 107 KB
- Stars: 186
- Watchers: 22
- Forks: 38
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# python-firetv
`firetv` is a Python 2 and 3 package that provides state information and some control of an Amazon Fire TV device over a network. This is achieved via ADB, so therefore requires [ADB Debugging](https://developer.amazon.com/docs/fire-tv/connecting-adb-to-device.html) to be turned on. It includes `firetv-server`, an HTTP server to facilitate RESTful access to configured devices.
## Installation
Install the package using the command:
`pip install firetv`
If you want the HTTP server component installed as a script, use:
`pip install firetv[firetv-server]`
**NOTE:** You may need to install the following ADB dependencies via your package manager:
* with `apt-get`: `swig libssl-dev python-dev libusb-1.0-0`
* with `yum`: `swig openssl-devel python-devel libusbx-devel`
## Server
To run the server when installed as a script:
`firetv-server`
If you want to set a default Amazon Fire TV device:
`firetv-server -d X.X.X.X:5555`
If you want to run on a port other than `5556`:
`firetv-server -p XXXX`
### systemd
Copy the `firetv.service` file to `/etc/systemd/system/`. Modify the `ExecStart` path and arguments as necessary.
```bash
systemctl enable firetv.service # Enable on boot
systemctl start firetv.service # Start server
systemctl stop firetv.service # Stop server
```
### Persistence
To store multiple Amazon Fire TV devices persistent, you can load a yaml config file:
`firetv-server -c some/config/file.yaml`
The config file has to be in the following format:
```yaml
devices:
sleepingroom:
host: 192.168.0.13:5555
livingroom:
host: 192.168.0.16:5555
```
*Note: If you use -d and -c option together you must not name one of the devices in config file `default` or give one of the devices the same host as in -d option.*
### Routes
All routes return JSON.
- `GET /devices/list` (list all registered devices and state)
- `GET /devices/connect/` (force connection attempt)
- `GET /devices/state/` (return state)
- `GET /devices/action//` (request action)
- `GET /devices//apps/running` (return running user apps)
- `GET /devices//apps//start` (start an app)
- `GET /devices//apps//stop` (stop an app)
- `GET /devices//apps//state` (check app state)
- `GET /devices//apps/state/` (check app state, deprecated format)
- `POST /devices/add` (see below)
#### Add A Device
If you use the `-d` option, the specified device is added automatically with the device identifier `default`. If you want to add further devices, or don't want to use the command line option for the initial device, use the `POST /devices/add` route. The device identifier can be any string meaningful to you, matching [`[-\w]`](https://docs.python.org/2/library/re.html) (any alphanumeric character, plus `-`).
POST JSON in the following format with the HTTP header `Content-Type: application/json`:
```json
{
"device_id": "",
"host": "
:"
}
```
## Features
`firetv` can detect device state and issue a number of actions. It can also get the running state of user apps.
### Detected States
- `off` (TV screen is dark)
- `standby` (standard UI is active - not apps)
- `idle` (screen saver is active)
- `play` (video is playing)
- `pause` (video is paused)
- `disconnected` (can't communicate with device)
### Actions
- `turn_on` (turn on the device, showing the UI on screen)
- `turn_off` (turn off the device, screen goes dark)
- `home` (emulate Home button)
- `media_play_pause` (emulate Play/Pause button)
- `media_play` (simulate Play button)
- `media_pause` (simulate Pause button)
- `media_next` (emulate Fast-Forward button)
- `media_previous` (emulate Rewind button)
- `volume_up` (raise volume)
- `volume_down` (lower volume)
### Apps
- `GET /devices//apps/running`
- `/devices//apps/state/`
- `/devices//apps//state`
app_id can be anything from a single word, e.g. 'netflix' or the full package name, e.g. com.netflix.ninja
You can start or stop an app with the following commands:
- `GET /devices//apps//start`
- `GET /devices//apps//stop`
app_id must be a package name, e.g. org.xbmc.kodi or com.netflix.ninja
## Contribution
This package does not fully exploit the potential of ADB access to Amazon Fire TV devices, and lacks some robustness. Contributions are welcome.