inkplate-display/README.org

#+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.
Initial commit 2023-07-08 07:52:38 +02:00			`#+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=.`
Add ‘--reset’ command-line option Passing this option will cause a full update command to be sent to the Inkplate instead of a partial update command. A full update cleans up any residual display from previous partial updates, but causes more wear on the eink display. It causes a big flash of all black to happen before sending the updated display. I shouldn't be used all the time. 2023-07-08 08:12:47 +02:00
			`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.`