diff --git a/docs/VNC.md b/docs/VNC.md new file mode 100644 index 00000000..dac45463 --- /dev/null +++ b/docs/VNC.md @@ -0,0 +1,64 @@ +# VNC + +This article describes how to use KlipperScreen through a remote connection. + +!!! warning + The experience may not be equal to run KlipperScreen natively, + depending on the device and network there maybe performance degradation or other issues + +## On the Host device (for example a Raspberry Pi): + + +1. [First installl KlipperScreen](Installation.md) +2. Install a vnc server package, for example: +```bash +sudo apt install tigervnc-standalone-server +``` +3. Create `launch_KlipperScreen.sh`: + +```bash +#!/usr/bin/env bash + +# Use display 10 to avoid clashing with local X server, if anyy +Xtigervnc -rfbport 5900 -noreset -AlwaysShared -SecurityTypes none :10& +DISPLAY=:10 $KS_XCLIENT& +wait +``` +4. Restart KlipperScreen or reboot the system: +```bash +sudo systemctl service KlipperScreen restart +``` +5. On KlipperScreen set the following configuration: + +Display timeout: off + + +DPMS: off + +## On the remote device: + +1. Installa a VNC viewer and configure it to the ip of the host. + + +???+ example "Example using an iPad" + * Install a VNC viewer for example: `RealVNC Viewer: Remote Desktop` + #### Prevent unwanted rotation of UI: + * Go to `Settings` > `General` > Set `Use side switch to` to `Lock Rotation` + #### Avoid accidentally switching between apps: + * Go to `Restrictions` > Set passcode > Enable restrictions. + * Open + * Triple-click "Home" button + * Guided access pops up + * Press "Start" + * Now iPad is locked to VNC viewer until "Guided access" mode is disabled by triple-clicking "Home" button and entering the restrictions password. + #### On the VNC viewer: + * Press "+" button at the top right + * Enter IP address of your print host. + * Press "Save" + * Select "Interaction", select "Touch panel", go back + * Press "Done" + * Double-click on an icon with IP address you have just added. + * VNC client will complain about unencrypted connection. Disable the warning and say "Connect" + * Use or skip tutorial + * Press the "Pin" icon to hide the panel. + * Enjoy! diff --git a/mkdocs.yml b/mkdocs.yml index 05664685..c9c3db97 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -13,8 +13,10 @@ nav: - Configuration.md - Quicktips.md - Macros: macros.md - - Android.md - Thumbnails.md + - Remote screens: + - VNC.md + - Xserver-XSDL (Android): Android.md - Troubleshooting: - First Steps/Log: Troubleshooting.md - Network: Troubleshooting/Network.md