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

***********************************************
Installation of Prerequisites for Linux (CMake)
***********************************************

:link_to_translation:`zh_CN:[中文]`

.. include:: ../cmake-warning.rst

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

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

- CentOS 7::

    sudo yum install git wget ncurses-devel flex bison gperf python pyserial python-pyelftools cmake ninja-build ccache

- Ubuntu and Debian::

    sudo apt-get install git wget libncurses-dev flex bison gperf python python-pip python-setuptools python-serial python-click python-cryptography python-future python-pyparsing python-pyelftools cmake ninja-build ccache

- Arch::

    sudo pacman -S --needed gcc git make ncurses flex bison gperf python2-pip python2-pyserial python2-click python2-cryptography python2-future python2-pyparsing python2-pyelftools cmake ninja ccache

.. note::
    CMake version 3.5 or newer is required for use with ESP-IDF. Older Linux distributions may require updating, enabling of a "backports" repository, or installing of a "cmake3" package rather than "cmake".

Additional Tips
===============

Permission issues /dev/ttyUSB0
------------------------------

With some Linux distributions you may get the ``Failed to open port /dev/ttyUSB0`` error message when flashing the ESP32. :ref:`This can be solved by adding the current user to the dialout group<linux-dialout-group-cmake>`.


Arch Linux Users
----------------

To run the precompiled gdb (xtensa-esp32-elf-gdb) in Arch Linux requires ncurses 5, but Arch uses ncurses 6.

Backwards compatibility libraries are available in AUR_ for native and lib32 configurations:

- https://aur.archlinux.org/packages/ncurses5-compat-libs/
- https://aur.archlinux.org/packages/lib32-ncurses5-compat-libs/

Before installing these packages you might need to add the author's public key to your keyring as described in the "Comments" section at the links above.

Alternatively, use crosstool-NG to compile a gdb that links against ncurses 6.


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

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


Related Documents
=================

.. toctree::
    :maxdepth: 1

    linux-setup-scratch


.. _AUR: https://wiki.archlinux.org/index.php/Arch_User_Repository
-												docs: update CMake getting started guide to use install.bat and export.bat

											
										
										
											2019-03-27 05:29:06 +00:00
+								***********************************************
 								Installation of Prerequisites for Linux (CMake)
 								***********************************************
-												docs: Copy CMake docs to a separate set of directories

Required first step before merging back to mainline.

											
										
										
											2018-08-08 07:58:00 +00:00
-.Update 8 English cmake files
2.Provide Chinese translation to these 8 cmake files

											
										
										
											2018-11-06 04:02:21 +00:00
+								:link_to_translation:`zh_CN:[中文]`
-												docs: Copy CMake docs to a separate set of directories

Required first step before merging back to mainline.

											
										
										
											2018-08-08 07:58:00 +00:00
+								.. include:: ../cmake-warning.rst
 								Install Prerequisites
 								=====================
 								To compile with ESP-IDF you need to get the following packages:
 								- CentOS 7::
-												sys_view: Adds processing scripts for heap & log traces

											
										
										
											2018-12-12 17:38:23 +00:00
+								    sudo yum install git wget ncurses-devel flex bison gperf python pyserial python-pyelftools cmake ninja-build ccache
-												docs: Copy CMake docs to a separate set of directories

Required first step before merging back to mainline.

											
										
										
											2018-08-08 07:58:00 +00:00
 								- Ubuntu and Debian::
-												Add click package to linux setup instructions

											
										
										
											2019-06-11 12:30:01 +00:00
+								    sudo apt-get install git wget libncurses-dev flex bison gperf python python-pip python-setuptools python-serial python-click python-cryptography python-future python-pyparsing python-pyelftools cmake ninja-build ccache
-												docs: Copy CMake docs to a separate set of directories

Required first step before merging back to mainline.

											
										
										
											2018-08-08 07:58:00 +00:00
 								- Arch::
-												Add click package to linux setup instructions

											
										
										
											2019-06-11 12:30:01 +00:00
+								    sudo pacman -S --needed gcc git make ncurses flex bison gperf python2-pip python2-pyserial python2-click python2-cryptography python2-future python2-pyparsing python2-pyelftools cmake ninja ccache
-												docs: Copy CMake docs to a separate set of directories

Required first step before merging back to mainline.

											
										
										
											2018-08-08 07:58:00 +00:00
 								.. note::
 								    CMake version 3.5 or newer is required for use with ESP-IDF. Older Linux distributions may require updating, enabling of a "backports" repository, or installing of a "cmake3" package rather than "cmake".
-												docs: update CMake getting started guide to use install.bat and export.bat

											
										
										
											2019-03-27 05:29:06 +00:00
+								Additional Tips
-												docs: Copy CMake docs to a separate set of directories

Required first step before merging back to mainline.

											
										
										
											2018-08-08 07:58:00 +00:00
+								===============
 								Permission issues /dev/ttyUSB0
 								------------------------------
 								With some Linux distributions you may get the ``Failed to open port /dev/ttyUSB0`` error message when flashing the ESP32. :ref:`This can be solved by adding the current user to the dialout group<linux-dialout-group-cmake>`.
 								Arch Linux Users
 								----------------
 								To run the precompiled gdb (xtensa-esp32-elf-gdb) in Arch Linux requires ncurses 5, but Arch uses ncurses 6.
 								Backwards compatibility libraries are available in AUR_ for native and lib32 configurations:
 								- https://aur.archlinux.org/packages/ncurses5-compat-libs/
 								- https://aur.archlinux.org/packages/lib32-ncurses5-compat-libs/
 								Before installing these packages you might need to add the author's public key to your keyring as described in the "Comments" section at the links above.
 								Alternatively, use crosstool-NG to compile a gdb that links against ncurses 6.
 								Next Steps
 								==========
-												Introduced installation steps to improve navigation through the installation process. Included some updates from GNU make section.

											
										
										
											2019-02-04 20:51:50 +00:00
+								To carry on with development environment setup, proceed to :ref:`get-started-get-esp-idf-cmake`.
-												docs: Copy CMake docs to a separate set of directories

Required first step before merging back to mainline.

											
										
										
											2018-08-08 07:58:00 +00:00
 								Related Documents
 								=================
 								.. toctree::
 								    :maxdepth: 1
 								    linux-setup-scratch
 								.. _AUR: https://wiki.archlinux.org/index.php/Arch_User_Repository