A simple app to mirror existing TRMNL's content to your Android device (preferably e-ink display).

You must have a valid access-token to access the screen content using TRMNL server API.

Here are some of the known ways you can get access to the access-token.

1. You must own a TRMNL device with "developer edition" add-on purchased
2. You have purchased their BYOD product.
3. You have self-serve installation of TRMNL service using BYOS

⬇️ Install the APK on your Android device.

1. Configure the API access-token in the app settings
   i. 📝 NOTE: Right now only https://trmnl.app/api/ service API is supported, custom service URL support will be added later
2. Save the token and keep the app always-on with the TRMNL's display image showing.

Check installable APK from Assets in latest release.

▶️ See full demo

1. Right now, screen lock using Google's recommended FLAG_KEEP_SCREEN_ON is not working on e-Ink tablet due to strict battery optimization. So, if you plan to keep the screen on indefinitely, you should set that in the device settings.
   • On normal Android tablet or device, screen wake lock should work. However it's not recommended to use it without device being always plugged-in 🔌.
2. Currently the app uses Android WorkManager to schedule refresh job and it has minimum interval of ⏰ 15 min between jobs. So, if your TRMNL is setup to refresh every 5 min, you will not see it refresh until 15 min is elapsed.
   • This can be overcome by using some clever logic or not using WorkManager. However, this is a OS optimized and reliable way to refresh image periodically.

The TRMNL Display Mirror app serves as a digital display mirror for TRMNL e-ink devices. The app connects to the TRMNL API, fetches display data, and shows it on Android devices.

• Token-based authentication with the TRMNL API
• Automatic periodic image refresh from the server
• Adaptive refresh rate based on server response config
• Manual refresh capabilities
• Image caching for offline viewing
• Refresh history logging for tracking & validation

This guide will help you get started with the TRMNL Display Mirror Android application development.

git clone https://github.com/usetrmnl/trmnl-android.git
cd trmnl-android

• https://usetrmnl.com/
• https://usetrmnl.com/integrations
• https://github.com/usetrmnl/trmnl-display