Skip to content

Flash guide · Method 5 of 5

Build from source with PlatformIO

~30–45 min Developer For contributors

PlatformIO clones a firmware repo, compiles it, and flashes the build onto your Xteink. Use it to edit firmware or run a custom fork. If you only want CrossPoint installed, use the web flasher instead.

What you need

  • PlatformIO IDE or PlatformIO Core (CLI) installed
  • Python 3.x
  • Git with submodule support
  • USB-C data cable and an unlocked Xteink

How to build and flash Xteink firmware with PlatformIO

  1. 1

    Clone the repository with submodules. The --recursive flag is required.

    git clone --recursive <repo-url>
  2. 2

    Open the project in VS Code with the PlatformIO extension, or build and flash from the terminal in one command.

    pio run --target upload
  3. 3

    Open the serial monitor for boot logs.

    pio device monitor

Microreader and forks. PlatformIO is the required build path for Microreader. Every fork compiles here before a release.

Build booted? Load your books next

Once the build boots, send your library with Calibre or OPDS. Then add fonts, themes, and sleep screens.

Load your books Add fonts and themes

Troubleshooting PlatformIO builds

Build fails with missing dependencies
Run pio pkg update to update libraries. Check the project README for the required PlatformIO version.
git submodule errors
Run inside the cloned directory:git submodule update --init --recursive
Upload fails after build
Check the serial port, the cable, and whether the Xteink is awake. PlatformIO calls esptool internally, so the same port fixes apply.
Build takes very long
The first run is slow because PlatformIO downloads toolchains. Later builds are faster.

Still stuck? Search the Xteink firmware help and FAQ by problem.

Most owners don't need this

Install CrossPoint without compiling

The web flasher puts CrossPoint on the Xteink in about a minute. You skip the terminal and the compile.

Install CrossPoint with the web flasher →

Owner kit

A light and a case after setup

X3 and X4 ship without a front light. A clip-on is the usual first add-on.

  • eReader Magnetic Reading Light

    eReader Magnetic Reading Light

    Official
    from $9.99
    Buy
  • X4 Pro Magnetic Case

    X4 Pro Magnetic Case

    Official
    $8.99
    Buy

Kit it on accessories .