supernote-sync

An unofficial tool for Supernote e-Ink notebooks, to automatically backup files from the Supernote using local WiFi.

I have it running on my home TrueNAS server to automatically backup my notes and drawings.

Features

• Local network only, no cloud
• Optional conversion to standard formats (NOTE to PDF, SPD to PNG)
• Pull mode to download files from the Supernote
• Push mode to upload files to the Supernote (for INBOX folder)
• Usable as a CLI tool or service / daemon

supernote-sync uses the Supernote Browse & Access feature to synchronize files. The computer and notebook must be on the same network, and WiFi transfer must be toggled on in the Supernote settings.

By default, the INBOX folder is configured in Push mode, and all the other folders are configured in Pull mode.

Push mode is limited, and full bi-directional sync is not really practical, because the WiFi transfer function of the Supernote does not allow deleting or overwriting files on the device.

Run locally

Install with pipx

pipx install supernote-sync

Run once

You can find the IP address of your Supernote in the popup when turning on WiFi transfer.

supernote-sync --ip xxx.xxx.xxx.xxx --name="My Device Name" --sync-dir=./supernote run

Start daemon

supernote-sync --ip xxx.xxx.xxx.xxx --name="My Device Name" --sync-dir=./supernote start

Run with Docker

The Docker image is configured to use the /supernote path inside the container. Mount a volume to /supernote to write the files to the host system.

The container can be configured via environment variables (see below).

docker run \ 
    -e SUPERNOTE_IP="xxx.xxx.xxx.xxx" \
    -e SUPERNOTE_NAME="My Device Name" \
    -v ./supernote:/supernote \
    ghcr.io/jbchouinard/supernote-sync:latest

Configuration

Configuration options can be set by environment variables or command line arguments.

Supernote Connection Settings

WiFi transfer must be toggled on on the Supernote device. The popup will show the IP address of the device.

File Sync Settings

Database Settings

By default, uses a local SQLite database. Any database supported by SQLAlchemy should work. Tested with SQLite and PostgreSQL.

Note to PDF Conversion Settings

Configure automatic conversion of notebooks to PDF when syncing.

To match the notebook scale, the page size is A5 for the Manta, or A6 for the Nomad.

SPD to PNG Conversion Settings

Configure automatic conversion of SPD files to PNG when syncing.

Logging Settings

Development

Install dependencies

poetry install

Run with Poetry

poetry run supernote-sync start

Build Docker image

docker build -t supernote-sync .