Setup CircuitPython

CircuitPython is a derivative of MicroPython designed to simplify experimentation and education on low-cost microcontrollers. It makes it easier than ever to get prototyping by requiring no upfront desktop software downloads. Simply copy and edit files on the CIRCUITPY "flash" drive to iterate.

The following instructions will show you how to install CircuitPython. If you've already installed CircuitPython but are looking to update it or reinstall it, the same steps work for that as well!

It is suggested that if your board already has CircuitPython on it that you download and update to the latest stable version to ensure bugs are quashed and any new features are available.

Set up CircuitPython Quick Start!

Follow this quick step-by-step for super-fast Python power :)

Go to CircuitPython.Org/Downloads to find your CircuitPython compatible board.

Download the latest stable version of CircuitPython for your board. Save the .UF2 file to some known place on your computer.

Note the major version of CircuitPython you are downloading (the first number). As of this guide that is CircuitPython 4 although CircuitPython 5 is in alpha testing and may be the stable version when you get to this guide. Or perhaps CircuitPython 11? Just note that number for the next page of this guide.

Plug your board into your computer using a known-good USB cable.

A lot of people end up using charge-only USB cables and it is very frustrating! So make sure you have a USB cable you know is good for data sync.

Double-click the Reset button on your board, and you will see the NeoPixel RGB LED (green arrow) turn green. If it turns red, check the USB cable, try another USB port, etc. Note: The little red LED may pulse red. That's ok!

If double-clicking doesn't work the first time, try again. Sometimes it can take a few tries to get the rhythm right!

You will see a new disk drive appear, ending in BOOT, like PYPORTALBOOT.

Drag the adafruit-circuitpython--.uf2 file to the <boardname>BOOT drive.

The LED will flash. Then, the BOOT drive will disappear and a new disk drive called CIRCUITPY will appear.

If you haven't added any code to your board, the only file that will be present is boot_out.txt. This is absolutely normal! That file is a text file listing the version of CircuitPython which can be handy.

It's time for you to add your code.py and get started!

Issues?

See this page on FAQ with troubleshooting pages following.

This guide was first published on Aug 12, 2019. It was last updated on Aug 12, 2019. This page (Setup CircuitPython) was last updated on Aug 22, 2019.