reMarkable screen sharing over SSH.
On your host machine
- Any POSIX-shell (e.g. bash)
- ffmpeg (with ffplay)
lz4on your host with your usual package manager.
apt install liblz4-toolwill do the trick.
- Set up an SSH key and add it to the ssh-agent, then add your key to the reMarkable with
Note: the reMarkable 2 doesn't support
ed25519keys. If it's your case, try generating an
rsakey. Try out
ssh email@example.com, it should not prompt for firstname.lastname@example.org's password.
- Install ffmpeg for windows.
- Download lz4 for windows and extract the
zipto a folder where you'll remember it (e.g.
- Add the
lz4directories to the windows
Pathenvironment. Here is a quick guide how.
- Control Panel > Edit the system environment variables > Environment Variables
- Find the
Pathvariable under System variables, click edit.
- Add two New entries: one to the bin directory in the
ffmpegdirectory, and one to the
lz4directory you created.
- Click OK
bashso the new
- Generate a new ssh-key using
- Send the public key to the reMarkable (connect trough USB cable) using
ssh-copy-id -i ~/.ssh/id_rsa email@example.com
- Try out
ssh firstname.lastname@example.org, it should not prompt for a password.
The instructions below will install the files from the latest release.
reStream.sh is the executable on the host, and
restream.arm.static is the binary which has to be moved to the reMarkable with the name
Download reStream.sh and make it executable
$ chmod +x reStream.sh
If you save
reStream, you can launch it as
On Ubuntu, list these folders with
echo $PATH. One should be
As root, download the executable there:
# wget https://github.com/rien/reStream/releases/latest/download/reStream.sh -O /usr/local/bin/reStream # chmod +x /usr/local/bin/reStream
You can install
restream on reMarkable in three ways.
- Install via toltec if you use it.
$ ssh email@example.com 'opkg install restream'
- If you have access to internet on your reMarkable, download directly the binary onto it:
$ ssh firstname.lastname@example.org 'wget https://github.com/rien/reStream/releases/latest/download/restream.arm.static -O /home/root/restream && chmod +x /home/root/restream'
- Download the restream binary onto your host, move it to reMarkable and make it executable.
$ scp restream.arm.static email@example.com:/home/root/restream $ ssh firstname.lastname@example.org 'chmod +x /home/root/restream'
- Connect your reMarkable with the USB cable.
- Make sure you can open an SSH connection.
./reStream.shin the script directory or
reStreamif you've installed it in your PATH
- A screen will pop-up on your local machine, with a live view of your reMarkable!
-h --help: show usage information
-p --portrait: shows the reMarkable screen in portrait mode (default: landscape mode, 90 degrees rotated tot the right)
-s --source: the ssh destination of the reMarkable (default:
-o --output: path of the output where the video should be recorded, as understood by
ffmpeg; if this is
-, the video is displayed in a new window and not recorded anywhere (default:
-f --format: when recording to an output, this option is used to force the encoding format; if this is
ffmpeg’s auto format detection based on the file extension is used (default:
-w --webcam: record to a video4linux2 web cam device. By default the first found web cam is taken, this can be overwritten with
-o. The video is scaled to 1280x720 to ensure compatibility with MS Teams, Skype for business and other programs which need this specific format. See Video4Linux Loopback for installation instructions.
--mirror: mirror the web cam video (
--webcamhas to be set). By default or as only choice, some programs, such as Zoom and Discord, mirror the camera. This flag restores the correct orientation.
-m --measure: use
pvto measure how much data throughput you have (good to experiment with parameters to speed up the pipeline)
-t --title: set a custom window title for the video stream. The default title is "reStream". This option is disabled when using
-u --unsecure-connection: send framebuffer data over an unencrypted TCP-connection, resulting in more fps and less load on the reMarkable. See Netcat for installation instructions.
On your host machine:
- Video4Linux Loopback kernel module if you want to use
- netcat if you want to use
To set your remarkable as a webcam we need to be able to fake one. This is where the Video4Linux Loopback kernel module comes into play. We need both the dkms and util packages. On Ubuntu you need to install:
# apt install v4l2loopback-utils v4l2loopback-dkms
In some package managers
v4l2loopback-utils is found in
After installing the module you must enable it with
# modprobe v4l2loopback
To verify that this worked, execute:
$ v4l2-ctl --list-devices
The result should contain a line with "platform:v4l2loopback".
To use an unsafe and faster connection, we need the command
nc, abbreviation of
If your system does not provide
nc, the output of
command -v nc is empty. In this case you need to install it.
Several implementations of
netcat exists. On Ubuntu, you can install the version developed by OpenBSD, which is light and supports IPv6:
# apt install netcat-openbsd
Steps you can try if the script isn't working:
- Set up an SSH key
ffmpegto version 4.
- Make sure RSA keys are allowed on your system:
- In some modern Unix distributions, RSA keys are considered "legacy" and will no longer work out of the box.
- Therefore you need to add a section to your
~.ssh/configfile to allow use of RSA ssh keys for specified hosts. (according to https://remarkablewiki.com/tech/ssh, Remarkable devices might not work with non-RSA keys, which is the reason for why this is necessary.)
- This example should work without any additional configuration, although
PubkeyAcceptedKeyTypes=ssh-rsais required if you want to modify it:
Host remarkable HostName 10.11.99.1 User root PubkeyAcceptedKeyTypes=ssh-rsa
- You can then use the -s flag to connect to the Remarkable:
./reStream.sh -s remarkable
If you want to play with the
restream code, you will have to install Rust.
There are three ways of building the required restream binary for streaming the reMarkable framebuffer. For these approaches, the generated restream binary will be located under
Using nix flakes With Nix installed you can create the development environment with
nix-shellor (when using Nix flakes
nix-develop. After which you can simply run
cargo build --releaseto build the restream binary on your machine.
Using docker and the toltec toolchain: You can use the toltec toolchain docker images to build a restream binary compatible with the reMarkable.
docker run --rm -v $(pwd):/project -v /project/.cargo -w "/project" ghcr.io/toltec-dev/rust:latest cargo build --release --target=armv7-unknown-linux-gnueabihf
Using the reMarkable toolchain: Setup the reMarkable toolchain to do cross-platform development.
Like using reStream?
I made this project in my spare time and received help from a handful of wonderful contributors. If you want to say thanks, please send me an email and be sure to mention how you are using this project.
I do not accept donations. There are charities that need more financial support than I do, so please consider supporting a local charity instead. Preferably one that promotes diversity in technology like GirlsWhoCode, CoderDojo, etc.