To build CircuitPython on macOS, you need to install git, python3, and the ARM toolchain. The easiest way to do this is to first install Homebrew, a software package manager for macOS. Follow the directions on its webpages.

Now install the software you need:

brew update
brew install git python3 gettext uncrustify
brew link gettext --force

And finally, install the ARM toolchain. Use the MacOS .pkg file from https://developer.arm.com/tools-and-software/open-source-software/developer-tools/gnu-toolchain/gnu-rm/downloads. As of this writing (April 2021), use the gcc-arm-none-eabi-10-2020-q4-major-mac.pkg file.

Download the .pkg file and double-click it to install.

Once the dependencies are installed, we'll also need to make a disk image to clone CircuitPython into. By default the macOS filesystem is case insensitive. In a few cases, this can confuse the build process. So, we recommend creating a case sensitive disk image with Disk Utility to store the source code. Make the image capable of storing at least 10GB, so you won't run out of space if you do extensive development. You can use a sparse bundle disk image which will grow as necessary, so you don't use up all the space at once. The disk image is a single file that can be mounted by double clicking it in the Finder. Once it's mounted, it works like a normal folder located under the /Volumes directory.

That's it! Now you can move on and actually Build CircuitPython. There we will get the CircuitPython source code, install a few more dependencies, and then build!

This guide was first published on Apr 26, 2018. It was last updated on Apr 26, 2018.

This page (macOS Setup) was last updated on Oct 15, 2021.

Text editor powered by tinymce.