Repository navigation
Installation
This guide takes you from a stock Android TV to Lumen as the home screen, and back again if you change your mind. Nothing here roots the TV or voids anything; every step can be undone.
- Before you start
- 1. Turn on developer options and debugging
- 2. Connect from your computer
- 3. Install the APK
- 4. Make Lumen the home screen
- 5. Allow notification access (optional)
- Updating
- Going back to the stock launcher
- Uninstalling
Supported
- Android TV 8.0 (API 26) or newer, including Android TV 14.
- Tested on an Acer (Realtek) Android TV 14 set with 1.5 GB of RAM.
Probably fine, not tested
- Google TV devices. The stock launcher there is
com.google.android.apps.tv.launcherxinstead ofcom.google.android.tvlauncher; use that name in the commands below.
Not supported
- Amazon Fire TV. Fire OS always sends the Home button to Amazon's own launcher and doesn't let you replace it.
You need
- A computer (Windows, macOS or Linux) on the same network as the TV.
-
Android SDK Platform-Tools, which
provides
adb. Unzip it and either add the folder to yourPATHor runadbfrom inside it. - The latest
lumen-vX.Y.Z.apkfrom the releases page. The.sha256file next to it lets you check the download (see Verifying the download).
Menu names vary a little between brands; these are the usual ones.
- Open Settings → Device Preferences → About (on some TVs: Settings → System → About).
- Select Build (sometimes Android TV OS build) seven times. You'll see "You are now a developer".
- Go back to Device Preferences → Developer options and turn on USB debugging. If there is a separate Network debugging or ADB over network switch, turn that on too.
- Find the TV's IP address under Settings → Network & Internet → (your network).
Some TVs turn network debugging off after a reboot. If
adb connectstops working later, check this switch first.
adb connect 192.168.1.50:5555 # replace with your TV's IP; 5555 is the usual port
adb devicesThe first time, the TV asks "Allow USB debugging?". Tick Always allow from this computer and
choose OK. adb devices should now list the TV as device.
adb devices shows |
Meaning | Fix |
|---|---|---|
unauthorized |
The prompt on the TV wasn't accepted | Look at the TV, accept the prompt, run adb devices again |
offline |
Connection dropped |
adb disconnect, then adb connect <ip>:5555 again |
nothing / failed to connect
|
Wrong IP, debugging off, or different network | Re-check the IP and the debugging switch; make sure both devices are on the same network |
If more than one device is connected, add -s <ip>:5555 after adb in every command below.
adb install -r lumen-v1.2.0.apkSuccess means it's installed. Nothing changes on screen yet.
If you get INSTALL_FAILED_UPDATE_INCOMPATIBLE, a copy of Lumen signed with a different key is already
on the TV. See Troubleshooting.
# macOS / Linux
shasum -a 256 lumen-v1.2.0.apk
# Windows (PowerShell)
Get-FileHash lumen-v1.2.0.apk -Algorithm SHA256The hash must match the one in lumen-v1.2.0.apk.sha256.
First, set Lumen as the default home app:
adb shell cmd role add-role-holder --user 0 android.app.role.HOME com.lumen.tvlauncher 0
adb shell input keyevent KEYCODE_HOMEIf Lumen appears, you're done.
Many Android TV builds ignore the default and always send the Home button to the stock launcher. If pressing Home still shows the old launcher, disable it:
adb shell pm disable-user --user 0 com.google.android.tvlauncher
adb shell input keyevent KEYCODE_HOMEThis only hides the stock launcher for your user; it stays installed and keeps its data. Bring it back
any time with adb shell pm enable com.google.android.tvlauncher.
Important: while the stock launcher is disabled, don't uninstall Lumen without re-enabling the stock launcher first. Otherwise the TV has no home screen and falls back to a bare settings screen. Uninstalling shows the safe order.
The bell in the top bar shows a badge and a list of notifications. Android needs your permission for that:
adb shell cmd notification allow_listener com.lumen.tvlauncher/com.lumen.tvlauncher.NotificationServiceOn TVs that have the screen for it, you can also select the bell in Lumen; without permission it opens Notification access so you can switch it on there. Everything else works without this permission.
Install the new APK over the old one. Your favourites, names and settings are kept:
adb install -r lumen-v1.3.0.apkUpdates only install over a build signed with the same key. Official releases are always signed with the same key.
adb shell pm enable com.google.android.tvlauncher
adb shell cmd role add-role-holder --user 0 android.app.role.HOME com.google.android.tvlauncher 0
adb shell input keyevent KEYCODE_HOMELumen stays installed and can be made the home app again later.
Always restore the stock launcher before removing Lumen:
adb shell pm enable com.google.android.tvlauncher
adb shell cmd role add-role-holder --user 0 android.app.role.HOME com.google.android.tvlauncher 0
adb uninstall com.lumen.tvlauncherIf you used the TV tools, restore.ps1 -RemoveLumen does all of this, and also
re-enables everything the debloat script turned off.
Last resort: a factory reset (Settings → Device Preferences → Reset) removes Lumen and re-enables every app. It also erases your accounts and apps, so try the steps above first.
This wiki is generated from the docs/ folder of the repository. To suggest a change, edit the file there and open a pull request.
Using Lumen
Development