Using pyatv and uc-integration-api
The driver discovers Apple TV devices on the network and pairs them using AirPlay and companion protocols. A media player entity is exposed to the Remote Two.
Supported versions:
- Apple TV 4 and newer models with TvOS 16+
Supported attributes:
- State (on, off, playing, paused, unknown)
- Title
- Album
- Artist
- Artwork
- Media duration
- Media position
Supported commands:
- Turn on & off (device will be put into standby)
- Next / Previous
- Rewind / Fast-forward
- Volume up / down
- Play/pause
- Directional pad navigation and select
- Context menu
- Home screen
- Control center
- Launch application
- App switcher
- Start screensaver
Please note that certain commands like channel up & down are app dependant and don't work with every app!
- Requires Python 3.11
- Install required libraries:
(using a virtual environment is highly recommended)
pip3 install -r requirements.txt
For running a separate integration driver on your network for Remote Two, the configuration in file driver.json needs to be changed:
- Set
driver_id
to a unique value,uc_appletv_driver
is already used for the embedded driver in the firmware. - Change
name
to easily identify the driver for discovery & setup with Remote Two or the web-configurator. - Optionally add a
"port": 8090
field for the WebSocket server listening port.- Default port:
9090
- This is also overrideable with environment variable
UC_INTEGRATION_HTTP_PORT
- Default port:
UC_CONFIG_HOME=./ python3 intg-appletv/driver.py
See available environment variables in the Python integration library to control certain runtime features like listening interface and configuration directory.
The configuration file is loaded & saved from the path specified in the environment variable UC_CONFIG_HOME
.
Otherwise, the HOME
path is used or the working directory as fallback.
The client name prefix used for pairing can be set in ENV variable UC_CLIENT_NAME
. The hostname is used by default.
After some tests, turns out python stuff on embedded is a nightmare. So we're better off creating a single binary file that has everything in it.
To do that, we need to compile it on the target architecture as pyinstaller
does not support cross compilation.
On x86-64 Linux we need Qemu to emulate the aarch64 target platform:
sudo apt install qemu binfmt-support qemu-user-static
docker run --rm --privileged multiarch/qemu-user-static --reset -p yes
Run pyinstaller:
docker run --rm --name builder \
--platform=aarch64 \
--user=$(id -u):$(id -g) \
-v "$PWD":/workspace \
docker.io/unfoldedcircle/r2-pyinstaller:3.11.6 \
bash -c \
"python -m pip install -r requirements.txt && \
pyinstaller --clean --onefile --name intg-appletv intg-appletv/driver.py"
On an aarch64 host platform, the build image can be run directly (and much faster):
docker run --rm --name builder \
--user=$(id -u):$(id -g) \
-v "$PWD":/workspace \
docker.io/unfoldedcircle/r2-pyinstaller:3.11.6 \
bash -c \
"python -m pip install -r requirements.txt && \
pyinstaller --clean --onefile --name intg-appletv intg-appletv/driver.py"
We use SemVer for versioning. For the versions available, see the tags and releases in this repository.
The major changes found in each new release are listed in the changelog and under the GitHub releases.
Please read our contribution guidelines before opening a pull request.
This project is licensed under the Mozilla Public License 2.0. See the LICENSE file for details.