hiro/rmview
1
0
Fork 0
mirror of https://github.com/vale981/rmview synced 2025-03-05 09:11:39 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions
rmview/README.md
Emanuele f4876c3b23 RM2 is unsupported
2020-12-09 19:44:03 +01:00

7.5 KiB
Raw Blame History

rMview: a fast live viewer for reMarkable 1

Demo

Features

  • Demo 🚀 here
  • Fast streaming of the screen of your reMarkable 1 to a window in your computer
  • UI for zooming, panning, rotating
  • Pen tracking: a pointer follows the position of the pen when hovering on the reMarkable
  • Clone a frame into separate window for reference
  • Save screenshots as PNG

⚠️ WARNING ⚠️: rMview supports reMarkable 1 only, see this issue. Support for reMarkable 2 may come once it gets wider diffusion and a reliable method to stream the framebuffer data is found.

📢 Volunteers needed: if you have experience with producing binary bundles with pyQt, and feel like contributing to the project, drop me a line!

Installation

  1. You will need Python3 on your computer.

    ⚠️ Please make sure pip is pointing to the Python3 version if your system has Python2 as well. If not, use pip3 instead of pip in what follows.

  2. The easiest installation method is by using pip:

    pip install .

    which will install all required dependencies and install a new rmview command. Alternatively you may want to install the dependencies (PyQt5, Paramiko, Twisted) with pip manually.

  3. On the reMarkable itself you need to install rM-vnc-server and its dependency mxc_epdc_fb_damage. Instructions can be found in the wiki. This last step will be automated in the near future.

To run the tool after installation just run rmview from a console.

⚠️ WARNING ⚠️: If you use Anaconda, please install the dependencies via conda (and not pip).

Tested with Python 3.8.2, PyQt 5.14.2, MacOs 10.15.4, reMarkable firmware 2.1.1.3.

Usage and configuration

You can invoke the program with

rmview [config]

the optional config parameter is the filename of a json configuration file. If the parameter is not found, the program will look for a rmview.json file in the current directory, or, if not found, for the path stored in the environment variable RMVIEW_CONF. If none are found, or if the configuration is underspecified, the tool is going to prompt for address/password.

Configuration files

The supported configuration settings are below. Look in file example.json for an example configuration. All the settings are optional.

Setting key Values Default
ssh Connection parameters (see below) {}
orientation "landscape", "portrait", "auto" "landscape"
pen_size diameter of pointer in px 15
pen_color color of pointer and trail "red"
pen_trail persistence of trail in ms 200
background_color color of window "white"
hide_pen_on_press if true, the pointer is hidden while writing true
show_pen_on_lift if true, the pointer is shown when lifting the pen true

Connection parameters are provided as a dictionary with the following keys (all optional):

Parameter Values Comments
address IP of remarkable tool prompts for it if missing
username username for ssh access on reMarkable default: "root"
key Local path to key for ssh not needed if password provided
password Password provided by reMarkable not needed if key provided
timeout connection timeout in seconds default: 1
insecure_auto_add_host ignores the check on the fingerprint default: false

⚠️ Connecting after an update: An update to the reMarkable tablet would change its "fingerprint" i.e. the identifier that signals we are connecting to the expected device (and not somebody impersonating it). When this happens you may get an error message upon connection. There are two main ways to fix this:

  1. Change your .known_hosts file to match the new fingerprint (you can get instructions by connecting manually via ssh).
  2. Set the insecure_auto_add_host setting to true, which will make rmview ignore the check. This is not recommended unless you are in a trusted network.

⚠️ Key format error: If you get an error when connect using a key, but the key seems ok when connecting manually with ssh, you probably need to convert the key to the PEM format (or re-generate it using the -m PEM option of ssh-keygen). See here for details.

To Do

  • Settings dialog
  • About dialog
  • Pause stream of screen/pen
  • Binary bundles for Window, Linux and MacOs (PyInstaller?)
  • Add interaction for Lamy button? (1 331 1 down, 1 331 0 up)
  • Remove dependency to Twisted in vnc branch

Legacy reStreamer-like version

There are two versions of rMview, presenting the same interface but using different back-ends (thus requiring different setups on the reMarkable):

  • The "VNC-based" version, in the vnc branch (default)
  • The "reStreamer-like" version, in the ssh branch

In my tests, the VNC version is a clear winner. The ssh branch of this repo hosts the reStreamer-like version for those who prefer it, but I am not planning to update it.

Credits

I took inspiration from the following projects:

Icons adapted from designs by Freepik, xnimrodx from www.flaticon.com

Thanks to @adem amd @ChrisPattison for their PRs.

Disclaimer

This project is not affiliated to, nor endorsed by, reMarkable AS. I assume no responsibility for any damage done to your device due to the use of this software.

Licence

GPLv3