Notes on the Inkplate

1 files changed, 49 insertions, 0 deletions

diff --git a/source/microcontrollers/inkplate/index.rst b/source/microcontrollers/inkplate/index.rst
new file mode 100644
index 0000000..d183962
--- /dev/null
+++ b/source/microcontrollers/inkplate/index.rst
@@ -0,0 +1,49 @@
+**********
+ Inkplate
+**********
+
+Notes on the Inkplate_ boards.
+
+.. _Inkplate: https://soldered.com/collections/inkplate-e-paper-displays/
+
+MicroPython
+===========
+
+Micropython for all of the Inkplate boards can be downloaded by cloning
+the repository::
+
+   $ git clone https://github.com/SolderedElectronics/Inkplate-micropython.git
+
+then the firmware can be flashed directly with esptool::
+
+   $ esptool --port /dev/ttyUSB0 --chip esp32 --baud 115200 write_flash \
+     --flash_mode keep --flash_size keep --erase-all 0x1000 \
+     Inkplate-firmware.bin
+
+under Debian, you may need to use ``--no-stub``, because of #1043168_::
+
+   $ esptool --port /dev/ttyUSB0 --chip esp32 --baud 115200 --no-stub \
+     write_flash --flash_mode keep --flash_size keep 0x1000 \
+     Inkplate-firmware.bin
+
+.. _1043168: https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=1043168
+
+Then the libraries can be copied to the board from the local copy::
+
+  $ mpremote fs mkdir lib
+  $ mpremote fs cp <board>/package.json :lib/
+  $ mpremote fs cp <board>/<board>/*.py :lib/
+  $ mpremote fs cp Dependencies/*.py :lib/
+
+See also
+========
+
+* `Documentation for micropython on the ESP32
+  <https://docs.micropython.org/en/latest/esp32/quickref.html>`_
+* `Inkplate micropython library
+  <https://github.com/SolderedElectronics/Inkplate-micropython>`_
+* `Issue related to the original Inkplate 6
+  <https://github.com/SolderedElectronics/Inkplate-micropython/issues/47>`_
+
+..
+   vim: set filetype=rst: