reSnap

reMarkable screenshots over ssh.

Prequisites

• SSH-access to your reMarkable tablet. Tutorial
  (recommended: SSH-key so you don't have to type in your root password every time)

• The following programs are required on your computer:

  • ffmpeg
  • feh

Usage

1. Connect your reMarkable via USB
2. Run

./reSnap.sh

Options

• -s --source You can specify a custom IP. If you want to use reSnap over the Wifi, specify the IP of your reMarkable here.
• -o --output You can specify a custom output file for reSnap.
• -l --landscape Snapshot has now the landscape orientation.
• -d --display Force program to display the snapshot. (overwrites environment variable)
• -n --no-display Force program to not display the snapshot.
• -c --og-color Turn off color correction (color correction is only active for the reMarkable2)
• -p --og-pixel-format Turns off the byte correction (use this if your reMarkable is on version < 3.6)
• -x --clipboard Copies the result into the clipboard.
• -f --sketch Removes the white background from the result.
• -v --version Displays version.
• -h --help Displays help information.

Environment Variables

• REMARKABLE_IP Default IP of your reMarkable.
• RESNAP_DISPLAY Default behavior of displaying the snapshot. See options -d and -n.
• REMARKABLE_INVERT_COLORS Default behavior of color inversion. See option -i.
• RESNAP_COLOR_CORRECTION Default behavior of color correction on the reMarkable2. See option -c.
• RESNAP_BYTE_CORRECTION Default behavior of color correction on the reMarkable2 version >= 3.6. See option -b.

RESNAP_DISPLAY, RESNAP_COLOR_CORRECTION and RESNAP_BYTE_CORRECTION are boolean parameters. Everything other than true is interpreted as false!

Recommended for better performance

It is recommended to install lz4 on both your computer and the reMarkable tablet.

Installing Programs on your reMarkable

Manually

Copy one of the provided lz4 binaries to your reMarkable and make it executable. The version you want to install depends on the version on your operating system. Check the installed version with lz4 --version.

scp bin/lz4-<version>.arm.static root@$REMARKABLE_IP:/home/root/lz4
ssh root@$REMARKABLE_IP 'chmod +x /home/root/lz4'

Where <version> is either 1.9.2 or 1.10.0.

Disclaimer

The majority of the code is copied from reStream. Be sure to check them out!