reStream
reMarkable screen sharing over SSH.
Installation
- Clone this repository:
git clone https://github.com/rien/reStream
. - (Optional but recommended) Install lz4 on your host and reMarkable.
- Set up an SSH key and add it to the ssh-agent, then add your key to the reMarkable with
ssh-copy-id [email protected]
.
Usage
- Connect your reMarkable with the USB cable.
- Make sure you can open an SSH connection.
- Run
./reStream.sh
- A screen will pop-up on your local machine, with a live view of your reMarkable!
Options
-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 byffmpeg
; 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.-t --throughput
: usepv
to measure how much data throughput you have (good to experiment with parameters to speed up the pipeline)
If you have problems, don't hesitate to open an issue or send me an email.
Requirements
On your host machine:
- Any POSIX-shell (e.g. bash)
- ffmpeg (with ffplay)
- ssh
- Video4Linux loopback kernel module if you want to use
--webcam
On your reMarkable nothing is needed, unless you want...
Sub-second latency
To achieve sub-second latency, you'll need lz4 on your host and on your reMarkable.
You can install lz4
on your host with your usual package manager. On Ubuntu,
apt install liblz4-tool
will do the trick.
On your reMarkable you'll need a binary of lz4
build for the arm platform,
you can do this yourself by installing the reMarkable toolchain
and compiling lz4
from source with the toolchain enabled, or you can use the
statically linked binary I have already built and put in this repo.
Copy the lz4
program to your reMarkable with
scp lz4.arm.static [email protected]:/home/root/lz4
, make it executable with
ssh [email protected] 'chmod +x /home/root/lz4'
and you're ready to go.
Video4Linux Loopback
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".
Troubleshooting
Steps you can try if the script isn't working:
- Set up an SSH key
- Update
ffmpeg
to version 4.