Readme

Based on reStream

Please note that this project is still under heavy development. If you run this program, anyone on your network could connect to your reMarkable and stream the contents of your screen.

Dependencies

You need

• Gstreamer
• Gstreamer Plugins Base
• Gstreamer Plugins Good

Ubuntu

sudo apt install libgstreamer1.0-0 gstreamer1.0-plugins-base gstreamer1.0-plugins-good

openSUSE

sudo zypper install gstreamer gstreamer-plugins-base gstreamer-plugins-good

Usage

Server

The must be running.

To install it, first build (see later in this document) and then copy it to your reMarkable.

scp review-server.arm.static root@${REMARKABLE_IP}:review-server

And then start it manually.

ssh root@${REMARKABLE_IP} 'RUST_LOG=trace ./review-server --port 6680'

Note: server does not exit when you abort the SSH command above. Consider running the server in a SSH session.

TODO: Install it as service

Client

Options for the client can be set as command line options or environment variables. Command line options override the environment variables.

Values with no default value in their description have to be set (for example --ssh-key).

Command Line Options

Usage: review-client [OPTIONS]

Options:
      --remarkable-ip <remarkable-ip>  IP of the reMarkable tablet (default: 10.11.99.1)
      --tcp-port <tcp-port>            TCP port for video stream (default: 6680)
      --framerate <framerate>          Framerate (default: 50)
      --dark-mode                      Dark mode - invert colors (default: false)
      --show-cursor                    Show cursor (default: false)
  -h, --help                           Print help
  -V, --version                        Print version

Environment Variables

Corresponding keys:

• REMARKABLE_IP
• REMARKABLE_TCP_PORT

• REMARKABLE_FRAMERATE
• REMARKABLE_DARK_MODE
• REMARKABLE_SHOW_CURSOR

Building

Client

Just build it

cargo build --release --bin review-client

Or with dagger

dagger call build-client --source . export --path review-client

Server

With dagger

dagger call build-server --source . export --path review-server.arm.static

Development

Additional Dependencies

openSUSE

sudo zypper in gstreamer-devel gstreamer-plugins-base-devel