Install esptool on your local machine

Learning Objectives

We are using esptool.py to interact with the MagTag hardware directly from your computer over the USB cable. Installing this tool will let you upload binaries directly to the device.

Desired outcome(s)

• Be able to connect to the device using esptool.py

Time Estimate

• This section should take approximately 1-2 minutes.

Workflow

Linux/MacOS

Espressif has published full instructions for installing esptool. For Linux and Mac, run the following command:

pip3 install esptool

Windows

tip

If Python is not installed on your system, you can hit the Windows key, type 'python', and the Windows store will launch. Install Python 3.10 before moving onto the next step

Espressif has published full instructions for installing esptool. Click the Windows key, type 'cmd' and press enter to open the command prompt. Then run the following command to install esptool:

pip3 install esptool

Troubleshooting

Linux/MacOS

If you are unable to run esptool.py from the command line, you may need to add the installed binary to your path:

PATH=$PATH:$HOME/.local/bin/

Windows

Run esptool on Windows by using the following command:

python -m esptool

In this training guide, all commands used to update firmware on the MagTag include a set of Windows instructions using this approach.

Update previously installed versions

If esptool.py is already installed on your system, please check that it is a recent version that supports the ESP32s2. Now is a great time for an upgrade!