Skip to content

Commit

Permalink
Update get-started.rst
Browse files Browse the repository at this point in the history
Added link to microPython repo for 'getting started'
  • Loading branch information
rsoric committed Jan 2, 2024
1 parent e4b1cf1 commit 3f7bed2
Showing 1 changed file with 1 addition and 55 deletions.
56 changes: 1 addition & 55 deletions source/get-started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,61 +22,7 @@ To use `Peripheral Mode <peripheral-mode.html>`_, connect your Inkplate to the "
MicroPython
-----------

In order to get started with Inkplate using MicroPython, follow the steps below:

#. Clone our repo for `micropython <https://github.com/e-radionicacom/Inkplate-6-micropython>`_ and get your terminal inside the repo folder.
#. Flash MicroPython firmware supplied, or from the `official page <https://micropython.org/download/esp32/>`_
To do so, run

.. code-block:: python
//Linux/Mac
esptool.py --port /dev/cu.usbserial-1420 erase_flash
//Windows
esptool.py --port COM5 erase_flash
to erase esp32 flash and then

.. code-block:: python
//Linux/Mac
esptool.py --chip esp32 --port /dev/cu.usbserial-1420 write_flash -z 0x1000 esp32spiram-20210418-v1.15.bin
//Windows
esptool.py --chip esp32 --port COM5 write_flash -z 0x1000 esp32spiram-20210418-v1.15.bin
to flash supplied firmware.
If you don't have esptool.py installed, install it from here: `esptool <https://github.com/espressif/esptool>`_ at minimum use version 1.15..

#. Copy library files to your board, use inkplate6.py or inkplate10.py for respective versions, something like this:

.. code-block:: python
//Linux/Mac
python3 pyboard.py --device /dev/ttyUSB0 -f cp mcp23017.py sdcard.py inkplate6.py image.py gfx.py gfx_standard_font_01.py :
//Windows
//This one might need to be started twice
python pyboard.py --device COM5 -f cp inkplate6.py gfx.py gfx_standard_font_01.py mcp23017.py image.py shapes.py sdcard.py :
Replace /dev/ttyUSB0 or COM5 with the port to which Inkplate is connected. Easiest way to find that out is to open Arduino IDE and see it under ports menu.
(You can find pyboard.py in the MicroPython tools directory or just download it from GitHub: `pyboard <https://raw.githubusercontent.com/micropython/micropython/master/tools/pyboard.py>`_)

#. Run example.py:

.. code-block::
//Linux/Mac
python3 pyboard.py --device /dev/ttyUSB0 "Examples/Inkplate6/basicBW.py
//Windows
python pyboard.py --device COM5 "Examples/Inkplate6/basicBW.py"
Again replacing /dev/ttyUSB0 or COM5 with the correct port.
You can run our othe examples, showing how to use the rest of inkplate functionality.
In the same manner as running our examples you can run your own code and even set it to run on boot or similiar by following other MicroPython tutorials.
In order to get started with Inkplate using MicroPython, please follow the guide in the `GitHub repository <https://github.com/SolderedElectronics/Inkplate-micropython?tab=readme-ov-file#setting-up-inkplate-with-micropython>`_.

ESP-IDF
-------
Expand Down

0 comments on commit 3f7bed2

Please sign in to comment.