linux-setup.rst 2.4 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758
  1. *********************************************
  2. Standard Setup of Toolchain for Linux
  3. *********************************************
  4. :link_to_translation:`zh_CN:[中文]`
  5. Install Prerequisites
  6. =====================
  7. To compile with ESP-IDF you need to get the following packages. The command to run depends on which distribution of Linux you are using:
  8. - Ubuntu and Debian::
  9. sudo apt-get install git wget flex bison gperf python3 python3-pip python3-setuptools cmake ninja-build ccache libffi-dev libssl-dev dfu-util libusb-1.0-0
  10. - CentOS 7 & 8::
  11. sudo yum -y update && sudo yum install git wget flex bison gperf python3 python3-pip python3-setuptools cmake ninja-build ccache dfu-util libusbx
  12. CentOS 7 is still supported but CentOS version 8 is recommended for a better user experience.
  13. - Arch::
  14. sudo pacman -S --needed gcc git make flex bison gperf python-pip cmake ninja ccache dfu-util libusb
  15. .. note::
  16. - 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".
  17. - If you do not see your Linux distribution in the above list then please check its documentation to find out which command to use for package installation.
  18. Additional Tips
  19. ===============
  20. Permission issues /dev/ttyUSB0
  21. ------------------------------
  22. 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>`.
  23. Fixing broken pip on Ubuntu 16.04
  24. =================================
  25. Package ``python3-pip`` could be broken without possibility to upgrade it.
  26. Package has to be removed and installed manually using script `get-pip.py <https://bootstrap.pypa.io/get-pip.py>`_.::
  27. apt remove python3-pip python3-virtualenv; rm -r ~/.local
  28. rm -r ~/.espressif/python_env && python get-pip.py
  29. Python 2 deprecation
  30. ====================
  31. Python 2 reached its `end of life <https://www.python.org/doc/sunset-python-2/>`_ and support for it in ESP-IDF will be removed soon. Please install Python 3.6 or higher. Instructions for popular Linux distributions are listed above.
  32. Next Steps
  33. ==========
  34. To carry on with development environment setup, proceed to :ref:`get-started-get-esp-idf`.
  35. .. _AUR: https://wiki.archlinux.org/index.php/Arch_User_Repository