VaultInk

Help us debug

Debug page

Connect a reader that runs the VaultInk developer build with a USB cable and this page shows its status, its log and a screenshot, and makes a report file you can attach to a GitHub issue or send by e-mail.

Nothing is uploaded. The page talks to the reader over USB, inside your browser. It sends nothing to a server, and the report is a file you save and send yourself. The developer build's link is not strictly read-only: it can reboot the reader, change the log level, take a screenshot and write a small bench log to the SD card; it cannot read or write your files or settings. This page uses the first three (Reboot, Log level, Screenshot) and STATUS, each only when you press its button. It cannot press keys or install anything: the developer build has no commands for that.

1. Connect

The reader must be awake, with a USB data cable in, and not in Transfer & Remotes → USB Drive. Close other programs that use the port (a serial monitor, the installer's console in another tab).

Not connected
Linux: "Failed to open serial port"

On most Linux systems the port (/dev/ttyACM0) belongs to a group, and your user must be in it: uucp on Arch-based systems, dialout on Debian, Ubuntu and Fedora. ls -l /dev/ttyACM0 shows the group. The usual ways to get access:

sudo usermod -aG uucp $USER (or dialout), then log out and in again.

Or a udev rule, in a file like /etc/udev/rules.d/70-vaultink.rules:
SUBSYSTEM=="tty", ATTRS{idVendor}=="303a", TAG+="uaccess"
then sudo udevadm control --reload and plug the reader in again.

These are the usual ways; we have not tried them on every distribution.

Windows

The reader should appear as a COM port. Whether Windows 10 and 11 need a driver for it is not verified: we have not tested this page on Windows. Please try it and tell us what happened.

The reader is not in the list, or the link drops

Try another cable (some only charge). The port goes away when the reader sleeps and in USB Drive mode; it comes back when the reader wakes, and this page then connects again by itself (if the browser still allows it; otherwise press Connect). For a long session set Settings → System → Time to Sleep to a longer time.

2. Status

Press STATUS after connecting. Only the developer build answers it.

3. Log

What the reader prints while you use it. Debug lines (log level 2) can hold the names of books, notes and folders, Wi-Fi names and server addresses.

0 lines

      

"Save log" writes the lines as they are, not redacted, to a file on your computer. To share lines, use the report below.

4. Screenshot

A picture of what the reader's screen shows now. You see it here first; it goes into a report only if you tick its box.

5. Create a report

GitHub issues are public. Everyone can read what you attach there. The page replaces Wi-Fi names, addresses, server names and file paths with words like <ssid>, <ip>, <host> and <path>, but this is best effort: it can miss a name. Read the text in the box before you save it and remove what you do not want public. A screenshot is never changed. If you would rather not post it, send the report by e-mail to me@lefteros.com.

Screenshots: tick "Include in report" under a picture above. None is ticked.

Open a GitHub issue

The button saves the text of the box to your computer. The issue link only opens GitHub: you paste or attach the report there yourself.