starter template walk through

Troubleshooting

space in user profiles

you receive an error when running npx-create-esp32-app that looks like

Error: EPERM: operation not permitted, mkdir
TypeError: cannot read property ’’ of undefined

This can happen on windows if there is a space in your username which means you will have a space in your home directory. You can see your home directory on windows by typing

echo %USERPROFILE%

if you do have a space

create a directory to store your npm (node package manager) cache
set the new directory for node cache

mkdir c:\node_cache
npm config set cache C:\node_cache --global

then try npx create-esp32 again

python issues

if you use the installed idf console and there is no issues however in the idf terminal you get a python issue, it is recommended that you download and install python from https://www.python.org/downloads/

when going through the wizard pay attention to the options and under advanced option ensure you check the

Add Python to environment variables

option

python variables are unsatisfied

have a look at the .vscode/settings.json

check or add that you have the following entries. The one for your OS is the important one

  "terminal.integrated.env.windows": {
    "IDF_PYTHON_ENV_PATH" : "<IDF_TOOLS_PATH>/.espressif/tools/idf-python/3.8.7/Scripts"
  },
  "terminal.integrated.env.osx": {
    "IDF_PYTHON_ENV_PATH" : "<IDF_TOOLS_PATH>/.espressif/tools/idf-python/3.8.7/Scripts"
  },
  "terminal.integrated.env.linux": {
    "IDF_PYTHON_ENV_PATH" : "<IDF_TOOLS_PATH>/.espressif/tools/idf-python/3.8.7/Scripts"
  },

ensure the path for your OS is correct

Sometimes on initial configuration or if you are switching IDF version you get an error in the console telling you to run install.bat. If you see this simple run it. c:\esp\esp-idf\install.bat this usually sorts out most other python issues. You normally would only need to run this once