📱 Apps

Apple TV

ImmichFrame is available on the Apple TV App Store.

iOS and iPadOS

You can "install" ImmichFrame as a PWA by opening in a browser and going to Share Menu-Add to Homescreen.

Android

The Android-Version of ImmichFrame is available on the Google Play Store. Download it via the store for automatic updates. You can also sideload via APK available in Releases.

Android Screensaver

How to Set Immich Frame as Android TV Screensaver Video Tutorial

Run the app normally and configure settings.
Go to Settings > Display > Advanced > Screen Saver > Current Screen Saver and choose ImmichFrame. Settings > Display > Advanced > Sleep, choose your sleep timeout. The menu options may differ slightly on different Android versions.
- Enable Developer Mode on your Android TV Settings
- Enable usb debugging
- Add adb to your system variables so we can execute it in powershell/terminal/cmd
- Connect to the android tv device you want the screensaver on by running terminal/cmd/powershell
```
adb connect 192.168.xx.xxx
```
  (192.168.xx.xxx will be your android tv internal ip ie. 192.168.1.227) you should see a prompt on your TV screen saying enable adb debugging. Click the checkmark and select ok. (Sometimes you may need to run the command a second time to get it to connect)
- If you are unable to set ImmichFrame as a screen saver you may need to run this ADB command
```
adb shell settings put secure screensaver_components com.immichframe.immichframe/.ScreenSaverService
```
- To view screensaver timeout use this ADB command
```
adb shell settings get system screen_off_timeout
```
- To set screensaver timeout use this ADB command
```
adb shell settings put system screen_off_timeout 60000
```
  (timeout is is ms, so this would be 60 seconds).
- Once done disconnect using command
```
adb disconnect 192.168.xx.xxx
```
  then re-do the above steps for any other device you want to change the screensaver to immichframe on another android tv device

Remote Control

The Android app runs a small local HTTP server on port 53287 that accepts commands dim, undim, next, previous, pause, settings, brightness?value=x.
Brightness value must be a float between 0.00 and 1.00, or -1.00 to use the system default.
Examples:

curl http://192.168.0.136:53287/next

curl "http://192.168.0.136:53287/brightness?value=0.5"

Frameo

ImmichFrame can be run on inexpensive Frameo digital photo frames with some additional effort. You can typically find these for ~$40 USD. These devices are low powered and run a very old Android version, so they cannot run the full WebView version of the app (however most of the main features are still supported except SplitView). We have found a method to update the WebView, but it is not without risks, see Frameo Webview Update below.
If you have not already, you will need to install ADB on your PC (ADB instructions). ADB is often enabled on these devices by default, if it is not go to Frameo Settings-About-Enable Beta Program. Toggle ADB Access On-Off-On. Use the ADB commands below to sideload ImmichFrame APK, configure it to your liking, then disable the Frameo app to to set ImmichFrame as default Home app:

Sideload ImmichFrame:

adb install /path/to/ImmichFrame_vXX.apk

Update existing ImmichFrame:

adb install -r /path/to/ImmichFrame_vXX.apk

Start ImmichFrame:
```
adb shell am start com.immichframe.immichframe/.MainActivity
```
- Swipe down to enter ImmichFrame Settings
- Configure URL and Authorization Secret (optional)
- Disable WebView
Set as default HOME app
- On first reboot after install you will be asked to select default Launcher, select ImmichFrame
- Alternatively you can disable Frameo
```
adb shell su
pm disable net.frameo.frame
exit
```
  If this doesn't stick on reboot, repeat the commands but power cycle after exit command
Some other useful ADB commands:
- Reboot:
```
adb reboot
```
  - You can also reboot or shutdown by holding down power button
- Access Android Settings:
```
adb shell am start -a android.settings.SETTINGS
```
- Re-enable Frameo: repeat disable commands above but replace "disable" with "enable"
- Start Frameo app:
```
adb shell am start net.frameo.frame
```
- Uninstall ImmichFrame:
```
adb uninstall com.immichframe.immichframe
```

Frameo WebView Update

Follow instructions below to update WebView to 106. This has been tested and working on Android 6.01 10.1" Frameo devices:

Download WebView 106 to PC: Lineage OS WebView 106-0-5249-126-12

Push new apk to sdcard

adb push /path/to/your/new/webview.apk /sdcard/

Enter root shell
```
adb shell su
```

Backup original WebView APK

mount -o rw,remount /system && cp /system/app/webview/webview.apk /system/app/webview/webview.apk.bak

Delete the oat folder recursively

mount -o rw,remount /system && rm -rf /system/app/webview/oat

Copy new WebView to system

mount -o rw,remount /system && cp /sdcard/webview.apk /system/app/webview/webview.apk

exit root
```
exit
```
Reboot device
```
adb reboot
```

Desktop (Windows, MacOS, Linux)

Get the latest Desktop-App from the GitHub Releases-Page.

The screen is configured in a 3x3 gird. You can touch or click:

-	Settings	-
Prev image	Pause	Next image
-	Quit	-

MacOS

Open DMG, drag immichframe.app to applications folder.
If you get an error that it is "damaged and can't be opened, you should move it to the trash" run following command in terminal.
```
xattr -c /Applications/immichframe.app
```

Keyboard

Settings - Up arrow
Quit - Down arrow
Prev Image - Left arrow
Next Image - Right arrow
Pause - Enter/Return

Apple TV​

iOS and iPadOS​

Android​

Android Screensaver​

Remote Control​

Frameo​

Frameo WebView Update​

Desktop (Windows, MacOS, Linux)​

MacOS​

Keyboard​