Mira-js

Mira-js is a library and CLI for interacting with the Boox Mira and Boox Mira Pro e-ink monitors. It is compatible with Linux, macOS, and Windows.

Requirements

Node >= 16.0.0

Usage

Install the CLI globally:

npm install -g boox-mira

Upgrade the CLI:

npm upgrade -g boox-mira

Run the CLI:

npx mira refresh
npx mira settings --speed 3 --contrast 11

Get usage help:

npx mira --help

Modes

Modes are just combinations of settings flags.

Speed

npx mira settings --refresh-mode a2 --contrast 8 --speed 7 --dither-mode 0 --white-filter 0 --black-filter 0

Text

npx mira settings --refresh-mode a2 --contrast 7 --speed 6 --dither-mode 1 --white-filter 0 --black-filter 0

Image

npx mira settings --refresh-mode direct --contrast 7 --speed 5 --dither-mode 0 --white-filter 0 --black-filter 0

Video

npx mira settings --refresh-mode a2 --contrast 7 --speed 6 --dither-mode 2 --white-filter 10 --black-filter 0

Read

npx mira settings --refresh-mode direct --contrast 7 --speed 5 --dither-mode 3 --white-filter 12 --black-filter 10

Linux notes

udev device permissions

Create /etc/udev/rules.d/58-hid.rules file
Copy the following rules into the file to support hidraw and libusb.

SUBSYSTEM=="input", GROUP="input", MODE="0666"
SUBSYSTEM=="usb", ATTRS{idVendor}=="0416", ATTRS{idProduct}=="5020", MODE:="666", GROUP="plugdev"
KERNEL=="hidraw*", ATTRS{idVendor}=="0416", ATTRS{idProduct}=="5020", MODE="0666", GROUP="plugdev"

Reload udev rules

udevadm control --reload-rules && udevadm trigger

ipodnerd3019/mira-js