Hysen Labs
Open-source project
lschwetlick/rMsync avatar
lschwetlick

rMsync

A script for synchronizing the reMarkable e-reader

100 stars9 forksJupyter NotebookGPL-3.0
01
DEEP OPEN-SOURCE ANALYSIS

rMsync keeps a PC folder in step with the reMarkable

A synchronization script that pushes files from a Library folder to the reMarkable and brings edits and annotations back as PDFs.

02
DEEP OPEN-SOURCE ANALYSIS

The sync idea

rMsync is a synchronization script for the reMarkable e-reader. The idea is to have a Library folder on the PC that stays in sync with the device. When new files appear in the local directory, the script pushes them over to the reMarkable. The folder acts as the source of truth, and the script handles the transfer in one direction automatically.

03
DEEP OPEN-SOURCE ANALYSIS

What comes back

The reverse direction is where it gets interesting. When files are edited, created, or annotated on the reMarkable, they get converted from the device's rm format to PDF and copied back to the Library folder with an annot suffix. Notes are also converted to PDF and saved into a Notes directory, and those are not reuploaded to the device. So annotated PDFs return with their markup intact, and notes stay in their own home.

04
DEEP OPEN-SOURCE ANALYSIS

Requirements

The requirements list names three tools: imagemagick, pdftk, and the rm tools from the maxio scripts repository, which link back to the reHackable scripts project. Imagemagick and pdftk handle the image and PDF conversion needed to go between the device format and readable files, and the rm tools provide the device interface. It is a small dependency set for what the script does.

05
DEEP OPEN-SOURCE ANALYSIS

Update history

The update notes give the project a timeline. An entry from April 2020 says the script was updated to work with reMarkable version 2.0.2, and an earlier note from June 2019 points to a blog post with more explanation of the code. Between those two dates you can see the project tracking firmware changes and, before that, documenting itself. For a personal utility script, that level of note keeping is above the usual bar.

07
DEEP OPEN-SOURCE ANALYSIS

Official sources

08
Community notes

Community notes