Skip to content

installation.md

Latest commit

 

History

History
86 lines (57 loc) · 2.85 KB

installation.md

File metadata and controls

86 lines (57 loc) · 2.85 KB
Raw
title Installation
nav_order 2

Installation

Supported Devices

  • Xteink X3, X4
  • Xteink X4 Classic and X4 Pro
  • Seeed Studio Sticky

Don't have a device yet? Get one directly from Xteink or Seeed Studio.

Note: Your purchases using the above affiliate links help support ongoing development of Crossink.

Web Installation via USB

For new installs and updates.

  1. Navigate to https://inky.crossink.dev/#flash-tools and select your device model.
  2. The latest version will be automatically selected, but if you ever want to revert to an earlier build, you can select it from the dropdown.
  3. Choose the firmware option you want to install.
  4. Click on the "Flash Firmware" button

X4 Pro uses the ESP32-S3 firmware option. Keep the reader connected during the download-mode and flashing steps shown by Inky.

USB Drive

On X4 Pro, choose Home > File Transfer > USB Drive to expose the SD card to your computer. Eject the drive from the computer before disconnecting it; the reader restarts to Home when the drive is safely ejected or the cable is removed.

SD Card Firmware Update

For installing newer versions of CrossInk. Can be used by USB locked devices.

  1. Follow the same steps from the Web Installation method above. There will be an option to download the firmware instead of USB flashing.
  2. Place the downloaded firmware-*.bin file on your SD card. You can place this file anywhere.
  3. Go to Settings > System > SD Card Firmware Update and navigate to the .bin file and update.

USB Locked Devices

If your device has USB data transfer disabled:

  1. Navigate to https://inky.crossink.dev/#flash-tools and check the box for "I have a locked device" at the top.
  2. The latest version will be automatically selected, but if you ever want to revert to an earlier build, you can select it from the dropdown.
  3. Choose the firmware option you want to download.
  4. Click on the "Download update.bin" button and follow the instructions.

Command Line

These instructions are for macOS and Linux. Windows users should use the web installer.

Install esptool:

pip3 install esptool

Download the firmware-*.bin file from the releases page, then connect your device with USB-C.

Find the device port:

# Linux
dmesg | grep tty

# macOS
ls /dev/cu.*

Flash the firmware:

# Linux
esptool.py --chip esp32c3 --port /dev/ttyACM0 --baud 921600 write_flash 0x10000 /path/to/firmware.bin

# macOS
esptool.py --chip esp32c3 --port /dev/cu.usbmodem2101 --baud 921600 write_flash 0x10000 /path/to/firmware.bin

Replace the port and firmware path with your actual values.