OVMS3-idf/docs/en/get-started/linux-setup-scratch.rst

**********************************
Setup Linux Toolchain from Scratch
**********************************

The following instructions are alternative to downloading binary toolchain from Espressif website. To quickly setup the binary toolchain, instead of compiling it yourself, backup and proceed to section :doc:`linux-setup`.


Install Prerequisites
=====================

To compile with ESP-IDF you need to get the following packages:

- Ubuntu and Debian::

    sudo apt-get install git wget make libncurses-dev flex bison gperf python python-pip python-setuptools python-serial

- Arch::

    sudo pacman -S --needed gcc git make ncurses flex bison gperf python2-pyserial

.. note::

    Some older (pre-2014) Linux distributions may use ``pyserial`` version 2.x which is not supported by ESP-IDF.
    In this case please install a supported version via ``pip`` as it is described in section
    :ref:`get-started-get-packages`.

Compile the Toolchain from Source
=================================

- Install dependencies:

  - CentOS 7::

        sudo yum install gawk gperf grep gettext ncurses-devel python python-devel automake bison flex texinfo help2man libtool

  - Ubuntu pre-16.04::

        sudo apt-get install gawk gperf grep gettext libncurses-dev python python-dev automake bison flex texinfo help2man libtool

  - Ubuntu 16.04::

        sudo apt-get install gawk gperf grep gettext python python-dev automake bison flex texinfo help2man libtool libtool-bin

  - Debian 9::

        sudo apt-get install gawk gperf grep gettext libncurses-dev python python-dev automake bison flex texinfo help2man libtool libtool-bin

  - Arch::

        TODO

Download ``crosstool-NG`` and build it:

.. include:: /_build/inc/scratch-build-code.inc

Build the toolchain::

    ./ct-ng xtensa-esp32-elf
    ./ct-ng build
    chmod -R u+w builds/xtensa-esp32-elf

Toolchain will be built in ``~/esp/crosstool-NG/builds/xtensa-esp32-elf``. Follow :ref:`instructions for standard setup <setup-linux-toolchain-add-it-to-path>` to add the toolchain to your ``PATH``.


Next Steps
==========

To carry on with development environment setup, proceed to section :ref:`get-started-get-esp-idf`.
Getting started guides 2017-03-26 22:01:52 +00:00			`**********************************`
			`Setup Linux Toolchain from Scratch`
			`**********************************`

			The following instructions are alternative to downloading binary toolchain from Espressif website. To quickly setup the binary toolchain, instead of compiling it yourself, backup and proceed to section :doc:`linux-setup`.


			`Install Prerequisites`
			`=====================`

			`To compile with ESP-IDF you need to get the following packages:`

			`- Ubuntu and Debian::`

Add required Python packages On some systems pip and setuptools are no longer installed as dependencies of the python packages. This commit adds the requirement for these packages. 2018-09-07 06:44:19 +00:00			`sudo apt-get install git wget make libncurses-dev flex bison gperf python python-pip python-setuptools python-serial`
Getting started guides 2017-03-26 22:01:52 +00:00
			`- Arch::`

			`sudo pacman -S --needed gcc git make ncurses flex bison gperf python2-pyserial`

Add python-future by using python requirements file 2018-08-15 07:52:07 +00:00			`.. note::`

			Some older (pre-2014) Linux distributions may use ``pyserial`` version 2.x which is not supported by ESP-IDF.
			In this case please install a supported version via ``pip`` as it is described in section
			:ref:`get-started-get-packages`.
Getting started guides 2017-03-26 22:01:52 +00:00
			`Compile the Toolchain from Source`
			`=================================`

			`- Install dependencies:`

			`- CentOS 7::`

			`sudo yum install gawk gperf grep gettext ncurses-devel python python-devel automake bison flex texinfo help2man libtool`

			`- Ubuntu pre-16.04::`

			`sudo apt-get install gawk gperf grep gettext libncurses-dev python python-dev automake bison flex texinfo help2man libtool`

			`- Ubuntu 16.04::`

			`sudo apt-get install gawk gperf grep gettext python python-dev automake bison flex texinfo help2man libtool libtool-bin`

Add build dependencies for toolchain for Debian Merges https://github.com/espressif/esp-idf/pull/1465 2018-01-05 09:48:35 +00:00			`- Debian 9::`
Getting started guides 2017-03-26 22:01:52 +00:00
Add build dependencies for toolchain for Debian Merges https://github.com/espressif/esp-idf/pull/1465 2018-01-05 09:48:35 +00:00			`sudo apt-get install gawk gperf grep gettext libncurses-dev python python-dev automake bison flex texinfo help2man libtool libtool-bin`
Getting started guides 2017-03-26 22:01:52 +00:00
			`- Arch::`

			`TODO`

docs: generate toolchain download links 2018-08-29 13:30:03 +00:00			Download ``crosstool-NG`` and build it:
Getting started guides 2017-03-26 22:01:52 +00:00
docs: generate toolchain download links 2018-08-29 13:30:03 +00:00			`.. include:: /_build/inc/scratch-build-code.inc`
Getting started guides 2017-03-26 22:01:52 +00:00
			`Build the toolchain::`

			`./ct-ng xtensa-esp32-elf`
			`./ct-ng build`
			`chmod -R u+w builds/xtensa-esp32-elf`

			Toolchain will be built in ``~/esp/crosstool-NG/builds/xtensa-esp32-elf``. Follow :ref:`instructions for standard setup <setup-linux-toolchain-add-it-to-path>` to add the toolchain to your ``PATH``.


			`Next Steps`
			`==========`

			To carry on with development environment setup, proceed to section :ref:`get-started-get-esp-idf`.