aboutsummaryrefslogtreecommitdiffstats
path: root/README.org
blob: 1a29b8d1b8c1968c1875e6373114f6b82cfbac73 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
#+title: Inkplate Display
#+options: toc:nil

My script for displaying information on my Inkplate.

* Requirements

This script needs [[https://www.gnu.org/software/guile/][Guile]] and [[https://git.sr.ht/~ryuslash/guile-inkplate][guile-inkplate]].

* Installation

Put the =inkplate-display= script anywhere in your =$PATH=.

* Usage

Run the =inkplate-display= script without any arguments. This script assumes that your Inkplate is connected, running in peripheral mode, and that the file descriptor is located at =/dev/ttyUSB0=.

The following command-line arguments are available:

- =--reset= :: Causes a full screen update to be sent to the Inkplate instead of a partial one. Clears any artifacts from previous partial updates, but is harder on the display so shouldn't be used all the time.