/RemarkableStreaming

Stream the Remarkable in 1 command

Primary LanguageShell

Remarkable Streaming

1. Install deps

The version of rMview made to work with a VNC server can be found at the vnc branch of this repository.

  1. Install the project

    ./install.sh

2. Run

  1. Configure by tweaking the rmview.json config

    {
      // all settings are optional, comments not allowed
      "ssh": {
        "address": "10.11.99.1", // works over WiFi too!
        "username": "root",
        "key": "~/.ssh/id_rsa_remarkable",
        // alternatively to key, "password": "****" is supported
        "timeout": 1 // in seconds
      },
      "orientation": "portrait", // auto for auto-detect, default: landscape
      "pen_size": 10, // set to 0 to disable
      "pen_color": "red",
      "pen_trail": 1000, // set to 0 to disable, default: 200
      "background_color": "black", // default: white
      "fetch_frame_delay": 0.03, // sleep 0.03s on remarkable before fetching new frame (default is no delay)
      "lz4_path_on_remarkable": "/usr/opt/lz4", // default: $HOME/lz4
      "hide_pen_on_press": false // hides pointer when pen touches display, default: true
    }
  2. Start streaming

    ./start.sh