Jellyfin for Android TV debugging guide

guide.md

Jellyfin for Android TV debugging guide

Install ADB

ADB (Android Debug Bridge) is a command-line tool that allows you to communicate with Android devices. It is bundled with Android Studio or available as standalone download.

Connect to an Android TV device with ADB

Enable developer mode on Android TV

The steps to enable developer mode might vary depending on your device and Android version. If the instructions below do not match your device, please search online for specific instructions for your device model.

1. Go to Settings on your Android TV.
2. Navigate to Device Preferences > About.
3. Scroll down to Build and click it repeatedly (about 7 times) until you see a message saying "You are now a developer!"
4. Go back to Device Preferences and you will now see a new option called Developer options.
5. Open Developer options and enable USB Debugging and Network Debugging.

Connect to Fire TV with ADB

1. Go to Settings on your Fire TV.
2. Navigate to My Fire TV > About and click on Build repeatedly (about 7 times) until Developer options are enabled.
3. Go back to My Fire TV and open Developer options.
4. Enable ADB Debugging and Apps from Unknown Sources.

Connect to Android TV via ADB

1. Find the IP address of your Android TV. Go to Settings > Network & Internet and select your network to see the IP address.
2. On your computer, open a terminal or command prompt.
3. Connect to the Android TV using the IP address:

   adb connect <ANDROID_TV_IP_ADDRESS>

4. You will see a prompt on your Android TV asking for permission to connect. Allow it.

How to side-load Jellyfin with ADB

1. Ensure your device is connected via ADB:

   adb devices

   Your device should be listed.

2. Install the APK file:

   adb install <PATH_TO_APK_FILE>

How to get logs for the Jellyfin app with ADB

1. Ensure your device is connected via ADB:

   adb devices

   Your device should be listed.

2. Use adb logcat to read all logs from your device:

   adb logcat

3. Optionally filer the logs using grep:

   adb logcat | grep -i 'org.jellyfin.androidtv'

Get the APK from a pull request

If you're testing changes from a specific pull request (PR), you can download the APK generated by the build workflow. You'll be able to sideload this along with the stable version of the app. Follow these steps to download and install the APK:

1. Navigate to the Pull Request:

   • Go to the Jellyfin for Android TV GitHub repository.
   • Find the pull request that you want to test under the "Pull requests" tab. Click on the relevant PR to open it.

2. Open the Build Workflow:

   • In the PR page, scroll down to the "Checks" section. This section contains details of the automated tests and build workflows that run for the pull request.
   • If the section is collapsed click on "Show all checks".
   • Look for the workflow labeled "App / Build / Build." Click on "Details" next to the successful build.

3. Locate the APK Artifact:

   • In the workflow page, go to the "Summary" tab.
   • Scroll down to the "Artifacts" section. This section lists the files generated by the build, including the APKs.
   • You should see an artifact named build-artifacts. Click on the artifact to download it.

4. Unpack the ZIP file:

   • Unpack the jellyfin-androidtv-v0.0.0-dev.1-debug.apk file from the downloaded ZIP file

5. Install the APK on Your Android TV:

   • Follow the instructions above to install the debug version of the app.