2020-02-12 13:19:06 +01:00
# reStream
2020-03-12 00:17:13 +01:00
reMarkable screen sharing over SSH.
2020-03-12 00:29:18 +01:00
2020-03-12 08:43:17 +01:00
## Installation
2020-03-30 21:33:44 +02:00
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` .
2020-03-12 08:43:17 +01:00
2020-03-12 00:17:13 +01:00
## Usage
1. Connect your reMarkable with the USB cable.
2. Make sure you can [open an SSH connection ](https://remarkablewiki.com/tech/ssh ).
2020-03-31 15:32:20 +02:00
3. Run `./reStream.sh` for landscape mode, or `./reStram.sh -p` for portrait mode.
2020-03-12 08:43:17 +01:00
4. A screen will pop-up on your local machine, with a live view of your reMarkable!
2020-03-12 00:17:13 +01:00
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 ).
2020-02-12 13:19:06 +01:00
## Requirements
On your **host** machine:
- Any POSIX-shell (e.g. bash)
2020-02-12 13:51:59 +01:00
- ffmpeg (with ffplay)
2020-02-12 13:19:06 +01:00
- ssh
2020-03-12 00:17:13 +01:00
On your **reMarkable** nothing is needed, unless you want...
### Sub-second latency
2020-03-17 23:44:55 +01:00
To achieve sub-second latency, you'll need [lz4 ](https://github.com/lz4/lz4 )
on your host and on your reMarkable.
2020-03-12 00:17:13 +01:00
2020-03-17 23:44:55 +01:00
You can install `lz4` on your host with your usual package manager. On Ubuntu,
`apt install liblz4-tool` will do the trick.
2020-03-12 00:17:13 +01:00
2020-03-17 23:44:55 +01:00
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.
2020-02-12 14:47:47 +01:00
2020-03-25 16:33:22 +01:00
Copy the `lz4` program to your reMarkable with
`scp lz4.arm.static root@10.11.99.1:~/lz4` , make it executable with
`ssh root@10.11.99.1 'chmod +x ~/lz4'` and you're ready to go.
2020-03-30 21:35:15 +02:00
## Troubleshooting
Steps you can try if the script isn't working:
- [Set up an SSH key ](#installation )
- Update `ffmpeg` to version 4.
