60 lines
2.6 KiB
Markdown
60 lines
2.6 KiB
Markdown
# reStream
|
||
|
||
reMarkable screen sharing over SSH.
|
||
|
||
|
||
|
||
## Installation
|
||
|
||
1. Clone this repository: `git clone https://github.com/rien/reStream`.
|
||
2. (Optional but recommended) [Install lz4 on your host and reMarkable](#sub-second-latency).
|
||
3. [Set up an SSH key and add it to the ssh-agent](https://help.github.com/en/github/authenticating-to-github/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent), then add your key to the reMarkable with `ssh-copy-id root@10.11.99.1`.
|
||
|
||
## Usage
|
||
|
||
1. Connect your reMarkable with the USB cable.
|
||
2. Make sure you can [open an SSH connection](https://remarkablewiki.com/tech/ssh).
|
||
3. Run `./reStream.sh`
|
||
4. A screen will pop-up on your local machine, with a live view of your reMarkable!
|
||
|
||
### Options
|
||
|
||
- `-p --portrait`: shows the reMarkable screen in portrait mode (the default is landscape mode, 90 degrees rotated tot the right)
|
||
- `-s --source`: the ssh destination of the reMarkable (default: `root@10.11.99.1`)
|
||
- `-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: `-`).
|
||
|
||
If you have problems, don't hesitate to [open an issue](https://github.com/rien/reStream/issues/new) or [send me an email](mailto:rien.maertens@posteo.be).
|
||
|
||
## Requirements
|
||
|
||
On your **host** machine:
|
||
- Any POSIX-shell (e.g. bash)
|
||
- ffmpeg (with ffplay)
|
||
- ssh
|
||
|
||
On your **reMarkable** nothing is needed, unless you want...
|
||
|
||
### Sub-second latency
|
||
|
||
To achieve sub-second latency, you'll need [lz4](https://github.com/lz4/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](https://remarkablewiki.com/devel/qt_creator#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 root@10.11.99.1:/home/root/lz4`, make it executable with
|
||
`ssh root@10.11.99.1 'chmod +x /home/root/lz4'` and you're ready to go.
|
||
|
||
## Troubleshooting
|
||
|
||
Steps you can try if the script isn't working:
|
||
- [Set up an SSH key](#installation)
|
||
- Update `ffmpeg` to version 4.
|