Skip to content

Commit

Permalink
docs/psoc6/installation.rst: Installation python option displayed first.
Browse files Browse the repository at this point in the history
Signed-off-by: enriquezgarc <enriquezgarcia.external@infineon.com>
  • Loading branch information
jaenrig-ifx committed Jan 31, 2024
1 parent 70651b8 commit 77c92da
Showing 1 changed file with 51 additions and 50 deletions.
101 changes: 51 additions & 50 deletions docs/psoc6/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,21 @@ You can easily download them terminal with the following command:

.. tabs::

.. group-tab:: Python

Download the mpy-psoc6 utility script:

.. code-block:: bash
curl.exe -s -L https://raw.githubusercontent.com/infineon/micropython/ports-psoc6-main/tools/psoc6/mpy-psoc6.py > mpy-psoc6.py
Make sure you have a recent version on `Python3.x <https://www.python.org/downloads/>`_ installed and the `pip <https://pip.pypa.io/en/stable/installation/>`_ package installer.
Then install the following packages:

.. code-block:: bash
pip install requests
.. group-tab:: Linux

Download the mpy-psoc6 utility script:
Expand All @@ -39,26 +54,17 @@ You can easily download them terminal with the following command:
curl.exe -s -L https://raw.githubusercontent.com/infineon/micropython/ports-psoc6-main/tools/psoc6/mpy-psoc6.cmd > mpy-psoc6.cmd
.. group-tab:: Python

Download the mpy-psoc6 utility script:

.. code-block:: bash
curl.exe -s -L https://raw.githubusercontent.com/infineon/micropython/ports-psoc6-main/tools/psoc6/mpy-psoc6.py > mpy-psoc6.py
Make sure you have a recent version on `Python3.x <https://www.python.org/downloads/>`_ installed and the `pip <https://pip.pypa.io/en/stable/installation/>`_ package installer.
Then install the following packages:

.. code-block:: bash
pip install requests
Find all the available commands and options by running the script with the command help:

.. tabs::

.. group-tab:: Python

.. code-block:: bash
python mpy-psoc6.py --help
.. group-tab:: Linux

.. code-block:: bash
Expand All @@ -71,12 +77,6 @@ Find all the available commands and options by running the script with the comma
.\mpy-psoc6.cmd help
.. group-tab:: Python

.. code-block:: bash
python mpy-psoc6.py --help
.. _psoc6_quick_start:

Quick Start
Expand All @@ -87,6 +87,12 @@ micropython is to run the ``quick-start`` command of the script:

.. tabs::

.. group-tab:: Python

.. code-block:: bash
python mpy-psoc6.py quick-start
.. group-tab:: Linux

.. code-block:: bash
Expand All @@ -99,12 +105,6 @@ micropython is to run the ``quick-start`` command of the script:
.\mpy-psoc6.cmd quick-start
.. group-tab:: Python

.. code-block:: bash
python mpy-psoc6.py quick-start
The command will take care of the following:

* Install all required software to work with MicroPython
Expand All @@ -124,6 +124,12 @@ MicropPython firmware version:

.. tabs::

.. group-tab:: Python

.. code-block:: bash
python mpy-psoc6.py device-setup
.. group-tab:: Linux

.. code-block:: bash
Expand All @@ -136,12 +142,6 @@ MicropPython firmware version:
.\mpy-psoc6.cmd device-setup
.. group-tab:: Python

.. code-block:: bash
python mpy-psoc6.py device-setup
You can run any command any time you want to upgrade to the latest MicroPython firmware version.
This command will take care of the following steps:
Expand All @@ -161,6 +161,12 @@ version need to be passed as arguments.

.. tabs::

.. group-tab:: Python

.. code-block:: bash
python mpy-psoc6.py device-setup -b CY8CPROTO-062-4343W -v v0.1.1
.. group-tab:: Linux

.. code-block:: bash
Expand All @@ -173,12 +179,6 @@ version need to be passed as arguments.
.\mpy-psoc6.cmd device-setup CY8CPROTO-062-4343W v0.1.1
.. group-tab:: Python

.. code-block:: bash
python mpy-psoc6.py device-setup -b CY8CPROTO-062-4343W -v v0.1.1
.. warning::

Be sure to provide the board name as shown in the ``device-setup`` command when run in interactive mode.
Expand Down Expand Up @@ -215,6 +215,12 @@ The board needs to be specified, and the path and name of the ``.hex`` file:

.. tabs::

.. group-tab:: Python

.. code-block:: bash
python mpy-psoc6.py firmware-deploy -b CY8CPROTO-062-4343W -f pathtodir/mpy-psoc6_CY8CPROTO-062-4343W.hex
.. group-tab:: Linux

.. code-block:: bash
Expand All @@ -227,11 +233,6 @@ The board needs to be specified, and the path and name of the ``.hex`` file:
.\mpy-psoc6.cmd firmware-deploy CY8CPROTO-062-4343W pathtodir/mpy-psoc6_CY8CPROTO-062-4343W.hex
.. group-tab:: Python

.. code-block:: bash
python mpy-psoc6.py firmware-deploy -b CY8CPROTO-062-4343W -f pathtodir/mpy-psoc6_CY8CPROTO-062-4343W.hex
Erasing the device (external) file system
-----------------------------------------
Expand All @@ -242,6 +243,12 @@ Use the ``device-erase`` command to erase of the external memory of your PSoC6

.. tabs::

.. group-tab:: Python

.. code-block:: bash
python mpy-psoc6.py device-erase
.. group-tab:: Linux

.. code-block:: bash
Expand All @@ -254,12 +261,6 @@ Use the ``device-erase`` command to erase of the external memory of your PSoC6
.\mpy-psoc6.cmd device-erase
.. group-tab:: Python

.. code-block:: bash
python mpy-psoc6.py device-erase
.. warning::

This command flashes the PSoC6™ controller with a custom program to delete the external memory. Thus, MicroPython will be removed from the
Expand Down

0 comments on commit 77c92da

Please sign in to comment.