88 lines
3 KiB
ReStructuredText
88 lines
3 KiB
ReStructuredText
**************************************
|
|
Standard Setup of Toolchain for Mac OS
|
|
**************************************
|
|
|
|
.. note::
|
|
This is documentation for the CMake-based build system which is currently in preview release. The documentation may have gaps, and you may encounter bugs (please report either of these). To view documentation for the older GNU Make based build system, switch versions to the 'latest' master branch or a stable release.
|
|
|
|
Install Prerequisites
|
|
=====================
|
|
|
|
ESP-IDF will use the version of Python installed by default on Mac OS.
|
|
|
|
- install pip::
|
|
|
|
sudo easy_install pip
|
|
|
|
- install pyserial::
|
|
|
|
sudo pip install pyserial
|
|
|
|
- install CMake & Ninja build:
|
|
|
|
- If you have HomeBrew_, you can run::
|
|
|
|
brew install cmake ninja
|
|
|
|
- If you have MacPorts_, you can run::
|
|
|
|
sudo port install cmake ninja
|
|
|
|
- Otherwise, consult the CMake_ and Ninja_ home pages for Mac OS installation downloads.
|
|
|
|
- It is strongly recommended to also install ccache_ for faster builds. If you have HomeBrew_, this can be done via ``brew install ccache`` or ``sudo port install ccache`` on MacPorts_.
|
|
|
|
.. note::
|
|
If an error like this is shown during any step::
|
|
|
|
xcrun: error: invalid active developer path (/Library/Developer/CommandLineTools), missing xcrun at: /Library/Developer/CommandLineTools/usr/bin/xcrun
|
|
|
|
Then you will need to install the XCode command line tools to continue. You can install these by running ``xcode-select --install``.
|
|
|
|
Toolchain Setup
|
|
===============
|
|
|
|
ESP32 toolchain for macOS is available for download from Espressif website:
|
|
|
|
https://dl.espressif.com/dl/xtensa-esp32-elf-osx-1.22.0-80-g6c4433a-5.2.0.tar.gz
|
|
|
|
Download this file, then extract it in ``~/esp`` directory::
|
|
|
|
mkdir -p ~/esp
|
|
cd ~/esp
|
|
tar -xzf ~/Downloads/xtensa-esp32-elf-osx-1.22.0-80-g6c4433a-5.2.0.tar.gz
|
|
|
|
.. _setup-macos-toolchain-add-it-to-path:
|
|
|
|
The toolchain will be extracted into ``~/esp/xtensa-esp32-elf/`` directory.
|
|
|
|
To use it, you will need to update your ``PATH`` environment variable in ``~/.profile`` file. To make ``xtensa-esp32-elf`` available for all terminal sessions, add the following line to your ``~/.profile`` file::
|
|
|
|
export PATH=$PATH:$HOME/esp/xtensa-esp32-elf/bin
|
|
|
|
Alternatively, you may create an alias for the above command. This way you can get the toolchain only when you need it. To do this, add different line to your ``~/.profile`` file::
|
|
|
|
alias get_esp32="export PATH=$PATH:$HOME/esp/xtensa-esp32-elf/bin"
|
|
|
|
Then when you need the toolchain you can type ``get_esp32`` on the command line and the toolchain will be added to your ``PATH``.
|
|
|
|
|
|
Next Steps
|
|
==========
|
|
|
|
To carry on with development environment setup, proceed to section :ref:`get-started-get-esp-idf`.
|
|
|
|
Related Documents
|
|
=================
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
macos-setup-scratch
|
|
|
|
.. _cmake: https://cmake.org/
|
|
.. _ninja: https://ninja-build.org/
|
|
.. _ccache: https://ccache.samba.org/
|
|
.. _homebrew: https://brew.sh/
|
|
.. _MacPorts: https://www.macports.org/install.php
|