https://github.com/elsehow/miractl-nixos
Controlling Boox e-ink monitors from Python
https://github.com/elsehow/miractl-nixos
Last synced: about 2 months ago
JSON representation
Controlling Boox e-ink monitors from Python
- Host: GitHub
- URL: https://github.com/elsehow/miractl-nixos
- Owner: elsehow
- License: gpl-3.0
- Created: 2023-05-03T21:58:56.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2023-05-03T22:02:20.000Z (about 2 years ago)
- Last Synced: 2024-04-15T07:13:49.306Z (about 1 year ago)
- Language: Python
- Size: 24.4 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# miractl
*Forked from [~elithper/miractl](https://git.sr.ht/~elithper/miractl) - many shouts!*
A simple Python script for controlling Boox e-ink monitors on NixOS – both the Boox Mira 13.3" and Boox Mira Pro 25.3" are supported.
The script has been tested on Linux, Mac and Windows using Python 3.11.
This project is inspired by the excellent [mira-js](https://github.com/ipodnerd3019/mira-js) CLI tool.
## Install
``` sh
shell nix-shell
./miractl.py --help
```
## Setup
If you are using Linux, you will also need to modify your udev rules.
Create a new file called `58-hid.rules`.
```
sudo touch /etc/udev/rules.d/58-hid.rules
```
Then open the file in a text editor and paste the following content.
```
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"
```
Finally, reload your udev rules.
```
sudo udevadm control --reload-rules
sudo udevadm trigger
```
## Usage
> Note: replace `./miractl.py` with `miractl` if you have added the script to your $PATH as described in Setup.
Get help:
```
./miractl.py -h
```
Simple refresh:
```
./miractl.py --clear
```
Configure monitor settings:
```
./miractl.py --refresh-mode {direct_update,grey_update,a2}
--speed [1-7]
--contrast [0-15]
--dither-mode [0-3]
--white-filter [0-254]
--black-filter [0-254]
--cool-light [0-254]
--warm-light [0-254]
--antiflicker {disabled,low,middle,high}
```
Any number of settings can be set in a single command, e.g.
```
./miractl.py --speed 5 --contrast 11 --cool-light 127
```
However, `--white-filter` and `--black-filter` must be set together.
```
./miractl.py --white-filter 80 --black-filter 120
```
## Display modes
There are 5 display modes which can be set using the `--display-mode` flag: `speed`, `text`, `image`, `video` and `read`.
```
./miractl.py --display-mode text
```
Since display modes are simply combinations of other flags, the display mode overrides any other settings in your command. For example, in the following command the values for `--contrast` and `--dither-mode` are ignored – the display mode takes precedence.
```
./miractl.py --display-mode speed --contrast 10 --dither-mode 2
```
The only exceptions to this are `--cool-light` and `--warm-light`. Display modes never adjust the frontlight, so they can both be configured in a single command.
```
./miractl.py --display-mode speed --warm-light 110
```
## Antiflicker
Setting `--antiflicker` allows you to select the autodithering algorithm used by the display. While there are several options (`disabled`, `low`, `middle` and `high`), only `high` is recommended.
It is especially important to set this option to `high` on newer ARM-based Macs, which often cause flickering issues otherwise.