Stream your reMarkable screen over SSH.
reMarkable screen sharing over SSH.
On your host machine
lz4
on your host with your usual package manager.apt install liblz4-tool
will do the trick.ssh-copy-id [email protected]
.Note: the reMarkable 2 doesn't support
ed25519
keys. If it's your case, try generating anecdsa
orrsa
key. Try outssh [email protected]
, it should not prompt for [email protected]'s password.
zip
to a folder where you'll remember it (e.g. C:\Users\{username}\lz4
).ffmpeg
and lz4
directories to the windows Path
environment. Here is a quick guide how.
Path
variable under System variables, click edit.ffmpeg
directory, and one to the lz4
directory you created.bash
so the new Path
is used.ssh-keygen
.ssh-copy-id -i ~/.ssh/id_rsa [email protected]
ssh [email protected]
, it should not prompt for a password.The instructions below will install the files from the latest release.
In particular, 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 restream
.
Download reStream.sh and make it executable
$ chmod +x reStream.sh
If you save
reStream.sh
in aPATH
directory asreStream
, you can launch it asreStream
.
On Ubuntu, list these folders withecho $PATH
. One should be/usr/local/bin
.
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.
$ ssh [email protected] 'opkg install restream'
$ ssh [email protected] 'wget https://github.com/rien/reStream/releases/latest/download/restream.arm.static -O /home/root/restream && chmod +x /home/root/restream'
$ scp restream.arm.static [email protected]:/home/root/restream
$ ssh [email protected] 'chmod +x /home/root/restream'
./reStream.sh
in the script directory or reStream
if you've installed it in your PATH
-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: [email protected]
)-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 (--webcam
has 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 pv
to 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 -o --output
-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.If you have problems, don't hesitate to open an issue or send me an email.
On your host machine:
--webcam
--unsecure-connection
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 v4l-utils
.
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 netcat
.
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:
ffmpeg
to version 4.~.ssh/config
file 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.)PubkeyAcceptedKeyTypes=ssh-rsa
is required if you want to modify it:
Host remarkable
HostName 10.11.99.1
User root
PubkeyAcceptedKeyTypes=ssh-rsa
./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 target/armv7-unknown-linux-gnueabihf/release/restream
.
Using nix flakes
With Nix installed you can
create the development environment with nix-shell
or (when using
Nix flakes nix-develop
.
After which you can simply run cargo build --release
to 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.
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.