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

*********************************************
Standard Setup of Toolchain for Linux
*********************************************

:link_to_translation:`zh_CN:[中文]`

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

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

- CentOS 7::

    sudo yum install git wget flex bison gperf python cmake ninja-build ccache dfu-util

- Ubuntu and Debian::

    sudo apt-get install git wget flex bison gperf python python-pip python-setuptools cmake ninja-build ccache libffi-dev libssl-dev dfu-util

- Arch::

    sudo pacman -S --needed gcc git make flex bison gperf python-pip cmake ninja ccache dfu-util

.. 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 {IDF_TARGET_NAME}. :ref:`This can be solved by adding the current user to the dialout group<linux-dialout-group>`.

Setting up Python 3 as default for Ubuntu and Debian
----------------------------------------------------

Ubuntu and Debian are still providing Python 2.7 as the default interpreter. Python 3 can be installed as follows::

    sudo apt-get install python3 python3-pip python3-setuptools

Making Python 3 the default interpreter is possible by running::

    sudo update-alternatives --install /usr/bin/python python /usr/bin/python3 10

.. note::
    This is system-wide change which may affect all of the applications.

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

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


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

.. toctree::
    :maxdepth: 1

    :esp32: linux-setup-scratch


.. _AUR: https://wiki.archlinux.org/index.php/Arch_User_Repository
-												docs: Make CMake build system default, mark GNU Make as legacy option

All `-cmake` suffixes are removed
Where a GNU Make option is renamed, the `-legacy` suffix is used

											
										
										
											2019-06-25 01:26:53 +00:00
+								*********************************************
 								Standard Setup of Toolchain for Linux
 								*********************************************
-												docs: Functional renaming commit for CMake-as-default

Rename all the files which will be edited substantially in the next commit, without changing their
contents

Docs will not build for this ocmmit.

This is done so that git doesn't decide we renamed xxx-cmake -> xxx-legacy in the next commit, which
is what it will infer otherwise (and makes rebasing more of a pain than it should be)

											
										
										
											2019-06-25 01:29:49 +00:00
-												doc(global): build cross-language links for translated documents

											
										
										
											2018-04-27 06:46:13 +00:00
+								:link_to_translation:`zh_CN:[中文]`
-												Getting started guides

											
										
										
											2017-03-26 22:01:52 +00:00
 								Install Prerequisites
 								=====================
 								To compile with ESP-IDF you need to get the following packages:
 								- CentOS 7::
-												Add build system support for programming ESP32-S2 using DFU utils

											
										
										
											2020-04-06 14:41:44 +00:00
+								    sudo yum install git wget flex bison gperf python cmake ninja-build ccache dfu-util
-												Getting started guides

											
										
										
											2017-03-26 22:01:52 +00:00
 								- Ubuntu and Debian::
-												Add build system support for programming ESP32-S2 using DFU utils

											
										
										
											2020-04-06 14:41:44 +00:00
+								    sudo apt-get install git wget flex bison gperf python python-pip python-setuptools cmake ninja-build ccache libffi-dev libssl-dev dfu-util
-												Getting started guides

											
										
										
											2017-03-26 22:01:52 +00:00
 								- Arch::
-												Add build system support for programming ESP32-S2 using DFU utils

											
										
										
											2020-04-06 14:41:44 +00:00
+								    sudo pacman -S --needed gcc git make flex bison gperf python-pip cmake ninja ccache dfu-util
-												Getting started guides

											
										
										
											2017-03-26 22:01:52 +00:00
-												Add python-future by using python requirements file

											
										
										
											2018-08-15 07:52:07 +00:00
+								.. note::
-												docs: Functional renaming commit for CMake-as-default

Rename all the files which will be edited substantially in the next commit, without changing their
contents

Docs will not build for this ocmmit.

This is done so that git doesn't decide we renamed xxx-cmake -> xxx-legacy in the next commit, which
is what it will infer otherwise (and makes rebasing more of a pain than it should be)

											
										
										
											2019-06-25 01:29:49 +00:00
+								    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".
-												Add python-future by using python requirements file

											
										
										
											2018-08-15 07:52:07 +00:00
-												docs: Functional renaming commit for CMake-as-default

Rename all the files which will be edited substantially in the next commit, without changing their
contents

Docs will not build for this ocmmit.

This is done so that git doesn't decide we renamed xxx-cmake -> xxx-legacy in the next commit, which
is what it will infer otherwise (and makes rebasing more of a pain than it should be)

											
										
										
											2019-06-25 01:29:49 +00:00
+								Additional Tips
-												Getting started guides

											
										
										
											2017-03-26 22:01:52 +00:00
+								===============
-												docs: Improved documentation for /dev/ttyUSB0 issues

Improved documentation for /dev/ttyUSB0 issues.  This occurred in Ubuntu, but I'm sure is applies to most distributions.

Merges https://github.com/espressif/esp-idf/pull/1158

											
										
										
											2017-10-25 04:44:08 +00:00
+								Permission issues /dev/ttyUSB0
 								------------------------------
-												doc: Update English pages with generic target name

											
										
										
											2019-12-09 03:01:09 +00:00
+								With some Linux distributions you may get the ``Failed to open port /dev/ttyUSB0`` error message when flashing the {IDF_TARGET_NAME}. :ref:`This can be solved by adding the current user to the dialout group<linux-dialout-group>`.
-												docs: Improved documentation for /dev/ttyUSB0 issues

Improved documentation for /dev/ttyUSB0 issues.  This occurred in Ubuntu, but I'm sure is applies to most distributions.

Merges https://github.com/espressif/esp-idf/pull/1158

											
										
										
											2017-10-25 04:44:08 +00:00
-												Docs: Encourage to used Python 3

											
										
										
											2020-02-20 15:00:53 +00:00
+								Setting up Python 3 as default for Ubuntu and Debian
 								----------------------------------------------------
 								Ubuntu and Debian are still providing Python 2.7 as the default interpreter. Python 3 can be installed as follows::
 								    sudo apt-get install python3 python3-pip python3-setuptools
 								Making Python 3 the default interpreter is possible by running::
 								    sudo update-alternatives --install /usr/bin/python python /usr/bin/python3 10
 								.. note::
 								    This is system-wide change which may affect all of the applications.
-												Getting started guides

											
										
										
											2017-03-26 22:01:52 +00:00
+								Next Steps
 								==========
-												docs: Make CMake build system default, mark GNU Make as legacy option

All `-cmake` suffixes are removed
Where a GNU Make option is renamed, the `-legacy` suffix is used

											
										
										
											2019-06-25 01:26:53 +00:00
+								To carry on with development environment setup, proceed to :ref:`get-started-get-esp-idf`.
-												Getting started guides

											
										
										
											2017-03-26 22:01:52 +00:00
 								Related Documents
 								=================
 								.. toctree::
 								    :maxdepth: 1
-												docs: Mark some more docs sections as ESP32 only

											
										
										
											2019-11-26 06:22:50 +00:00
+								    :esp32: linux-setup-scratch
-												Getting started guides

											
										
										
											2017-03-26 22:01:52 +00:00
 								.. _AUR: https://wiki.archlinux.org/index.php/Arch_User_Repository