summaryrefslogtreecommitdiff
path: root/shared-bindings/displayio/EPaperDisplay.c
diff options
context:
space:
mode:
authorDan Halbert <halbert@adafruit.com>2020-11-11 14:13:00 -0500
committerGitHub <noreply@github.com>2020-11-11 14:13:00 -0500
commitfdb92b92fa383aa4cdcd9c19fc141b169efb6170 (patch)
tree4d666b4b0dbfd210d8d627c9417f081a057f5233 /shared-bindings/displayio/EPaperDisplay.c
parentddb3590944f5dd84da94a4a90dc28e865b2b9a30 (diff)
parent9da99675b162742c0ecbd0995ce35e62204be3b1 (diff)
Merge pull request #3672 from tannewt/fix_eink_delay
Correct display sequence format docs
Diffstat (limited to 'shared-bindings/displayio/EPaperDisplay.c')
-rw-r--r--shared-bindings/displayio/EPaperDisplay.c11
1 files changed, 6 insertions, 5 deletions
diff --git a/shared-bindings/displayio/EPaperDisplay.c b/shared-bindings/displayio/EPaperDisplay.c
index e0326d9c8..8518e3714 100644
--- a/shared-bindings/displayio/EPaperDisplay.c
+++ b/shared-bindings/displayio/EPaperDisplay.c
@@ -65,11 +65,12 @@
//| """Create a EPaperDisplay object on the given display bus (`displayio.FourWire` or `displayio.ParallelBus`).
//|
//| The ``start_sequence`` and ``stop_sequence`` are bitpacked to minimize the ram impact. Every
-//| command begins with a command byte followed by a byte to determine the parameter count and if
-//| a delay is need after. When the top bit of the second byte is 1, the next byte will be the
-//| delay time in milliseconds. The remaining 7 bits are the parameter count excluding any delay
-//| byte. The third through final bytes are the remaining command parameters. The next byte will
-//| begin a new command definition.
+//| command begins with a command byte followed by a byte to determine the parameter count and
+//| delay. When the top bit of the second byte is 1 (0x80), a delay will occur after the command
+//| parameters are sent. The remaining 7 bits are the parameter count excluding any delay
+//| byte. The bytes following are the parameters. When the delay bit is set, a single byte after
+//| the parameters specifies the delay duration in milliseconds. The value 0xff will lead to an
+//| extra long 500 ms delay instead of 255 ms. The next byte will begin a new command definition.
//|
//| :param display_bus: The bus that the display is connected to
//| :type _DisplayBus: displayio.FourWire or displayio.ParallelBus