linux-setup.rst 2.4 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364
  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:
  8. - CentOS 7::
  9. sudo yum install git wget ncurses-devel flex bison gperf python pyserial python-pyelftools cmake ninja-build ccache
  10. - Ubuntu and Debian::
  11. 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
  12. - Arch::
  13. 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
  14. .. note::
  15. 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".
  16. Additional Tips
  17. ===============
  18. Permission issues /dev/ttyUSB0
  19. ------------------------------
  20. 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>`.
  21. ncurses 5 dependency
  22. --------------------
  23. To run the precompiled gdb (xtensa-esp32-elf-gdb) in Linux requires ncurses 5, but some newer distributions only provide ncurses 6 by default.
  24. Consult your distribution's documentation to see if ncurses 5 libraries are available. Alternatively, use crosstool-NG to compile a gdb that links against ncurses 6.
  25. For Arch Linux users, ncurses 5 libraries are available in AUR_ for native and lib32 configurations:
  26. - https://aur.archlinux.org/packages/ncurses5-compat-libs/
  27. - https://aur.archlinux.org/packages/lib32-ncurses5-compat-libs/
  28. 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.
  29. Next Steps
  30. ==========
  31. To carry on with development environment setup, proceed to :ref:`get-started-get-esp-idf`.
  32. Related Documents
  33. =================
  34. .. toctree::
  35. :maxdepth: 1
  36. linux-setup-scratch
  37. .. _AUR: https://wiki.archlinux.org/index.php/Arch_User_Repository