aboutsummaryrefslogtreecommitdiffstats
path: root/README.org
diff options
context:
space:
mode:
authorGravatar Tom Willemse2023-07-07 23:12:47 -0700
committerGravatar Tom Willemse2023-07-07 23:16:12 -0700
commit48ce1ba15723ddb3807ee681729d330d3972a155 (patch)
treed2f3b00cd79e25f7c061eedfefe159eac3015246 /README.org
parent6f99ff98bc42d5e432614ed1201c997a74148cd1 (diff)
downloadinkplate-display-48ce1ba15723ddb3807ee681729d330d3972a155.tar.gz
inkplate-display-48ce1ba15723ddb3807ee681729d330d3972a155.zip
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.
Diffstat (limited to 'README.org')
-rw-r--r--README.org4
1 files changed, 4 insertions, 0 deletions
diff --git a/README.org b/README.org
index 99842e5..1a29b8d 100644
--- a/README.org
+++ b/README.org
@@ -14,3 +14,7 @@ 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.