CircuitPython

Overview

So, you've got this new CircuitPython compatible board. You plugged it in. Maybe it showed up as a disk drive called CIRCUITPY. Maybe it didn't! Either way, you need to know where to go from here. Well, we've got you covered!

This guide will get you started with CircuitPython!

There are many amazing things about your new board. One of them is the ability to run CircuitPython. You may have seen that name on the Adafruit site somewhere. Not sure what it is? We can help!
"But I've never coded in my life. There's no way I do it!" You absolutely can! CircuitPython is designed to help you learn from the ground up. If you're new to everything, this is the place to start!
This guide will walk you through how to get started with CircuitPython. You'll learn how to install CircuitPython, get updated to the newest version of CircuitPython, how to setup a serial connection, and how to edit the files.
Welcome to CircuitPython!

What is CircuitPython?

CircuitPython is a programming language designed to simplify experimenting and learning to program on low-cost microcontroller boards. It makes getting started easier than ever with no upfront desktop downloads needed. Once you get your board set up, open any text editor, and get started editing code. It's that simple.

CircuitPython is based on Python

Python is the fastest growing programming language. It's taught in schools and universities. It's a high-level programming language which means it's designed to be easier to read, write and maintain. It supports modules and packages which means it's easy to reuse your code for other projects. It has a built in interpreter which means there are no extra steps, like compiling, to get your code to work. And of course, Python is Open Source Software which means it's free for anyone to use, modify or improve upon.
CircuitPython adds hardware support to all of these amazing features. If you already have Python knowledge, you can easily apply that to using CircuitPython. If you have no previous experience, it's really simple to get started!

Why would I use CircuitPython?

CircuitPython is designed to run on microcontroller boards. A microcontroller board is a board with a microcontroller chip that's essentially an itty-bitty all-in-one computer. The board you're holding is a microcontroller board! CircuitPython is easy to use because all you need is that little board, a USB cable, and a computer with a USB connection. But that's only the beginning.
Other reasons to use CircuitPython include:
  • You want to get up and running quickly. Create a file, edit your code, save the file, and it runs immediately. There is no compiling, no downloading and no uploading needed.
  • You're new to programming. CircuitPython is designed with education in mind. It's easy to start learning how to program and you get immediate feedback from the board.
  • Easily update your code. Since your code lives on the disk drive, you can edit it whenever you like, you can also keep multiple files around for easy experimentation.
  • The serial console and REPL. These allow for live feedback from your code and interactive programming.
  • File storage. The internal storage for CircuitPython makes it great for data-logging, playing audio clips, and otherwise interacting with files.
  • Strong hardware support. There are many libraries and drivers for sensors, breakout boards and other external components.
  • It's Python! Python is the fastest-growing programming language. It's taught in schools and universities. CircuitPython is almost-completely compatible with Python. It simply adds hardware support.
This is just the beginning. CircuitPython continues to evolve, and is constantly being updated. We welcome and encourage feedback from the community, and we incorporate this into how we are developing CircuitPython. That's the core of the open source concept. This makes CircuitPython better for you and everyone who uses it!

Installing CircuitPython

Some of the CircuitPython compatible boards come with CircuitPython installed. Others are CircuitPython-ready, but need to have it installed. As well, you may want to update the version of CircuitPython already installed on your board. The steps are the same for installing and updating. Here we will cover how to install or update CircuitPython on your board.
You only have to install CircuitPython ONCE, after that you are free to code all you like without going through this process again until you want to upgrade!

Download the latest version!

The first thing you'll want to do is download the most recent version of CircuitPython.
Scroll down to the list of CircuitPython files, and choose the file appropriate to your board. Each file includes the name of the board it's compatible with. Download the file for your board.
Next, you'll want to plug in your board using a known-good USB data cable. Make sure the USB cable is a data cable! There are some that work only for charging and can lead to a lot of frustration.

Windows 7 Drivers

If you're using Windows 7, you need to install a driver before plugging in your board.
If you're using Windows 7, use the link below to download the driver package. You will not need to install drivers on Mac, Linux or Windows 10.

Start the UF2 Bootloader

Nearly all CircuitPython boards ship with a bootloader called UF2 (USB Flasher version 2) that makes installing and updating CircuitPython a quick and easy process. The bootloader is the mode your board needs to be in for the CircuitPython .uf2 file you downloaded to work. If the file you downloaded that matches the board name ends in uf2 then you want to continue with this section. However, if the file ends in .bin then you have to do a more complex installation - go to this page for how to do that.
Find the reset button on your board. It's a small, black button, and on most of the boards, it will be the only button available. (On Circuit Playground Express, it's the smaller button located in the center of the board.)
Tap this button twice to enter the bootloader. If it doesn't work on the first try, don't be discouraged. The rhythm of the taps needs to be correct and sometimes it takes a few tries. If you have a Circuit Playground Express, and it's fresh-out-of-the-bag try pressing the button once.
Once successful, the RGB LED on the board will flash red and then stay green. A new drive will show up on your computer. The drive will be called boardnameBOOT where boardname is a reference to your specific board. For example, a Feather will have FEATHERBOOT and a Trinket will have TRINKETBOOT etc. Going forward we'll just call the boot drive BOOT
The board is now in bootloader mode! This is what we need to install or update CircuitPython.
Now find the file you downloaded. Drag that file to the BOOT drive on your computer.
The lights should flash again, BOOT will disappear and a new drive will show up on your computer called CIRCUITPY.
Congratulations! You've successfully installed or updated CircuitPython!

Installing Mu Editor

Mu is a simple code editor that works with the Adafruit CircuitPython boards. It's written in Python and works on Windows, MacOS, Linux and Raspberry Pi. The serial console is built right in so you get immediate feedback from your board's serial output!
Mu is our recommended editor - please use it (unless you are an experienced coder with a favorite editor already!)

Installing Mu for Windows or Mac OS X

To install Mu for Windows or Mac OS X, head over to the Download Mu page and follow the instructions.
It's that simple!

Installing Mu for Linux

Each Linux distro is a little different, so use this as a guideline!
  1. Mu require python version 3. If you haven't installed python yet, do so via your command line using something like sudo apt-get install python3
  2. You'll also need pip3 (or pip if you only have python3 installed) - try running pip3 --version. If that didn't work, you ran sudo apt-get install python3-pip
  3. Finally, run pip3 install mu-editor
  4. You can now run mu-editor directly from the command line
You can also follow the instructions found here to install Mu using Python and install Mu on a Raspberry Pi.

Using Mu


The first time you start Mu, you will be prompted to select your 'mode' - you can always change your mind later. For now please select Adafruit!
The current mode is displayed in the lower right corner of the window, next to the "gear" icon. If the mode says "Microbit" or something else, click on that and then choose "Adafruit" in the dialog box that appears.

Mu attempts to auto-detect your board, so please plug in your CircuitPython device and make sure it shows up as a CIRCUITPY drive before starting Mu
Now you're ready to code! Lets keep going....

Mu Packages

Mu is currently being developed. So there are lots of changes being made! Current versions are available from links at the bottom of this page. However, use at your own risk! These are not stable versions and come with no guarantees of working.

PyCharm and CircuitPython


PyCharm is a full featured Python editor including super helpful things like code completion and error highlighting. It's available for free in a Community Edition.
Recently, they added a MicroPython plugin that enables use of the REPL from within the editor. CircuitPython isn't officially supported, however we have some steps to make it work!
Download and install PyCharm on your computer. Then, plug in your board and follow the steps below!

circuitpython_PyCharmCreateNewProject.png
Create a new project or open an existing project.

circuitpython_PyCharmSearchMicroPythonPlugin.png
circuitpython_PyCharmSearchMicroPythonPlugin.png
circuitpython_PyCharmSearchMicroPythonPlugin.png
Open PyCharm Preferences/Settings. Click on Plugins and search for "micropython". Click on Search in repositories.

circuitpython_PyCharmInstallMicroPythonPlugin.png
 

Click Install.

circuitpython_PyCharmMicroPythonRestartPyCharm.png
Once it's finished installing, click Restart PyCharm.

circuitpython_PyCharmLanguagesAndFrameworks.png
Once restarted, open Preferences/Settings. Click on Languages & Frameworks and choose MicroPython.

circuitpython_PyCharmChooseProjectDirectory.png
Choose your project directory from the list.

circuitpython_PyCharmChooseESP8266.png
Choose ESP8266 from the list of Device Names.

For now, you'll use this option regardless of what board you are using.

circuitpython_PyCharmAddDevicePath.png
You'll need to manually add your Device Path. This is the path to your serial connection. Once entered, click Ok.


If you need help finding your device's serial connection, see Advanced Serial Console on Windows and Advanced Serial Console on Mac and Linux.

circuitpython_PyCharmDependencies.png
Now, open any Python file from the project directory you chose.

A message may pop up stating, "Packages required for ESP8266 support not found," followed by a list of packages. Click Install Requirements on this message to install the required packages.

circuitpython_PyCharmToolsMicroPythonREPLMenu.png
circuitpython_PyCharmToolsMicroPythonREPLMenu.png
circuitpython_PyCharmToolsMicroPythonREPLMenu.png
Now, you can click on the Tools menu and you should find a MicroPython menu. Highlight this, and you'll find MicroPython REPL available.

circuitpython_PyCharmMicroPythonREPL.png
The REPL will open at the bottom of the PyCharm window. Now you can begin coding!
If you want to use the built in REPL with a different board, you'll need to go in and change the Device Path to the path that matches the board you'd like to use.
To change the Device Path, follow the steps above starting with manually adding the Device Path.
The PyCharm REPL will not work with multiple boards at the same time. Going through the steps above on multiple projects did not result in consistently being able to open multiple REPL connections at the same time.
The "Remove All Files from MicroPython Device" and "Flash Project" features do not work, but could corrupt your board. Do not try to use these functions. Remember, CircuitPython isn't officially supported and the steps above are a workaround.

Creating and Editing Code

One of the best things about CircuitPython is how simple it is to get code up and running. In this section, we're going to cover how to create and edit your first CircuitPython program.
To create and edit code, all you'll need is an editor. There are many options. We strongly recommend using Mu! It's designed for CircuitPython, and it's really simple and easy to use, with a built in serial console!
If you don't or can't use Mu, there are basic text editors built into every operating system such as Notepad on Windows, TextEdit on Mac, and gedit on Linux. However, many of these editors don't write back changes immediately to files that you edit. That can cause problems when using CircuitPython. See the Editing Code section below. If you want to skip that section for now, make sure you do "Eject" or "Safe Remove" on Windows or "sync" on Linux after writing a file if you aren't using Mu. (This is not a problem on MacOS.)

Creating Code


circuitpython_Screen_Shot_2017-12-24_at_3.20.56_PM.png
Open your editor, and create a new file. If you are using Mu, click the New button in the top left
Copy and paste the following code into your editor:
  1. import board
  2. import digitalio
  3. import time
  4.  
  5. led = digitalio.DigitalInOut(board.D13)
  6. led.direction = digitalio.Direction.OUTPUT
  7.  
  8. while True:
  9. led.value = True
  10. time.sleep(0.5)
  11. led.value = False
  12. time.sleep(0.5)

circuitpython_Screen_Shot_2017-12-24_at_3.22.58_PM.png
It will look like this - note that under the while True: line, the next four lines have spaces to indent them, but they're indented exactly the same amount. All other lines have no spaces before the text.

circuitpython_Screen_Shot_2017-12-24_at_6.39.00_PM.png
circuitpython_Screen_Shot_2017-12-24_at_6.39.00_PM.png
circuitpython_Screen_Shot_2017-12-24_at_2.57.36_PM.png
Save this file as code.py on your CIRCUITPY drive.
On each board you'll find a tiny red LED. It should now be blinking. Once per second
Congratulations, you've just run your first CircuitPython program!

Editing Code


circuitpython_Screen_Shot_2017-12-24_at_2.55.43_PM.png
To edit code, open the code.py file on your CIRCUITPY drive into your editor.

Make the desired changes to your code. Save the file. That's it!

Your code changes are run as soon as the file is done saving.

There's just one warning we have to give you before we continue...
Don't Click Reset or Unplug!
The CircuitPython code on your board detects when the files are changed or written and will automatically re-start your code. This makes coding very fast because you save, and it re-runs.
However, you must wait until the file is done being saved before unplugging or resetting your board! On Windows using some editors this can sometimes take up to 90 seconds, on Linux it can take 30 seconds to complete because the text editor does not save the file completely. Mac OS does not seem to have this delay, which is nice!
This is really important to be aware of. If you unplug or reset the board before your computer finishes writing the file to your board, you can corrupt the drive. If this happens, you may lose the code you've written, so it's important to backup your code to your computer regularly.
There are a few ways to avoid this:

1. Use an editor that writes out the file completely when you save it.

Recommended editors:
  • mu is an editor that safely writes all changes (it's also our recommended editor!)
  • emacs is also an editor that will fulIy write files on save
  • vim / vi safely writes all changes
  • Sublime Text safely writes all changes
  • The PyCharm IDE is safe if "Safe Write" is turned on in Settings->System Settings->Synchronization (true by default).
  • If you are using Atom, install this package so that it will always write out all changes to files on CIRCUITPY.
  • Visual Studio Code appears to safely write all changes
  • gedit on Linux appears to safely write all changes
We don't recommend these editors:
  • notepad (the default Windows editor) and Notepad++ can be slow to write, so we recommend the editors above! If you are using notepad, be sure to eject the drive (see below)
  • IDLE does not force out changes immediately
  • nano (on Linux) does not force out changes
  • Anything else - we haven't tested other editors so please use a recommended one!

2. Eject or Sync the Drive After Writing

If you are using one of our not-recommended-editors, not all is lost! You can still make it work.
On Windows, you can Eject or Safe Remove the CIRCUITPY drive. It won't actually eject, but it will force the operating system to save your file to disk. On Linux, use the sync command in a terminal to force the write to disk.

Oh No I Did Something Wrong and Now The CIRCUITPY Drive Doesn't Show Up!!!

Don't worry! Corrupting the drive isn't the end of the world (or your board!). If this happens, follow the steps found on the Troubleshooting page of every board guide to get your board up and running again.

Back to Editing Code...

Now! Let's try editing the program you added to your board. Open your code.py file into your editor. We'll make a simple change. Change the first 0.5 to 0.1. The code should look like this:
  1. import board
  2. import digitalio
  3. import time
  4.  
  5. led = digitalio.DigitalInOut(board.D13)
  6. led.direction = digitalio.Direction.OUTPUT
  7.  
  8. while True:
  9. led.value = True
  10. time.sleep(0.1)
  11. led.value = False
  12. time.sleep(0.5)
Leave the rest of the code as-is. Save your file. See what happens to the LED on your board? Something changed! Do you know why? Let's find out!

Exploring Your First CircuitPython Program

First, we'll take a look at the code we're editing.
Here is the original code again:
  1. import board
  2. import digitalio
  3. import time
  4.  
  5. led = digitalio.DigitalInOut(board.D13)
  6. led.direction = digitalio.Direction.OUTPUT
  7.  
  8. while True:
  9. led.value = True
  10. time.sleep(0.5)
  11. led.value = False
  12. time.sleep(0.5)

Imports & Libraries

Each CircuitPython program you run needs to have a lot of information to work. The reason CircuitPython is so simple to use is that most of that information is stored in other files and works in the background. These files are called libraries. Some of them are built into CircuitPython. Others are stored on your CIRCUITPY drive in a folder called lib.
  1. import board
  2. import digitalio
  3. import time
The import statements tells the board that you're going to use a particular library in your code. In this example, we imported three libraries: board, digitalio, and time. All three of these libraries are built into CircuitPython, so no separate files are needed. That's one of the things that makes this an excellent first example. You don't need any thing extra to make it work! board gives you access to the hardware on your board, digitalio lets you access that hardware as inputs/outputs and time let's you pass time by 'sleeping'

Setting Up The LED

The next two lines setup the code to use the LED.
  1. led = digitalio.DigitalInOut(board.D13)
  2. led.direction = digitalio.Direction.OUTPUT
Your board knows the red LED as D13. So, we initialise that pin, and we set it to output. We set led to equal the rest of that information so we don't have to type it all out again later in our code.

Loop-de-loops

The third section starts with a  while statement. while True: essentially means, "forever do the following:". while True: creates a loop. Code will loop "while" the condition is "true" (vs. false), and as True is never False, the code will loop forever. All code that is indented under while True: is "inside" the loop.
Inside our loop, we have four items:
  1. while True:
  2. led.value = True
  3. time.sleep(0.5)
  4. led.value = False
  5. time.sleep(0.5)
First, we have led.value = True. This line tells the LED to turn on. On the next line, we have time.sleep(0.5). This line is telling CircuitPython to pause running code for 0.5 seconds. Since this is between turning the led on and off, the led will be on for 0.5 seconds.
The next two lines are similar. led.value = False tells the LED to turn off, and time.sleep(0.5) tells CircuitPython to pause for another 0.5 seconds. This occurs between turning the led off and back on so the LED will be off for 0.5 seconds too.
Then the loop will begin again, and continue to do so as long as the code is running!
So, when you changed the first 0.5 to 0.1, you decreased the amount of time that the code leaves the LED on. So it blinks on really quickly before turning off!
Great job! You've edited code in a CircuitPython program!

More Changes

We don't have to stop there! Let's keep going. Change the second 0.5 to 0.1 so it looks like this:
  1. while True:
  2. led.value = True
  3. time.sleep(0.1)
  4. led.value = False
  5. time.sleep(0.1)
Now it blinks really fast! You decreased the both time that the code leaves the LED on and off!
Now try increasing both of the 0.1 to 1. Your LED will blink much more slowly because you've increased the amount of time that the LED is turned on and off.
Well done! You're doing great! You're ready to start into new examples and edit them to see what happens! These were simple changes, but major changes are done using the same process. Make your desired change, save it, and get the results. That's really all there is to it!

Naming Your Program File

CircuitPython looks for a code file on the board to run. There are four options: code.txt, code.py, main.txt and main.py. CircuitPython looks for those files, in that order, and then runs the first one it finds. While we suggest using code.py as your code file, it is important to know that the other options exist. If your program doesn't seem to be updating as you work, make sure you haven't created another code file that's being read instead of the one you're working on.

Connecting to the Serial Console

One of the staples of CircuitPython (and programming in general!) is something called a "print statement". This is a line you include in your code that causes your code to output text. A print statement in CircuitPython looks like this:
print("Hello, world!")
This line would result in:
Hello, world!
However, these print statements need somewhere to display. That's where the serial console comes in!
The serial console receives output from your CircuitPython board sent over USB and displays it so you can see it. This is necessary when you've included a print statement in your code and you'd like to see what you printed. It is also helpful for troubleshooting errors, because your board will send errors and the serial console will print those too.

The serial console requires a terminal program. A terminal is a program that gives you a text-based interface to perform various tasks.

Are you using Mu?

If so, good news! The serial console is built into Mu and will autodetect your board making using the REPL really really easy.
Please note that Mu does yet not work with nRF52 or ESP8266-based CircuitPython boards, skip down to the next section for details on using a terminal program.

circuitpython_Screen_Shot_2017-12-24_at_3.16.23_PM.png
First, make sure your CircuitPython board is plugged in. If you are using Windows 7, make sure you installed the drivers.
Once in Mu, look for the Serial button in the menu and click it.

Using Something Else?

If you're not using Mu to edit, are using ESP8266 or nRF52 CircuitPython, or if for some reason you are not a fan of the built in serial console, you can run the serial console as a separate program.
Windows requires you to download a terminal program, check out this page for more details
Mac and Linux both have one built in, though other options are available for download, check this page for more details

Interacting with the Serial Console

Once you've successfully connected to the serial console, it's time to start using it.
The code you wrote earlier has no output to the serial console. So, we're going to edit it to create some output.
Open your code.py file into your editor, and include a print statement. You can print anything you like! Just include your phrase between the quotation marks inside the parentheses. For example:
  1. import board
  2. import digitalio
  3. import time
  4.  
  5. led = digitalio.DigitalInOut(board.D13)
  6. led.direction = digitalio.Direction.OUTPUT
  7.  
  8. while True:
  9. print("Hello, CircuitPython!")
  10. led.value = True
  11. time.sleep(1)
  12. led.value = False
  13. time.sleep(1)
Save your file.
Now, let's go take a look at the window with our connection to the serial console.
Excellent! Our print statement is showing up in our console! Try changing the printed text to something else.
Keep your serial console window where you can see it. Save your file. You'll see what the serial console displays when the board reboots. Then you'll see your new change!
The Traceback (most recent call last): is telling you the last thing your board was doing before you saved your file. This is normal behavior and will happen every time the board resets. This is really handy for troubleshooting. Let's introduce an error so we can see how it is used.
Delete the e at the end of True from the line led.value = True so that it says led.value = Tru
Save your file. You will notice that your red LED will stop blinking, and you may have a colored status LED blinking at you. This is because the code is no longer correct and can no longer run properly. We need to fix it!
Usually when you run into errors, it's not because you introduced them on purpose. You may have 200 lines of code, and have no idea where your error could be hiding. This is where the serial console can help. Let's take a look!
The Traceback (most recent call last): is telling you that the last thing it was able to run was line 10 in your code. The next line is your error: NameError: name 'Tru' is not defined. This error might not mean a lot to you, but combined with knowing the issue is on line 10, it gives you a great place to start!
Go back to your code, and take a look at line 10. Obviously, you know what the problem is already. But if you didn't, you'd want to look at line 10 and see if you could figure it out. If you're still unsure, try googling the error to get some help. In this case, you know what to look for. You spelled True wrong. Fix the typo and save your file.
Nice job fixing the error! Your serial console is streaming and your red LED Is blinking again.
The serial console will display any output generated by your code. Some sensors, such as a humidity sensor or a thermistor, receive data and you can use print statements to display that information. You can also use print statements for troubleshooting. If your code isn't working, and you want to know where it's failing, you can put print statements in various places to see where it stops printing.
The serial console has many uses, and is an amazing tool overall for learning and programming!

The REPL

The other feature of the serial connection is the Read-Evaluate-Print-Loop, or REPL. The REPL allows you to enter individual lines of code and have them run immediately. It's really handy if you're running into trouble with a particular program and can't figure out why. It's interactive so it's great for testing new ideas.
To use the REPL, you first need to be connected to the serial console. Once that connection has been established, you'll want to press Ctrl + C.
If there is code running, it will stop and you'll see Press any key to enter the REPL. Use CTRL-D to reload. Follow those instructions, and press any key on your keyboard.
The Traceback (most recent call last): is telling you the last thing your board was doing before you pressed Ctrl + C and interrupted it. The KeyboardInterrupt is you pressing Ctrl + C. This information can be handy when troubleshooting, but for now, don't worry about it. Just note that it is expected behavior.
If there is no code running, you will enter the REPL immediately after pressing Ctrl + C. There is no information about what your board was doing before you interrupted it because there is no code running.
Either way, once you press a key you'll see a >>> prompt welcoming you to the REPL!
If you have trouble getting to the >>> prompt, try pressing Ctrl + C a few more times.
The first thing you get from the REPL is information about your board.
This line tells you the version of CircuitPython you're using and when it was released. Next, it gives you the type of board you're using and the type of microcontroller the board uses. Each part of this may be different for your board depending on the versions you're working with.
This is followed by the CircuitPython prompt.
From this prompt you can run all sorts of commands and code. The first thing we'll do is run help(). This will tell us where to start exploring the REPL. To run code in the REPL, type it in next to the REPL prompt.
Type help() next to the prompt in the REPL.
Then press enter. You should then see a message.
First part of the message is another reference to the version of CircuitPython you're using. Second, a URL for the CircuitPython related project guides. Then... wait. What's this? To list built-in modules, please do `help("modules")`. Remember the libraries you learned about while going through creating code? That's exactly what this is talking about! This is a perfect place to start. Let's take a look!
Type help("modules") into the REPL next to the prompt, and press enter.
This is a list of all the core libraries built into CircuitPython. We discussed how board contains all of the pins on the board that you can use in your code. From the REPL, you are able to see that list!
Type import board into the REPL and press enter. It'll go to a new prompt. It might look like nothing happened, but that's not the case! If you recall, the import statement simply tells the code to expect to do something with that module. In this case, it's telling the REPL that you plan to do something with that module.
Next, type dir(board) into the REPL and press enter.
This is a list of all of the pins on your board that are available for you to use in your code. Each board's list will differ slightly depending on the number of pins available. Do you see D13? That's the pin you used to blink the red LED!
The REPL can also be used to run code. Be aware that any code you enter into the REPL isn't saved anywhere. If you're testing something new that you'd like to keep, make sure you have it saved somewhere on your computer as well!
Every programmer in every programming language starts with a piece of code that says, "Hello, World." We're going to say hello to something else. Type into the REPL:
print("Hello, CircuitPython!")
Then press enter.
That's all there is to running code in the REPL! Nice job!
You can write single lines of code that run stand-alone. You can also write entire programs into the REPL to test them. As we said though, remember that nothing typed into the REPL is saved.
There's a lot the REPL can do for you. It's great for testing new ideas if you want to see if a few new lines of code will work. It's fantastic for troubleshooting code by entering it one line at a time and finding out where it fails. It lets you see what libraries are available and explore those libraries.
Try typing more into the REPL to see what happens!

Returning to the serial console

When you're ready to leave the REPL and return to the serial console, simply press Ctrl + D. This will reload your board and reenter the serial console. You will restart the program you had running before entering the REPL. In the console window, you'll see any output from the program you had running. And if your program was affecting anything visual on the board, you'll see that start up again as well.
You can return to the REPL at any time!

CircuitPython Hardware

Now it's time to do something great with what you've learned! Every CircuitPython board is perfect for projects. However, each one excels in different areas. We're going to give you some details about each board, and highlight Learn guides where each one is used. You can try these out or get ideas for your own project!

Trinket M0

The Adafruit Trinket M0 is the smallest CircuitPython board we carry. But don't let that fool you! It's a tiny board with a lot of power. We wanted to design a microcontroller board that was small enough to fit into any project, and low cost enough to use without hesitation. Planning to test a proof of concept and need a CircuitPython board to throw in? Not ready to disassemble the project you worked so hard to design to extract the board you used last time? Trinket M0 has you covered. It's the lowest cost CircuitPython board available but it easily holds its own with the bigger boards!
Trinket M0 ships with CircuitPython and comes with demo code already on the board. You can open and edit the main.py file found on the CIRCUITPY drive to get started, or create your own! The Trinket M0 guide gives you everything you need to know about your board. Check out the CircuitPython section to find a huge list of examples to try.
You can use Trinket M0 to make the Chilled Drinkibot which uses the Trinket to control thermoelectric cooling of a beverage. Or build a spooky Halloween project that turns your candy bucket into a Screaming Cauldron!

Gemma M0

The Adafruit Gemma M0 is a tiny CircuitPython board with just enough built-in to build many simple projects. It's designed to be worked into your wearable projects, with big holes around the outside for sewing (and they're alligator clip friendly too!). Gemma M0 will super-charge your wearables and is easier to use than ever. There are capacitive touch pads, an on-off switch and an RGB DotStar LED built right into the board so there's plenty you can do without adding a thing. Add conductive thread and LEDs and you'll have a blinky wearable in no time!
Like Trinket, Gemma M0 ships with CircuitPython and has demo code already on the board. You can open and edit the main.py file on the CIRCUITPY drive, or create your own! The Gemma M0 guide shows you all the info about your board, and has a great list of CircuitPython examples to try out.
Use Gemma M0 to create a pair of Clockwork Goggles with fun light patterns on NeoPixel rings. Or accessorise with this 3D printed Sheikah Pendant to add a bit of light to your next costume!

Circuit Playground Express

The Adafruit Circuit Playground Express is the next step towards a perfect introduction to electronics and programming. It's packed full of sensors, LEDs, buttons and switches, and it's super easy to get started with! This board is super versatile. Whether you're new to electronics and programming, or a seasoned veteran, Circuit Playground Express is an amazing board to work with. With so much built into the board, you can learn how different types of electronics work and learn to program them all without purchasing any other parts. All you need is a USB cable and the board! But, that's just the beginning. Many of the pads around the outside of the board function in multiple ways allowing you to wire other things to the board. For example, you could wire up a servo or a potentiometer. The possibilities are endless!
The Circuit Playground Express guide has tons of information on all the fantastic features of the board. The CircuitPython section of the guide has an extensive list of examples using the built-in features of the CircuitPython and the board. There is also a section called Python Playground with more demos and a Drum Machine project to try out.
You can turn your Circuit Playground Express into a capacitive touch tone Piano in the Key of Lime using the touch pads on the board. Use the built in accelerometer to make a UFO Flying Saucer complete with lights and alien sounds using your board, and some extra supplies from around the house or a 3D printed saucer!

Feather M0 Express

The Adafruit Feather M0 Express is the first Feather designed specifically for CircuitPython. It's part of a line of Adafruit Feather development boards designed to work standalone or stacked, and is powered by USB or lithium ion battery so it works for both stationary and on-the-go projects. Feather M0 Express comes with two headers for use with a solderless breadboard, or you can solder wires directly to the pins on the board. This allows for prototyping while you're working on your project and permanent installation when you're ready. One of the things that makes the Feather M0 Express amazing is the the huge array of boards called Featherwings which are designed to fit right on the Feather. There are CircuitPython libraries for many of these boards and more are being written all the time.
Feather M0 Express ships CircuitPython-ready with the UF2 bootloader installed and ready for you to install CircuitPython when you receive your board. Create your first program, save it to the board, and off you go! The Feather M0 Express guide has all the details about your board, and a CircuitPython section to get you started.
Feather M0 Express can be used to power all kinds of projects. Build a CircuitPython Painter POV LED wand using 3D printed parts and DotStar strips. Create an engraved edge-lit LED Acrylic Sign with NeoPixels. There are guides to go with the Featherwings that explain how to use them with CircuitPython, like the OLED Display and Adalogger Featherwing.

Metro M0 Express

Metro M0 Express is the first Metro board designed to work with CircuitPython. This is not a beginner board. If you're just getting started, we'd recommend one of the previous boards. It has a lot of the same features as Feather M0 Express, as well as some development specific features (like the SWD port built in!). The Metro M0 Express is designed to work with the Arduino form-factor, so if you've already got Arduino shields, this board would be great for you. There are CircuitPython libraries for some shields already. It has 25 GPIO pins (the most of any of these boards!) so it's great if you're looking for a lot of options.
Metro M0 Express ships CircuitPython-ready with the UF2 bootloader installed and is ready for you to install CircuitPython when you receive your board. Create your first program, save it to the board, and you're good to go! The Metro M0 Express guide gives you all the details about your board, and the CircuitPython section is available to get you started.
All sensors and breakout boards with CircuitPython libraries will work with the Metro M0 Express running CircuitPython. Find the guide for your sensor and follow the guide to find out how to wire it up. There are a ton of options available.

What's Next?

Now you're ready to jump into some more Learn Guides or simply get started with a brand new project. Great job, and good luck!

CircuitPython Libraries

Each CircuitPython program you run needs to have a lot of information to work. The reason CircuitPython is so simple to use is that most of that information is stored in other files and works in the background. These files are called libraries. Some of them are built into CircuitPython. Others are stored on your CIRCUITPY drive in a folder called lib. Part of what makes CircuitPython so awesome is its ability to store code separately from the firmware itself. Storing code separately from the firmware makes it easier to update both the code you write and the libraries you depend.
Your board may ship with a lib folder already, its in the base directory of the drive. If not, simply create the folder yourself.
CircuitPython libraries work in the same was as regular Python modules so the Python docs are a great reference for how it all should work. In Python terms, we can place our library files in the lib directory because its part of the Python path by default.
One downside of this approach of separate libraries is that they are not built in. To use them, one needs to copy them to the CIRCUITPY drive before they can be used. Fortunately, we provide a bundle full of our libraries.
Our bundle and releases also feature optimized versions of the libraries with the .mpy file extension. These files take less space on the drive and have a smaller memory footprint as they are loaded.

Installing the CircuitPython Library Bundle

We're constantly updating and improving our libraries, so we don't (at this time) ship our CircuitPython boards with the full library bundle. Instead, you can find example code in the guides for your board that depends on external libraries. Some of these libraries may be available from us at Adafruit, some may be written by community members!
Either way, as you start to explore CircuitPython, you'll want to know how to get libraries on board.
You can grab the latest Adafruit CircuitPython 2.x Bundle release by clicking this button:
If you need another version, you can also visit the bundle release page which will let you select exactly what version you're looking for, as well as information about changes.
Either way, download the version that matches your CircuitPython run-time. For example, if you're running v2.2 download the v2 bundle. If you're running 3.0, download the v3 bundle. There's also a py bundle which contains the uncompressed python files, you probably don't want that!
After downloading the zip, extract its contents. This is usually done by double clicking on the zip. On Mac OSX, it places the file in the same directory as the zip.
When you open the folder, you'll see a large number of mpy files and folders

Express Boards

If you are using a Feather M0 Express, Metro M0 Express or Circuit Playground Express (or any other "Express" board) your CircuitPython board comes with at least 2 MB of Flash storage. This is plenty of space for all of our library files so we recommend you just install them all! (If you have a Gemma M0 or Trinket M0 or other non-Express board, skip down to the next section)
On Express boards, the lib directory can be copied directly to the CIRCUITPY drive.
Just drag the entire lib folder into the CIRCUITPY drive, and 'replace' any old files if your operating system prompts you

Non-Express Boards

If you are using Trinket M0 or Gemma M0, you will need to load the libraries individually, due to file space restrictions. If you are using a non-express board, or you would rather load libraries as you use them, you'll first want to create a lib folder on your CIRCUITPY drive. Open the drive, right click, choose the option to create a new folder, and call it lib. Then, open the lib folder you extracted from the downloaded zip. Inside you'll find a number of folders and .mpy files. Find the library you'd like to use, and copy it to the lib folder on CIRCUITPY.

Example: ImportError Due to Missing Library

If you choose to load libraries as you need them, you may write up code that tries to use a library you haven't yet loaded.  We're going to demonstrate what happens when you try to utilise a library that you don't have loaded on your board, and cover the steps required to resolve the issue. This demonstration will only return an error if you do not have the required library loaded into the lib folder on your CIRCUITPY drive.
Let's use a modified version of the blinky example.
  1. import board
  2. import time
  3. import simpleio
  4.  
  5. led = simpleio.DigitalOut(board.D13)
  6.  
  7. while True:
  8. led.value = True
  9. time.sleep(0.5)
  10. led.value = False
  11. time.sleep(0.5)
Save this file. Nothing happens to your board. Let's check the serial console to see what's going on.
We have an ImportError. It says there is no module named 'simpleio'. That's the one we just included in our code!
Click the link above to download the correct bundle. Extract the lib folder from the downloaded bundle file. Scroll down to find simpleio.mpy. This is the library file we're looking for! Follow the steps above to load an individual library file.
The LED starts blinking again! Let's check the serial console.
No errors! Excellent. You've successfully resolved an ImportError!
If you run into this error in the future, follow along with the steps above and choose the library that matches the one you're missing.

Library Install on Non-Express Boards

If you have a Trinket M0 or Gemma M0, you'll want to follow the same steps in the example above to install libraries as you need them. You don't always need to wait for an ImportError as you probably know what library you added to your code. Simply open the lib folder you downloaded, find the library you need, and drag it to the lib folder on your CIRCUITPY drive.
For these boards, your internal storage is from the chip itself. So, these boards don't have enough space for all of the libraries. If you try to copy over the entire lib folder you won't have enough space on your CIRCUITPY drive.
You may end up running out of space on your Trinket M0 or Gemma M0 even if you only load libraries as you need them. There are a number of steps you can use to try to resolve this issue. You'll find them in the Troubleshooting page in the Learn guides for your board.

Updating CircuitPython Libraries

Libraries are updated from time to time, and it's important to update the files you have on your CIRCUITPY drive.
To update a single library, follow the same steps above. When you drag the library file to your lib folder, it will ask if you want to replace it. Say yes. That's it!
If you'd like to update the entire bundle at once, drag the lib folder to your CIRUCITPY drive. Different operating systems will have a different dialog pop up. You want to tell it to replace the current folder. Then you're updated and ready to go!
A new library bundle is released every time there's an update to a library. Updates include things like bug fixes and new features. It's important to check in every so often to see if the libraries you're using have been updated.

Welcome to the Community!

CircuitPython is a programming language that's super simple to get started with and great for learning. It runs on microcontrollers and works out of the box. You can plug it in and get started with any text editor. The best part? CircuitPython comes with an amazing, supportive community.
Everyone is welcome! CircuitPython is Open Source. This means it's available for anyone to use, edit, copy and improve upon. This also means CircuitPython becomes better because of you being a part of it. It doesn't matter whether this is your first microcontroller board or you're a computer engineer, you have something important to offer the Adafruit CircuitPython community. We're going to highlight some of the many ways you can be a part of it!

Adafruit Discord

The Adafruit Discord server is the best place to start. Discord is where the community comes together to volunteer and provide live support of all kinds. From general discussion to detailed problem solving, and everything in between, Discord is a digital maker space with makers from around the world.
There are many different channels so you can choose the one best suited to your needs. Each channel is shown on Discord as "#channelname". There's the #projecthelp channel for assistance with your current project or help coming up with ideas for your next one. There's the #showandtell channel for showing off your newest creation. Don't be afraid to ask a question in any channel! If you're unsure, #general is a great place to start. If another channel is more likely to provide you with a better answer, someone will guide you.
The CircuitPython channel is where to go with your CircuitPython questions. #circuitpython is there for new users and developers alike so feel free to ask a question or post a comment! Everyone of any experience level is welcome to join in on the conversation. We'd love to hear what you have to say!
The easiest way to contribute to the community is to assist others on Discord. Supporting others doesn't always mean answering questions. Join in celebrating successes! Celebrate your mistakes! Sometimes just hearing that someone else has gone through a similar struggle can be enough to keep a maker moving forward.
The Adafruit Discord is the 24x7x365 hackerspace that you can bring your granddaughter to.
Visit https://adafru.it/discord to sign up for Discord. We're looking forward to meeting you!

Adafruit Forums

The Adafruit Forums are the perfect place for support. Adafruit has wonderful paid support folks to answer any questions you may have. Whether your hardware is giving you issues or your code doesn't seem to be working, the forums are always there for you to ask. You need an Adafruit account to post to the forums. You can use the same account you use to order from Adafruit.
While Discord may provide you with quicker responses than the forums, the forums are a more reliable source of information. If you want to be certain you're getting an Adafruit-supported answer, the forums are the best place to be.
There are forum categories that cover all kinds of topics, including everything Adafruit. The Adafruit CircuitPython and MicroPython category under "Supported Products & Projects" is the best place to post your CircuitPython questions.
Be sure to include the steps you took to get to where you are. If it involves wiring, post a picture! If your code is giving you trouble, include your code in your post! These are great ways to make sure that there's enough information to help you with your issue.
You might think you're just getting started, but you definitely know something that someone else doesn't. The great thing about the forums is that you can help others too! Everyone is welcome and encouraged to provide constructive feedback to any of the posted questions. This is an excellent way to contribute to the community and share your knowledge!

Adafruit Github

Whether you're just beginning or are life-long programmer who would like to contribute, there are ways for everyone to be a part of building CircuitPython. GitHub is the best source of ways to contribute to CircuitPython itself. If you need an account, visit https://github.com/ and sign up.
If you're new to GitHub or programming in general, there are great opportunities for you. Head over to adafruit/circuitpython on GitHub, click on "Issues", and you'll find a list that includes issues labeled "good first issue". These are things we've identified as something that someone with any level of experience can help with. These issues include options like updating documentation, providing feedback, and fixing simple bugs.
Already experienced and looking for a challenge? Checkout the rest of the issues list and you'll find plenty of ways to contribute. You'll find everything from new driver requests to core module updates. There's plenty of opportunities for everyone at any level!
When working with CircuitPython, you may find problems. If you find a bug, that's great! We love bugs! Posting a detailed issue to GitHub is an invaluable way to contribute to improving CircuitPython. Be sure to include the steps to replicate the issue as well as any other information you think is relevant. The more detail, the better!
Testing new software is easy and incredibly helpful. Simply load the newest version of CircuitPython or a library onto your CircuitPython hardware, and use it. Let us know about any problems you find by posting a new issue to GitHub. Software testing on both current and beta releases is a very important part of contributing CircuitPython. We can't possibly find all the problems ourselves! We need your help to make CircuitPython even better.
On GitHub, you can submit feature requests, provide feedback, report problems and much more. If you have questions, remember that Discord and the Forums are both there for help!

ReadTheDocs

ReadTheDocs is a an excellent resource for a more in depth look at CircuitPython. This is where you'll find things like API documentation and details about core modules. There is also a Design Guide that includes contribution guidelines for CircuitPython.
RTD gives you access to a low level look at CircuitPython. There are details about each of the core modules. Each module lists the available libraries. Each module library page lists the available parameters and an explanation for each. In many cases, you'll find quick code examples to help you understand how the modules and parameters work, however it won't have detailed explanations like the Learn Guides. If you want help understanding what's going on behind the scenes in any CircuitPython code you're writing, ReadTheDocs is there to help!

CircuitPython for ESP8266

We have two 'strains' of CircuitPython, the primary one is the ATSAMD21/51-based boards that have native USB connectivity. Native USB means that the board can show up as a disk drive called CIRCUITPY and hold all your files on it.
There's also CircuitPython for boards like the ESP8266 and nRF52832, these are really nice chips with WiFi and Bluetooth, respectively, built in. But they do not have native USB! That means there is no way for the chip to appear as a disk drive. You can still use them with CircuitPython but its a lot tougher, so we don't recommend them for beginners. (When USB-native versions of these chips come out, we'll take a look at making them show up like a drive!)
Here's what you have to know about using non-native chips for CircuitPython:
  • You only get a REPL connection! No HID keyboard/mouse or other USB interface
  • No disk drive for drag-n-drop file moving, files must be moved via a special tool such as ampy that 'types' the file in for you via the REPL
  • Loading CircuitPython requires command line tools

Installing CircuitPython on the ESP8266

To use CircuitPython with the ESP8266 you'll need to first flash it with the latest firmware.

Download esptool

First install the esptool.py software which enables firmware flashing on the ESP8266.  The easiest way to install this tool is from Python's pip package manager.  If you don't have it already you'll need to install Python 2.7 (make sure you check the box to put Python in your system path when installing on Windows) and then run the following command in a terminal: pip install esptool
Note on Mac OSX and Linux you might need to run the command as root with sudo, like: sudo pip install esptool
If you receive an error that esptool.py only supports Python 2.x try running again with the pip2 command instead of pip (likely your system is using Python 3 and the pip command is getting confused which version to use).

Download Latest CircuitPython Firmware

Next download the latest CircuitPython ESP8266 firmware file.  You can automatically download the latest binary by clicking here:

Get ESP8266 Ready For Bootloading

Now you'll need to put the ESP8266 into its firmware flashing mode.  Each ESP8266 board is slightly different:
  • For a raw ESP8266 module you'll need to wire up buttons to ground for the GPIO0 and RESET pins.  Hold the GPIO0 button down (or connect the line to ground) and while still holding GPIO0 to ground press and release the RESET button (or connect and release the line from ground), then release GPIO0.
  • For the HUZZAH ESP8266 breakout buttons for GPIO0 and RESET are built in to the board.  Hold GPIO0 down, then press and release RESET (while still holding GPIO0), and finally release GPIO0.
  • For the Feather HUZZAH ESP8266 you don't need to do anything special to go into firmware flashing mode.  This board is built to detect when the serial port is opened for flashing and automatically configure the ESP8266 module to receive firmware.  Be sure to first install the SiLabs CP210x driver on Windows and Mac OSX to make the board's serial port visible!  On Windows you want the normal VCP driver, not the 'with Serial Enumeration' driver.

Erase ESP8266

It's recommended to erase the entire flash memory of the ESP8266 board before uploading firmware. Run the following command in a terminal to perform this erase:
  1. esptool.py --port ESP8266_PORTNAME erase_flash
Where ESP8266_PORTNAME is the path or name of the serial port that is connected to the ESP8266.  The exact name of the device varies depending on the type of serial to USB converter chip so you might need to look at the serial ports with and without the device connected to find its name.

Program ESP8266

Now put the ESP8266 back into firmware flashing mode and run the following command to load the downloaded firmware file:
  1. esptool.py --port ESP8266_PORTNAME --baud 115200 write_flash --flash_size=detect 0 firmware.bin
Again set ESP8266_PORTNAME to the path or name of the serial port that is connected to the ESP8266.  In addition set firmware.bin to the name or path to the firmware file you would like to load.
Once the tool finishes flashing the firmware (you'll usually see a blue light on the ESP8266 module flashing during this process) press the RESET button on the ESP8266 board or disconnect and reconnect it to your computer.  You should be all set to start using the latest CircuitPython firmware on the board!
Note that if you see an error that "detect is not a valid flash_size parameter" you might be using an older version of esptool.py.  To upgrade to the latest version run the following command pip install --upgrade esptool

Upload Libraries & Files Using Ampy!

The biggest difference you'll find with ESP8266 is that you need to use a special tool to move files around. Check out ampy by reading this guide. It's about MicroPython but CircuitPython is nearly identical so the the overall installation and usage is identical!

Other Stuff To Know!

  • The REPL works as you'd expect, so check out that introductory page.
  • File storage is in the same chip as CircuitPython so if you update, you may lose your files! Keep backups.
  • Libraries and API are also the same as for other CircuitPython boards.
  • Note that the ESP8266 does not have a ton of pins available, and only one analog input with 0-1.0V range. There is no UART port available (it's the one used for the REPL!)
  • There are no analog outputs.
  • For SPI and I2C, you can use them! But you will need to use bitbangio to create the bus objects

Advanced Serial Console on Windows


Windows 7 Driver

If you're using Windows 7, use the link below to download the driver package. You will not need to install drivers on Mac, Linux or Windows 10.

What's the COM?

First, you'll want to find out which serial port your board is using. When you plug your board in to USB on your computer, it connects to a serial port. The port is like a door through which your board can communicate with your computer using USB.
We'll use Windows Device Manager to determine which port the board is using. The easiest way to determine which port the board is using is to first check without the board plugged in. Open Device Manager. Click on Ports (COM & LPT). You should find something already in that list with (COM#) after it where # is a number.
Now plug in your board. The Device Manager list will refresh and a new item will appear under Ports (COM & LPT). You'll find a different (COM#) after this item in the list.
Sometimes the item will refer to the name of the board. Other times it may be called something like USB Serial Device, as seen in the image above. Either way, there is a new (COM#) following the name. This is the port your board is using.

Install Putty

If you're using Windows, you'll need to download a terminal program. We're going to use PuTTY.
The first thing to do is download the latest version of PuTTY. You'll want to download the Windows installer file. It is most likely that you'll need the 64-bit version. Download the file and install the program on your machine. If you run into issues, you can try downloading the 32-bit version instead. However, the 64-bit version will work on most PCs.
Now you need to open PuTTY.
  • Under Connection type: choose the button next to Serial.
  • In the box under Serial line, enter the serial port you found that your board is using.
  • In the box under Speed, enter 115200. This called the baud rate, which is the speed in bits per second that data is sent over the serial connection. For boards with built in USB it doesn't matter so much but for ESP8266 and other board with a separate chip, the speed required by the board is 115200 bits per second. So you might as well just use 115200!
If you want to save those settings for later, use the options under Load, save or delete a stored session. Enter a name in the box under Saved Sessions, and click the Save button on the right.
Once your settings are entered, you're ready to connect to the serial console. Click "Open" at the bottom of the window. A new window will open.
If no code is running, the window will either be blank or will look like the window above. Now you're ready to see the results of your code.
Great job! You've connected to the serial console!

Advanced Serial Console on Mac and Linux

Connecting to the serial console on Mac and Linux uses essentially the same process. Neither operating system needs drivers installed. On MacOSX, Terminal comes installed. On Linux, there are a variety such as gnome-terminal (called Terminal) or Konsole on KDE.

What's the Port?

First you'll want to find out which serial port your board is using. When you plug your board in to USB on your computer, it connects to a serial port. The port is like a door through which your board can communicate with your computer using USB.
We're going to use Terminal to determine what port the board is using. The easiest way to determine which port the board is using is to first check without the board plugged in. On Mac, open Terminal and type the following:
ls /dev/tty.*
Each serial connection shows up in the /dev/ directory. It has a name that starts with tty.. The command ls shows you a list of items in a directory. You can use * as a wildcard, to search for files that start with the same letters but end in something different. In this case, we're asking to see all of the listings in /dev/ that start with tty. and end in anything. This will show us the current serial connections.
For Linux, the procedure is the same, however, the name is slightly different. If you're using Linux, you'll type:
ls /dev/ttyACM*
The concept is the same with Linux. We are asking to see the listings in the /dev/ folder, starting with ttyACM and ending with anything. This will show you the current serial connections. In the example below, the error is indicating that are no current serial connections starting with ttyACM.
Now, plug your board. Using Mac, type:
ls /dev/tty.*
This will show you the current serial connections, which will now include your board.
Using Mac, a new listing has appeared called /dev/tty.usbmodem141441. The tty.usbmodem141441 part of this listing is the name the example board is using. Yours will be called something similar.
Using Linux, type:
ls /dev/ttyACM*
This will show you the current serial connections, which will now include your board.
Using Linux, a new listing has appeared called /dev/ttyACM0. The ttyACM0 part of this listing is the name the example board is using. Yours will be called something similar.

Connect with screen

Now that you know the name your board is using, you're ready connect to the serial console. We're going to use a command called screen. The screen command is included with MacOS. Linux users may need to install it using their package manager. To connect to the serial console, use Terminal. Type the following command, replacing board_name with the name you found your board is using:
screen /dev/tty.board_name 115200
The first part of this establishes using the screen command. The second part tells screen the name of the board you're trying to use. The third part tells screen what baud rate to use for the serial connection. The baud rate is the speed in bits per second that data is sent over the serial connection. In this case, the speed required by the board is 115200 bits per second.
circuitpython_ScreenCommandMac.png
MacOS screen command using example board name
circuitpython_linuxscreencommand.png
Linux screen command using example board name
Press enter to run the command. It will open in the same window. If no code is running, the window will be blank. Otherwise, you'll see the output of your code.
Great job! You've connected to the serial console!

Permissions on Linux

If you try to run screen and it doesn't work, then you may be running into an issue with permissions. Linux keeps track of users and groups and what they are allowed to do and not do, like access the hardware associated with the serial connection for running screen. So if you see something like this:
then you may need to grant yourself access. There are generally two ways you can do this. The first is to just run screen using the sudo command, which temporarily gives you elevated privileges.
Once you enter your password, you should be in:
The second way is to add yourself to the group associated with the hardware. To figure out what that group is, use the command ls -l as shown below. The group name is circled in red.
Then use the command adduser to add yourself to that group. You need elevated privileges to do this, so you'll need to use sudo. In the example below, the group is adm and the user is ackbar.
You'll need to logout and log back in. Then you can verify that you have been added to the group using the command groups.
And now you should be able to run screen without using sudo.
And you're in:

Uninstalling CircuitPython

A lot of our boards can be used with multiple programming languages. For example, the Circuit Playground Express can be used with MakeCode, Code.org CS Discoveries, CircuitPython and Arduino.
Maybe you tried CircuitPython and want to go back to MakeCode or Arduino? Not a problem
You can always remove/re-install CircuitPython whenever you want! Heck, you can change your mind every day!

Backup Your Code

Before uninstalling CircuitPython, don't forget to make a backup of the code you have on the little disk drive. That means your main.py or code.py any other files, the lib folder etc. You may lose these files when you remove CircuitPython, so backups are key! Just drag the files to a folder on your laptop or desktop computer like you would with any USB drive.

Moving to MakeCode

If you want to go back to using MakeCode, its really easy. Visit makecode.adafruit.com and find the program you want to upload. Click Download to download the .uf2 file that is generated by MakeCode.
Now double-click your CircuitPython board until you see the onboard LED(s) turn green and the ...BOOT directory shows up.
Then find the downloaded MakeCode .uf2 file and drag it to the ...BOOT drive.
Your MakeCode is now running and CircuitPython has been removed. Going forward you only have to single click the reset button

Moving to Arduino

If you want to change your firmware to Arduino, it's also pretty easy.
Start by plugging in your board, and double-clicking reset until you get the green onboard LED(s) - just like with MakeCode
Within Arduino IDE, select the matching board, say Circuit Playground Express
Select the correct matching Port:
Create a new simple Blink sketch example:
  1. // the setup function runs once when you press reset or power the board
  2. void setup() {
  3. // initialize digital pin 13 as an output.
  4. pinMode(13, OUTPUT);
  5. }
  6.  
  7. // the loop function runs over and over again forever
  8. void loop() {
  9. digitalWrite(13, HIGH); // turn the LED on (HIGH is the voltage level)
  10. delay(1000); // wait for a second
  11. digitalWrite(13, LOW); // turn the LED off by making the voltage LOW
  12. delay(1000); // wait for a second
  13. }
Make sure the LED(s) are still green, then click Upload to upload Blink. Once it has uploaded successfully, the serial Port will change so re-select the new Port!
Once Blink is uploaded you should no longer need to double-click to enter bootloader mode, Arduino will automatically reset when you upload

Non-UF2 Installation

This installation page is only required if you do not have UF2 bootloader installed (e.g. boardBOOT drag-n-drop)! This page is for non-Express Feather M0's, Arduino Zero's & M0's, and other custom ATSAMD21 boards.

Flashing with Bossac - For Non-Express Feather M0's & Arduino Zero

Our older Feather M0 boards don't come with UF2, instead they come with a simpler bootloader called bossa. This is also what is installed on Arduino Zero's and other Zero-compatible boards that use the ATSAMD21. It is the only method you can use if your CircuitPython installation file is a .bin rather than a .uf2

Command-Line ahoy!

Flashing with bossac requires the use of your computer's command line interface. On windows, that's the cmd or powershell tool. On mac and linux, use Terminal!

Download Latest CircuitPython Firmware

The first thing you'll want to do is download the most recent version of CircuitPython.
Once downloaded, save the .bin file onto your desktop, you'll need it soon!
If you are running Windows 7, you must install the driver set (we cover it on this page) so you have access to the COM port.

Download BOSSA

Once you have a firmware image you'll need to download a special version of the BOSSA tool that can load firmware on SAMD21 boards. This tool is actually used internally by the Arduino IDE when it programs these boards, however you can use it yourself to load custom firmware
Be aware you must use this special 1.7.0 or higher version of bossac to program SAMD21 boards!  If you find an older version of BOSSA it won't work because it doesn't support the SAMD21 chip. To flash with bossac (BOSSA's command line tool) first download the latest version from here. The ming32 version is for Windows, apple-darwin for Mac OSX and various linux options for Linux.
bossac works with .bin files only, it will not work with .uf2 files!

Test bossac

Open a terminal and navigate to the folder with the bossac tool. Then check the tool runs by running it with the --help option:

circuitpython_micropython_Screen_Shot_2016-10-13_at_9.12.26_PM.png
Open a terminal and navigate to the folder with the bossac tool. Then check the tool runs by running it with the --help option with bossac --help
Or if you're using Linux or Mac OSX you'll need to add a ./ to specify that bossac is run from the current directory like ./bossac --help

Make sure you see BOSSA version 1.7.0 or higher!  If you see a lower version then you accidentally downloaded an older version of the tool and it won't work to flash SAMD21 chips.  Go back and grab the latest release from this BOSSA GitHub repository as mentioned above.

Get Into the Bootloader

You'll have to 'kick' the board into the bootloader manually. Do so by double-clicking the reset button. The red "#13" LED should pulse on and off. If you are using an Arduino Zero, make sure you are connected to the native USB port not the debugging/programming port.
One special note, if you're using the Arduino M0 from Arduino.org you'll need to replace its bootloader with the Arduino Zero bootloader so it can work with BOSSA.  To do this install the Arduino/Genuino Zero board in the Arduino IDE board manager and then follow these steps to burn the Arduino Zero bootloader (using the programming port on the board).  Once you've loaded the Arduino Zero bootloader you should be able to use the M0 with bossac as described below.

Run bossac command

With your board plugged in and running the bootloader you're ready to flash CircuitPython firmware onto the board. Copy the firmware .bin file to the same directory as the bossac tool, then in a terminal navigate to that location and run the following command:
bossac -e -w -v -R adafruit-circuitpython-feather_m0_express-2.1.0.bin
Replace the filename with the name of your downloaded .bin - it will vary based on your board!
This will erase the chip, write the given file, verify the write and Reset the board. On linux or Mac OS X you may need to run this command with sudo ./bossac ...
After BOSSA loads the firmware you should see output similar to the following:
After reset, CircuitPython should be running and the CIRCUITPY drive will appear. You can always manually reset the board by clicking the reset button, sometimes that is needed to get it to 'wake up'. Express boards may cause a warning of an early eject of a USB drive but just ignore it. Nothing important was being written to the drive!

Troubleshooting

From time to time, you will run into issues when working with CircuitPython. Here are a few things you may encounter and how to resolve them.

CPLAYBOOT, TRINKETBOOT, FEATHERBOOT, or GEMMABOOT Drive Not Present

You may have a different board.

Only Adafruit Express boards and the Trinket M0 and Gemma M0 boards ship with the UF2 bootloader installed. Feather M0 Basic, Feather M0 Adalogger, and similar boards use a regular Arduino-compatible bootloader, which does not show a boardnameBOOT drive.

MakeCode

If you are running a MakeCode program on Circuit Playground Express, press the reset button just once to get the CPLAYBOOT drive to show up. Pressing it twice will not work.

Windows 10

Did you install the Adafruit Windows Drivers package by mistake? You don't need to install this package on Windows 10 for most Adafruit boards. The old version (v1.5) can interfere with recognizing your device. Go to Settings -> Apps and uninstall all the "Adafruit" driver programs.

Windows 7

The latest version of the Adafruit Windows Drivers (version 2.0.0.0 or later) will fix the missing boardnameBOOT drive problem on Windows 7. To resolve this, first uninstall the old versions of the drivers:
  • Unplug any boards. In Uninstall or Change a Program (Control Panel->Programs->Uninstall a program), uninstall everything named "Windows Driver Package - Adafruit Industries LLC ...".
  • Now install the new 2.0.0.0 (or higher) Adafruit Windows Drivers Package:
  • When running the installer, you'll be shown a list of drivers to choose from. You can check and uncheck the boxes to choose which drivers to install.
You should now be done! Test by unplugging and replugging the board. You should see the CIRCUITPY drive, and when you double-click the reset button (single click on Circuit Playground Express running MakeCode), you should see the appropriate boardnameBOOT drive.
Let us know in the Adafruit support forums or on the Adafruit Discord if this does not work for you!

CircuitPython RGB Status Light

The Feather M0 Express, Metro M0 Express, Gemma M0, and Trinket M0 all have a single NeoPixel or DotStar RGB LED on the board that indicates the status of CircuitPython. Here's what the colors and blinking mean:
  • steady GREEN: code.py (or code.txt, main.py, or main.txt) is running
  • pulsing GREEN: code.py (etc.) has finished or does not exist
  • YELLOW: Circuit Python is in safe mode: it crashed and restarted
  • WHITE: REPL is running
  • BLUE: Circuit Python is starting up
Colors with multiple flashes following indicate a Python exception and then indicate the line number of the error. The color of the first flash indicates the type of error:
  • GREEN: IndentationError
  • CYAN: SyntaxError
  • WHITE: NameError
  • ORANGE: OSError
  • PURPLE: ValueError
  • YELLOW: other error
These are followed by flashes indicating the line number, including place value. WHITE flashes are thousands' place, BLUE are hundreds' place, YELLOW are tens' place, and CYAN are one's place. So for example, an error on line 32 would flash YELLOW three times and then CYAN two times. Zeroes are indicated by an extra-long dark gap.

CIRCUITPY Drive Issues

You may find that you can no longer save files to your CIRCUITPY drive. You may find that your CIRCUITPY stops showing up in your file explorer, or shows up as NO_NAME. These are indicators that your filesystem has issues.
First check - have you used Arduino to program your board? If so, CircuitPython is no longer able to provide the USB services. Reset the board so you get a boardnameBOOT drive rather than a CIRCUITPY drive, copy the latest version of CircuitPython (.uf2) back to the board, then Reset. This may restore CIRCUITPY functionality.
If still broken - When the CIRCUITPY disk is not safely ejected before being reset by the button or being disconnected from USB, it may corrupt the flash drive. It can happen on Windows, Mac or Linux.
In this situation, the board must be completely erased and CircuitPython must be reloaded onto the board.
You WILL lose everything on the board when you complete the following steps. If possible, make a copy of your code before continuing.

Easiest Way: Use storage.erase_filesystem()

Starting with version 2.3.0, CircuitPython includes a built-in function to erase and reformat the filesystem. If you have an older version of CircuitPython on your board, you can update to the newest version to do this.
  1. Connect to the CircuitPython REPL using Mu or a terminal program.
  2. Type:
  1. >>> import storage
  2. >>> storage.erase_filesystem()
CIRCUITPY will be erased and reformatted, and your board will restart. That's it!

Old Way: For the Circuit Playground Express, Feather M0 Express, and Metro M0 Express:

If you are running a version of CircuitPython before 2.3.0, and you don't want to upgrade, or you can't get to the REPL, you can do this.
       1.  Download the correct erase file:
       2.  Double-click the reset button on the board to bring up the boardnameBOOT drive.
       3.  Drag the erase .uf2 file to the boardnameBOOT drive.
       4.  The onboard NeoPixel will turn blue, indicating the erase has started.
       5.  After approximately 15 seconds, the NeoPixel will start flashing green.
       6.  Double-click the reset button on the board to bring up the boardnameBOOT drive.
       7.  Drag the appropriate latest release of CircuitPython .uf2 file to the boardnameBOOT drive.
It should reboot automatically and you should see CIRCUITPY in your file explorer again.
If the LED flashes red during step 5, it means the erase has failed. Repeat the steps starting with 2.
If you haven't already downloaded the latest release of CircuitPython for your board, check out the installation page. You'll also need to install your libraries and code!

Old Way: For Non-Express Boards with a UF2 bootloader (Gemma M0, Trinket M0):

If you are running a version of CircuitPython before 2.3.0, and you don't want to upgrade, or you can't get to the REPL, you can do this.
       1.  Download the erase file:
       2.  Double-click the reset button on the board to bring up the boardnameBOOT drive.
       3.  Drag the erase .uf2 file to the boardnameBOOT drive.
       4.  The boot LED will start flashing again, and the boardnameBOOT drive will reappear.
       5.  Drag the appropriate latest release CircuitPython .uf2 file to the boardnameBOOT drive.
It should reboot automatically and you should see CIRCUITPY in your file explorer again.
If you haven't already downloaded the latest release of CircuitPython for your board, check out the installation page You'll also need to install your libraries and code!

Old Way: For non-Express Boards without a UF2 bootloader (Feather M0 Basic Proto, Feather Adalogger, Arduino Zero):

If you are running a version of CircuitPython before 2.3.0, and you don't want to upgrade, or you can't get to the REPL, you can do this.
Just follow these directions to reload CircuitPython using bossac, which will erase and re-create CIRCUITPY.

Running Out of File Space on Non-Express Boards

The file system on the board is very tiny. (Smaller than an ancient floppy disk.) So, its likely you'll run out of space but don't panic! There are a couple ways to free up space.
The board ships with the Windows 7 serial driver too! Feel free to delete that if you don't need it or have already installed it. Its ~12KiB or so.

Delete something!

The simplest way of freeing up space is to delete files from the drive. Perhaps there are libraries in the lib folder that you aren't using anymore or test code that isn't in use.

Use tabs

One unique feature of Python is that the indentation of code matters. Usually the recommendation is to indent code with four spaces for every indent. In general, we recommend that too. However, one trick to storing more human-readable code is to use a single tab character for indentation. This approach uses 1/4 of the space for indentation and can be significant when we're counting bytes.

Mac OSX loves to add extra files.

Luckily you can disable some of the extra hidden files that Mac OSX adds by running a few commands to disable search indexing and create zero byte placeholders. Follow the steps below to maximize the amount of space available on OSX:

Prevent & Remove Mac OSX Hidden Files

First find the volume name for your board.  With the board plugged in run this command in a terminal to list all the volumes:
  1. ls -l /Volumes
Look for a volume with a name like CIRCUITPY (the default for CircuitPython).  The full path to the volume is the /Volumes/CIRCUITPY path.
Now follow the steps from this question to run these terminal commands that stop hidden files from being created on the board:
  1. mdutil -i off /Volumes/CIRCUITPY
  2. cd /Volumes/CIRCUITPY
  3. rm -rf .{,_.}{fseventsd,Spotlight-V*,Trashes}
  4. mkdir .fseventsd
  5. touch .fseventsd/no_log .metadata_never_index .Trashes
  6. cd -
Replace /Volumes/CIRCUITPY in the commands above with the full path to your board's volume if it's different.  At this point all the hidden files should be cleared from the board and some hidden files will be prevented from being created.
However there are still some cases where hidden files will be created by Mac OSX.  In particular if you copy a file that was downloaded from the internet it will have special metadata that Mac OSX stores as a hidden file.  Luckily you can run a copy command from the terminal to copy files without this hidden metadata file.  See the steps below.

Copy Files on Mac OSX Without Creating Hidden Files

Once you've disabled and removed hidden files with the above commands on Mac OSX you need to be careful to copy files to the board with a special command that prevents future hidden files from being created.  Unfortunately you cannot use drag and drop copy in Finder because it will still create these hidden extended attribute files in some cases (for files downloaded from the internet, like Adafruit's modules).
To copy a file or folder use the -X option for the cp command in a terminal.  For example to copy a foo.mpy file to the board use a command like:
  1. cp -X foo.mpy /Volumes/CIRCUITPY
Or to copy a folder and all of its child files/folders use a command like:
  1. cp -rX folder_to_copy /Volumes/CIRCUITPY

Other Mac OSX Space-Saving Tips

If you'd like to see the amount of space used on the drive and manually delete hidden files here's how to do so.  First list the amount of space used on the CIRCUITPY drive with the df command:
Lets remove the ._ files first.
Whoa! We have 13Ki more than before! This space can now be used for libraries and code!

CircuitPython Essentials

You've gone through the Welcome to CircuitPython guide. You've already gotten everything setup, and you've gotten CircuitPython running. Great! Now what? CircuitPython Essentials!
There are a number of core modules built into CircuitPython and commonly used libraries available. The Essentials guide will introduce you to these and show you an example of how to use each one.
It's time to get started learning the CircuitPython Essentials!





CircuitPython Essentials


You've gone through the Welcome to CircuitPython guide. You've already gotten everything setup, and you've gotten CircuitPython running. Great! Now what? CircuitPython Essentials!
There are a number of core modules built into CircuitPython and commonly used libraries available. This guide will introduce you to these and show you an example of how to use each one.
Each section will present you with a piece of code designed to work with different boards, and explain how to use the code with each board. These examples work with any board designed for CircuitPython, including Circuit Playground Express, Trinket M0, Gemma M0, ItsyBitsy M0 Express, Feather M0 Express and Metro M0 Express.
Some examples require external components, such as switches or sensors. You'll find wiring diagrams where applicable to show you how to wire up the necessary components to work with each example.
Let's get started learning the CircuitPython Essentials!

CircuitPython Built-Ins

CircuitPython comes 'with the kitchen sink' - a lot of the things you know and love about classic Python 3 (sometimes called CPython) already work. There are a few things that don't but we'll try to keep this list updated as we add more capabilities!
This is not an exhaustive list! It's simply some of the many features you can use.

Thing That Are Built In and Work

Flow Control

All the usual if, elif, else, for, while work just as expected.

Math

import math will give you a range of handy mathematical functions.
>>> dir(math)
['__name__', 'e', 'pi', 'sqrt', 'pow', 'exp', 'log', 'cos', 'sin', 'tan', 'acos', 'asin', 'atan', 'atan2', 'ceil', 'copysign', 'fabs', 'floor', 'fmod', 'frexp', 'ldexp', 'modf', 'isfinite', 'isinf', 'isnan', 'trunc', 'radians', 'degrees']
CircuitPython supports 30-bit wide floating point values so you can use int and float whenever you expect.

Tuples, Lists, Arrays, and Dictionaries

You can organize data in ()[], and {} including strings, objects, floats, etc.

Classes, Objects and Functions

We use objects and functions extensively in our libraries so check out one of our many examples like this MCP9808 library for class examples.

Lambdas

Yep! You can create function-functions with lambda just the way you like em:
>>> g = lambda x: x**2
>>> g(8)
64

Random Numbers

To obtain random numbers:
import random
random.random() will give a floating point number from 0 to 1.0.
random.randint(min, max) will give you an integer number between min and max.

CircuitPython Digital In & Out

The first part of interfacing with hardware is being able to manage digital inputs and outputs. With CircuitPython, it's super easy!
This example shows how to use both a digital input and output. You can use a switch input with pullup resistor (built in) to control a digital output - the built in red LED.
Copy and paste the code into code.py using your favorite editor, and save the file to run the demo.
  1. # CircuitPython IO demo #1 - General Purpose I/O
  2. import time
  3. import board
  4. from digitalio import DigitalInOut, Direction, Pull
  5.  
  6. led = DigitalInOut(board.D13)
  7. led.direction = Direction.OUTPUT
  8.  
  9. # For Gemma M0, Trinket M0, Metro M0 Express, ItsyBitsy M0 Express, Itsy M4 Express
  10. switch = DigitalInOut(board.D2)
  11. # switch = DigitalInOut(board.D5) # For Feather M0 Express, Feather M4 Express
  12. # switch = DigitalInOut(board.D7) # For Circuit Playground Express
  13. switch.direction = Direction.INPUT
  14. switch.pull = Pull.UP
  15.  
  16. while True:
  17. # We could also do "led.value = not switch.value"!
  18. if switch.value:
  19. led.value = False
  20. else:
  21. led.value = True
  22.  
  23. time.sleep(0.01) # debounce delay
Note that we made the code a little less "Pythonic" than necessary. The if/else block could be replaced with a simple led.value = not switch.value but we wanted to make it super clear how to test the inputs. The interpreter will read the digital input when it evaluates switch.value.
For Gemma M0, Trinket M0, Metro M0 Express, Metro M4 Express, ItsyBitsy M0 Express, ItsyBitsy M4 Express, no changes to the initial example are needed.
Note: To "comment out" a line, put a # and a space before it. To "uncomment" a line, remove the # + space from the beginning of the line.
For Feather M0 Express and Feather M4 Express, comment out switch = DigitalInOut(board.D2) (and/or switch = DigitalInOut(board.D7) depending on what changes you already made), and uncomment switch = DigitalInOut(board.D5).
For Circuit Playground Express, you'll need to comment out switch = DigitalInOut(board.D2) (and/or switch = DigitalInOut(board.D5) depending on what changes you already made), and uncomment switch = DigitalInOut(board.D7).
To find the pin or pad suggested in the code, see the list below. For the boards that require wiring, wire up a switch (also known as a tactile switch, button or push-button), following the diagram for guidance. Press or slide the switch, and the onboard red LED will turn on and off.
Note that on the M0/SAMD based CircuitPython boards, at least, you can also have internal pulldowns with Pull.DOWN and if you want to turn off the pullup/pulldown just assign switch.pull = None.

Find the pins!

The list below shows each board, explains the location of the Digital pin suggested for use as input, and the location of the D13 LED.

circuitpython_CircuitPlaygroundExpress_bb.jpg
Circuit Playground Express

We're going to use the switch, which is pin D7, and is located between the battery connector and the reset switch on the board. D13 is labeled D13 and is located next to the USB micro port.

To use D7, comment out the current pin setup line, and uncomment the line labeled for Circuit Playground Express. See the details above!

circuitpython_TrinketM0Button_bb.jpg
Trinket M0

D2 is connected to the blue wire, labeled "2", and located between "3V" and "1" on the board. D13 is labeled "13" and is located next to the USB micro port.

circuitpython_GemmaM0Button_bb.jpg
Gemma M0

D2 is an alligator-clip-friendly pad labeled both "D2" and "A1", shown connected to the blue wire, and is next to the USB micro port. D13 is located next to the "GND" label on the board, above the "On/Off" switch.

Use alligator clips to connect your switch to your Gemma M0!

circuitpython_FeatherM0ExpressButton_bb.jpg
Feather M0 Express and Feather M4 Express

D5 is labeled "5" and connected to the blue wire on the board. D13 is labeled "#13" and is located next to the USB micro port.

To use D5, comment out the current pin setup line, and uncomment the line labeled for Feather M0 Express. See the details above!

circuitpython_ItsyBitsyM0ExpressButton_bb.jpg
ItsyBitsy M0 Express and ItsyBitsy M4 Express

D2 is labeled "2", located between the "MISO" and "EN" labels, and is connected to the blue wire on the board. D13 is located next to the reset button between the "3" and "4" labels on the board.

circuitpython_MetroM0ExpressButton_bb.jpg
Metro M0 Express and Metro M4 Express

D2 is located near the top left corner, and is connected to the blue wire. D13 is labeled "L" and is located next to the USB micro port.

CircuitPython Analog In

This example shows you how you can read the analog voltage on the A1 pin on your board.
Copy and paste the code into code.py using your favorite editor, and save the file to run the demo.
  1. # CircuitPython AnalogIn Demo
  2. import time
  3. import board
  4. from analogio import AnalogIn
  5.  
  6. analog_in = AnalogIn(board.A1)
  7.  
  8.  
  9. def get_voltage(pin):
  10. return (pin.value * 3.3) / 65536
  11.  
  12.  
  13. while True:
  14. print((get_voltage(analog_in),))
  15. time.sleep(0.1)

Creating the analog input

analog1in = AnalogIn(board.A1)
Creates an object and connects the object to A1 as an analog input.

get_voltage Helper

getVoltage(pin) is our little helper program. By default, analog readings will range from 0 (minimum) to 65535 (maximum). This helper will convert the 0-65535 reading from pin.value and convert it a 0-3.3V voltage reading.

Main Loop

The main loop is simple. It prints out the voltage as floating point values by calling get_voltage on our analog object. Connect to the serial console to see the results.

Changing It Up

By default the pins are floating so the voltages will vary. While connected to the serial console, try touching a wire from A1 to the GND pin or 3Vo pin to see the voltage change.
You can also add a potentiometer to control the voltage changes. From the potentiometer to the board, connect the left pin to ground, the middle pin to A1, and the right pin to 3V. If you're using Mu editor, you can see the changes as you rotate the potentiometer on the plotter like in the image above! (Click the Plotter icon at the top of the window to open the plotter.)
When you turn the knob of the potentiometer, the wiper rotates left and right, increasing or decreasing the resistance. This, in turn, changes the analog voltage level that will be read by your board on A1.

Wire it up

The list below shows wiring diagrams to help find the correct pins and wire up the potentiometer, and provides more information about analog pins on your board!

circuitpython_CPXPot_bb.jpg
Circuit Playground Express

A1 is located on the right side of the board. There are multiple ground and 3V pads (pins).

Your board has 7 analog pins that can be used for this purpose. For the full list, see the pinout page on the main guide.

circuitpython_TrinketM0Pot_bb.jpg
Trinket M0

A1 is labeled as 2! It's located between "1~" and "3V" on the same side of the board as the little red LED. Ground is located on the opposite side of the board. 3V is located next to 2, on the same end of the board as the reset button.

You have 5 analog pins you can use. For the full list, see the pinouts page on the main guide.

circuitpython_GemmaM0Pot_bb.jpg
Gemma M0

A1 is located near the top of the board of the board to the left side of the USB Micro port. Ground is on the other side of the USB port from A1. 3V is located to the left side of the battery connector on the bottom of the board.

Your board has 3 analog pins. For the full list, see the pinout page on the main guide.

circuitpython_FeatherM0ExpressPot_bb.jpg
Feather M0 Express and Feather M4 Express

A1 is located along the edge opposite the battery connector. There are multiple ground pins. 3V is located along the same edge as A1, and is next to the reset button.

Your board has 6 analog pins you can use. For the full list, see the pinouts page on the main guide.

circuitpython_ItsyBitsyM0ExpressPot_bb.jpg
ItsyBitsy M0 Express and ItsyBitsy M4 Express

A1 is located in the middle of the board, near the "A" in "Adafruit". Ground is labled "G" and is located next to "BAT", near the USB Micro port. 3V is found on the opposite side of the USB port from Ground, next to RST.

You have 6 analog pins you can use. For a full list, see the pinouts page on the main guide.

circuitpython_MetroM0ExpressPot_bb.jpg
Metro M0 Express and Metro M4 Express

A1 is located on the same side of the board as the barrel jack. There are multiple ground pins available. 3V is labeled "3.3" and is located in the center of the board on the same side as the barrel jack (and as A1).

Your Metro M0 Express board has 6 analog pins you can use. For the full list, see the pinouts page on the main guide.

Your Metro M4 Express board has 6 analog pins you can use. For the full list, see the pinouts page on the main guide.

CircuitPython Analog Out

This example shows you how you can set the DAC (true analog output) on pin A0.
A0 is the only true analog output on the M0 boards. No other pins do true analog output!
Copy and paste the code into code.py using your favorite editor, and save the file.
  1. # CircuitPython IO demo - analog output
  2. import board
  3. from analogio import AnalogOut
  4.  
  5. analog_out = AnalogOut(board.A0)
  6.  
  7. while True:
  8. # Count up from 0 to 65535, with 64 increment
  9. # which ends up corresponding to the DAC's 10-bit range
  10. for i in range(0, 65535, 64):
  11. analog_out.value = i

Creating an analog output

analog_out = AnalogOut(A0)
Creates an object analog_out and connects the object to A0, the only DAC pin available on both the M0 and the M4 boards. (The M4 has two, A0 and A1.)

Setting the analog output

The DAC on the SAMD21 is a 10-bit output, from 0-3.3V. So in theory you will have a resolution of 0.0032 Volts per bit. To allow CircuitPython to be general-purpose enough that it can be used with chips with anything from 8 to 16-bit DACs, the DAC takes a 16-bit value and divides it down internally.
For example, writing 0 will be the same as setting it to 0 - 0 Volts out.
Writing 5000 is the same as setting it to 5000 / 64 = 78, and 78 / 1024 * 3.3V = 0.25V output.
Writing 65535 is the same as 1023 which is the top range and you'll get 3.3V output

Main Loop

The main loop is fairly simple, it goes through the entire range of the DAC, from 0 to 65535, but increments 64 at a time so it ends up clicking up one bit for each of the 10-bits of range available.
CircuitPython is not terribly fast, so at the fastest update loop you'll get 4 Hz. The DAC isn't good for audio outputs as-is.
Express boards like the Circuit Playground Express, Metro M0 Express, ItsyBitsy M0 Express, ItsyBitsy M4 Express, Metro M4 Express, Feather M4 Express, or Feather M0 Express have more code space and can perform audio playback capabilities via the DAC. Gemma M0 and Trinket M0 cannot!
Check out the Audio Out section of this guide for examples!

Find the pin

Use the diagrams below to find the A0 pin marked with a magenta arrow!

circuitpython_CPXBoardAnalogOut.png
Circuit Playground Express

A0 is located between VOUT and A1 near the battery port.

circuitpython_TrinketA0AnalogOut.png
Trinket M0

A0 is labeled "1~" on Trinket! A0 is located between "0" and "2" towards the middle of the board on the same side as the red LED.

circuitpython_GemmaM0BoardAnalogOut.png
Gemma M0

A0 is located in the middle of the right side of the board next to the On/Off switch.

circuitpython_FeatherM0ExpressBoardAnalogOut.png
Feather M0 Express

A0 is located between GND and A1 on the opposite side of the board from the battery connector, towards the end with the Reset button.

circuitpython_FeatherM4A0.png
Feather M4 Express

A0 is located between GND and A1 on the opposite side of the board from the battery connector, towards the end with the Reset button, and the pin pad has left and right white parenthesis markings around it

circuitpython_ItsyBitsyM0ExpressBoardAnalogOut.png
ItsyBitsy M0 Express

A0 is located between VHI and A1, near the "A" in "Adafruit", and the pin pad has left and right white parenthesis markings around it.

circuitpython_ItsyBitsyM4A0.png
ItsyBitsy M4 Express

A0 is located between VHI and A1, and the pin pad has left and right white parenthesis markings around it.

circuitpython_MetroM0ExpressBoardAnalogOut.png
Metro M0 Express

A0 is between VIN and A1, and is located along the same side of the board as the barrel jack adapter towards the middle of the headers found on that side of the board.

circuitpython_MetroM4Board.jpg
Metro M4 Express

A0 is between VIN and A1, and is located along the same side of the board as the barrel jack adapter towards the middle of the headers found on that side of the board.

On the Metro M4 Express, there are TWO true analog outputs: A0 and A1.

CircuitPython Audio Out

CircuitPython 3.0 and higher comes with an updated audioio, which provides built-in audio output support. You can play generated tones. You can also play, pause and resume wave files. You can have 3V-peak-to-peak analog output or I2S digital output. In this page we will show using analog output.
This is great for all kinds of projects that require sound, like a tone piano or anything where you'd like to add audio effects!
ESP8266, Trinket M0 and Gemma M0 do not support audioio! You must use an M0 Express or M4 Express board for this.
The first example will show you how to generate a tone and play it using a button. The second example will show you how to play, pause, and resume a wave file using a button to resume. Both will play the audio through an audio jack. The default volume on both of these examples is painfully high through headphones. So, we've added a potentiometer and included some code in the tone generation example to control volume.
In our code, we'll use pin A0 for our audio output, as this is the only DAC pin available on every Express board. The M0 Express boards have audio output on A0. The M4 Express boards have two audio output pins, A0 and A1, however we'll be using only A0 in this guide.

Play a Tone

Copy and paste the following code into code.py using your favorite editor, and save the file.
  1. import time
  2. import array
  3. import math
  4. import audioio
  5. import board
  6. import digitalio
  7.  
  8. button = digitalio.DigitalInOut(board.A1)
  9. button.switch_to_input(pull=digitalio.Pull.UP)
  10.  
  11. tone_volume = 0.1 # Increase this to increase the volume of the tone.
  12. frequency = 440 # Set this to the Hz of the tone you want to generate.
  13. length = 8000 // frequency
  14. sine_wave = array.array("H", [0] * length)
  15. for i in range(length):
  16. sine_wave[i] = int((1 + math.sin(math.pi * 2 * i / 18)) * tone_volume * (2 ** 15))
  17.  
  18. audio = audioio.AudioOut(board.A0)
  19. sine_wave_sample = audioio.RawSample(sine_wave)
  20.  
  21. while True:
  22. if not button.value:
  23. audio.play(sine_wave_sample, loop=True)
  24. time.sleep(1)
  25. audio.stop()
First we create the button object, assign it to pin A1, and set it as an input with a pull-up. Even though the button switch involves digitalio, we're using an A-pin so that the same setup code will work across all the boards.
Since the default volume was incredibly high, we included a tone_volume variable in the sine wave code. You can use the code to control the volume by increasing or decreasing this number to increase or decrease the volume. You can also control volume with the potentiometer by rotating the knob.
To set the frequency of the generated tone, change the number assigned to the frequency variable to the Hz of the tone you'd like to generate.
Then, we generate one period of a sine wave with the math.sin function, and assign it to sine_wave.
Next, we create the audio object, and assign it to pin A0.
We create a sample of the sine wave by using RawSample and providing the sine_wave we created.
Inside our loop, we check to see if the button is pressed. The button has two states True and False. The button.value defaults to the True state when not pressed. So, to check if it has been pressed, we're looking for the False state. So, we check to see if not button.value which is the equivalent of not True, or False.
Once the button is pressed, we play the sample we created and we loop it. The time.sleep(1) tells it to loop (play) for 1 second. Then we stop it after 1 second is up. You can increase or decrease the length of time it plays by increasing or decreasing the number of seconds provided to time.sleep(). Try changing it from 1 to 0.5. Now try changing it to 2. You can change it to whatever works for you!
That's it!

Play a Wave File

You can use any supported wave file you like. CircuitPython supports mono or stereo, at 22 KHz sample rate (or less) and 16-bit WAV format. The M0 boards support ONLY MONO. The reason for mono is that there's only one analog output on those boards! The M4 boards support stereo as they have two outputs. The 22 KHz or less because the circuitpython can't handle more data than that (and also it will not sound much better) and the DAC output is 10-bit so anything over 16-bit will just take up room without better quality.
Since the WAV file must fit on the CircuitPython file system, it must be under 2 MB.
CircuitPython does not support OGG or MP3. Just WAV!
We have a detailed guide on how to generate WAV files here.
We've included the one we used here. Download it and copy it to your board.
We're going to play the wave file for 6 seconds, pause it, wait for a button to be pressed, and then resume the file to play through to the end. Then it loops back to the beginning and starts again! Let's take a look.
Copy and paste the following code into code.py using your favorite editor, and save the file.
  1. import time
  2. import audioio
  3. import board
  4. import digitalio
  5.  
  6. button = digitalio.DigitalInOut(board.A1)
  7. button.switch_to_input(pull=digitalio.Pull.UP)
  8.  
  9. wave_file = open("StreetChicken.wav", "rb")
  10. wave = audioio.WaveFile(wave_file)
  11. audio = audioio.AudioOut(board.A0)
  12.  
  13. while True:
  14. audio.play(wave)
  15.  
  16. # This allows you to do other things while the audio plays!
  17. t = time.monotonic()
  18. while time.monotonic() - t < 6:
  19. pass
  20.  
  21. audio.pause()
  22. print("Waiting for button press to continue!")
  23. while button.value:
  24. pass
  25. audio.resume()
  26. while audio.playing:
  27. pass
  28. print("Done!")
First we create the button object, assign it to pin A1, and set it as an input with a pull-up.
Next we then open the file, "StreetChicken.wav" as a readable binary and store the file object in wave_file which is what we use to actually read audio from: wave_file = open("StreetChicken.wav", "rb").
Now we will ask the audio playback system to load the wave data from the file wave = audioio.WaveFile(wave_file) and finally request that the audio is played through the A0 analog output pin audio = audioio.AudioOut(board.A0).
The audio file is now ready to go, and can be played at any time with audio.play(wave)!
Inside our loop, we start by playing the file.
Next we have the block that tells the code to wait 6 seconds before pausing the file. We chose to go with using time.monotonic() because it's non-blocking which means you can do other things while the file is playing, like control servos or NeoPixels! At any given point in time, time.monotonic() is equal to the number seconds since your board was last power-cycled. (The soft-reboot that occurs with the auto-reload when you save changes to your CircuitPython code, or enter and exit the REPL, does not start it over.) When it is called, it returns a number with a decimal. When you assign time.monotonic() to a variable, that variable is equal to the number of seconds that time.monotonic() was equal to at the moment the variable was assigned. You can then call it again and subtract the variable from time.monotonic() to get the amount of time that has passed. For more details, check out this example.
So, we assign t = time.monotonic() to get a starting point. Then we say pass, or "do nothing" until the difference between t and time.monotonic() is greater than 6seconds. In other words, continue playing until 6 seconds passes. Remember, you can add in other code here to do other things while you're playing audio for 6 seconds.
Then we pause the audio and print to the serial console, "Waiting for button press to continue!"
Now we're going to wait for a button press in the same way we did for playing the generated tone. We're saying while button.value, or while the button is returning True, pass. Once the button is pressed, it returns False, and this tells the code to continue.
Once the button is pressed, we resume playing the file. We tell it to finish playing saying while audio.playing: pass.
Finally, we print to the serial console, "Done!"
You can do this with any supported wave file, and you can include all kinds of things in your project while the file is playing. Give it a try!

Wire It Up

Along with your microcontroller board, we're going to be using:
Button switches with four pins are really two pairs of pins. When wiring up a button switch with four pins, the easiest way to verify that you're wiring up the correct pins is to wire up opposite corners of the button switch. Then there's no chance that you'll accidentally wire up the same pin twice.
Here are the steps you're going to follow to wire up these components:
  • Connect the ground pin on your board to a ground rail on the breadboard because you'll be connecting all three components to ground. 
  • Connect one pin on the button switch to pin A1 on your board, and the opposite pin on the button switch to the ground rail on the breadboard.
  • Connect the left and right pin on the audio jack to each other.
  • Connect the center pin on the audio jack to the ground rail on the breadboard.
  • Connect the left pin to the negative side of a 100mF capacitor.
  • Connect the positive side of the capacitor to the center pin on the potentiometer.
  • Connect the right pin on the potentiometer to pin A0 on your board.
  • Connect the left pin of the potentiometer to the ground rail on the breadboard.
The list below shows wiring diagrams to help with finding the correct pins and wiring up the different components. The ground wires are black. The wire for the button switch is yellow. The wires involved with audio are blue.

circuitpython_ItsyBitsyM0AudioJackButtonPot_bb.jpg
Wiring is the same for the M4 versions of the boards as it is for the M0 versions. Follow the same image for both.


Use a breadboard to make your wiring neat and tidy!

circuitpython_CPXAudioJackButtonPot_bb.jpg
Circuit Playground Express is wired electrically the same as the ItsyBitsy/Feather/Metro above but we use alligator clip to jumper wires instead of plain jumpers

CircuitPython PWM

Your board has pulseio support, which means you can PWM LEDs, control servos, beep piezos, and manage "pulse train" type devices like DHT22 and Infrared.
Nearly every pin has PWM support! For example, all ATSAMD21 board have an A0 pin which is 'true' analog out and does not have PWM support.

PWM with Fixed Frequency

This example will show you how to use PWM to fade the little red LED on your board.
Copy and paste the code into code.py using your favorite editor, and save the file.
  1. import time
  2. import board
  3. import pulseio
  4.  
  5. led = pulseio.PWMOut(board.D13, frequency=5000, duty_cycle=0)
  6.  
  7. while True:
  8. for i in range(100):
  9. # PWM LED up and down
  10. if i < 50:
  11. led.duty_cycle = int(i * 2 * 65535 / 100) # Up
  12. else:
  13. led.duty_cycle = 65535 - int((i - 50) * 2 * 65535 / 100) # Down
  14. time.sleep(0.01)

Create a PWM Output

led = pulseio.PWMOut(board.D13, frequency=5000, duty_cycle=0)
Since we're using the onboard LED, we'll call the object led, use pulseio.PWMOut to create the output and pass in the D13 LED pin to use.

Main Loop

The main loop uses range() to cycle through the loop. When the range is below 50, it PWMs the LED brightness up, and when the range is above 50, it PWMs the brightness down. This is how it fades the LED brighter and dimmer!
The time.sleep() is needed to allow the PWM process to occur over a period of time. Otherwise it happens too quickly for you to see!

PWM Output with Variable Frequency

Fixed frequency outputs are great for pulsing LEDs or controlling servos. But if you want to make some beeps with a piezo, you'll need to vary the frequency.
The following example uses pulseio to make a series of tones on a piezo.
To use with any of the M0 boards, no changes to the following code are needed.
To use with the Metro M4 Express, ItsyBitsy M4 Express or the Feather M4 Express, you must comment out the piezo = pulseio.PWMOut(board.A2, duty_cycle=0, frequency=440, variable_frequency=True) line and uncomment the piezo = pulseio.PWMOut(board.A1, duty_cycle=0, frequency=440, variable_frequency=True) line. A2 is not a supported PWM pin on the M4 boards!
Remember: To "comment out" a line, put a # and a space before it. To "uncomment" a line, remove the # + space from the beginning of the line.
  1. import time
  2. import board
  3. import pulseio
  4.  
  5. # For the M0 boards:
  6. piezo = pulseio.PWMOut(board.A2, duty_cycle=0, frequency=440, variable_frequency=True)
  7.  
  8. # For the M4 boards:
  9. # piezo = pulseio.PWMOut(board.A1, duty_cycle=0, frequency=440, variable_frequency=True)
  10.  
  11. while True:
  12. for f in (262, 294, 330, 349, 392, 440, 494, 523):
  13. piezo.frequency = f
  14. piezo.duty_cycle = 65536 // 2 # On 50%
  15. time.sleep(0.25) # On for 1/4 second
  16. piezo.duty_cycle = 0 # Off
  17. time.sleep(0.05) # Pause between notes
  18. time.sleep(0.5)
If you have simpleio library loaded into your /lib folder on your board, we have a nice little helper that makes a tone for you on a piezo with a single command.
To use with any of the M0 boards, no changes to the following code are needed.
To use with the Metro M4 Express, ItsyBitsy M4 Express or the Feather M4 Express, you must comment out the simpleio.tone(board.A1, f, 0.25) line and uncomment the simpleio.tone(board.A2, f, 0.25) line. A2 is not a supported PWM pin on the M4 boards!
  1. import time
  2. import board
  3. import simpleio
  4.  
  5. while True:
  6. for f in (262, 294, 330, 349, 392, 440, 494, 523):
  7. # For the M0 boards:
  8. simpleio.tone(board.A2, f, 0.25) # on for 1/4 second
  9. # For the M4 boards:
  10. # simpleio.tone(board.A1, f, 0.25) # on for 1/4 second
  11. time.sleep(0.05) # pause between notes
  12. time.sleep(0.5)
As you can see, it's much simpler!

Wire it up

Use the diagrams below to help you wire up your piezo. Attach one leg of the piezo to pin A2 on the M0 boards or A1 on the M4 boards, and the other leg to ground. It doesn't matter which leg is connected to which pin. They're interchangeable!

circuitpython_CPXPiezo_bb.jpg
Circuit Playground Express

Use alligator clips to attach A2 and any one of the GND to different legs of the piezo.

CPX has PWM on the following pins: A1, A2, A3, A6, RX, LIGHT, A8, TEMPERATURE, A9, BUTTON_B, D5, SLIDE_SWITCH, D7, D13, REMOTEIN, IR_RX, REMOTEOUT, IR_TX, IR_PROXIMITY, MICROPHONE_CLOCK, MICROPHONE_DATA, ACCELEROMETER_INTERRUPT, ACCELEROMETER_SDA, ACCELEROMETER_SCL, SPEAKER_ENABLE.

There is NO PWM on: A0, SPEAKER, A4, SCL, A5, SDA, A7, TX, BUTTON_A, D4, NEOPIXEL, D8, SCK, MOSI, MISO, FLASH_CS.

Trinket M0

Note: A2 on Trinket is also labeled Digital "0"!

Use jumper wires to connect GND and D0 to different legs of the piezo.

Trinket has PWM available on the following pins: D0, A2, SDA, D2, A1, SCL, MISO, D4, A4, TX, MOSI, D3, A3, RX, SCK, D13, APA102_MOSI, APA102_SCK.

There is NO PWM on: A0, D1.

circuitpython_GemmaM0Piezo_bb.jpg
Gemma M0

Use alligator clips to attach A2 and GND to different legs on the piezo.

Gemma has PWM available on the following pins: A1, D2, RX, SCL, A2, D0, TX, SDA, L, D13, APA102_MOSI, APA102_SCK.

There is NO PWM on: A0, D1.

circuitpython_FeatherM0ExpressPiezo_bb.jpg
Feather M0 Express

Use jumper wires to attach A2 and one of the two GND to different legs of the piezo.

Feather M0 Express has PWM on the following pins: A2, A3, A4, SCK, MOSI, MISO, D0, RX, D1, TX, SDA, SCL, D5, D6, D9, D10, D11, D12, D13, NEOPIXEL.

There is NO PWM on: A0, A1, A5.

circuitpython_FeatherM4ExpressPiezo_bb.jpg
Feather M4 Express

Use jumper wires to attach A1 and one of the two GND to different legs of the piezo.

To use A1, comment out the current pin setup line, and uncomment the line labeled for the M4 boards. See the details above!

Feather M4 Express has PWM on the following pins: A1, A3, SCK, D0, RX, D1, TX, SDA, SCL, D4, D5, D6, D9, D10, D11, D12, D13.

There is NO PWM on: A0, A2, A4, A5, MOSI, MISO.

circuitpython_ItsyBitsyM0Piezo_bb.jpg
ItsyBitsy M0 Express

Use jumper wires to attach A2 and G to different legs of the piezo.

ItsyBitsy M0 Express has PWM on the following pins: D0, RX, D1, TX, D2, D3, D4, D5, D6, D7, D8, D9, D10, D11, D12, D13, L, A2, A3, A4, MOSI, MISO, SCK, SCL, SDA, APA102_MOSI, APA102_SCK.

There is NO PWM on: A0, A1, A5.

circuitpython_ItsyBitsyM4Piezo_bb.jpg
ItsyBitsy M4 Express

Use jumper wires to attach A1 and G to different legs of the piezo.

To use A1, comment out the current pin setup line, and uncomment the line labeled for the M4 boards. See the details above!

ItsyBitsy M0 Express has PWM on the following pins: A1, D0, RX, D1, TX, D2, D4, D5, D7, D9, D10, D11, D12, D13, SDA, SCL.
There is NO PWM on: A2, A3, A4, A5, D3, SCK, MOSI, MISO.

circuitpython_MetroM0ExpressPiezo_bb.jpg
Metro M0 Express

Use jumper wires to connect A2 and any one of the GND to different legs on the piezo.

Metro M0 Express has PWM on the following pins: A2, A3, A4, D0, RX, D1, TX, D2, D3, D4, D5, D6, D7, D8, D9, D10, D11, D12, D13, SDA, SCL, NEOPIXEL, SCK, MOSI, MISO.

There is NO PWM on: A0, A1, A5, FLASH_CS.

circuitpython_MetroM4ExpressPiezo.jpg
Metro M4 Express

Use jumper wires to connect A1 and any one of the GND to different legs on the piezo.

To use A1, comment out the current pin setup line, and uncomment the line labeled for the M4 boards. See the details above!

Metro M4 Express has PWM on: A1, A5, D0, RX, D1, TX, D2, D3, D4, D5, D6, D7, D8, D9, D10, D11, D12, D13, SDA, SCK, MOSI, MISO

There is No PWM on: A0, A2, A3, A4, SCL, AREF, NEOPIXEL, LED_RX, LED_TX.

Where's My PWM?

Want to check to see which pins have PWM yourself? We've written this handy script! It attempts to setup PWM on every pin available, and lets you know which ones work and which ones don't. Check it out!
  1. import board
  2. import pulseio
  3.  
  4. for pin_name in dir(board):
  5. pin = getattr(board, pin_name)
  6. try:
  7. p = pulseio.PWMOut(pin)
  8. p.deinit()
  9. print("PWM on:", pin_name) # Prints the valid, PWM-capable pins!
  10. except ValueError: # This is the error returned when the pin is invalid.
  11. print("No PWM on:", pin_name) # Prints the invalid pins.
  12. except RuntimeError: # Timer conflict error.
  13. print("Timers in use:", pin_name) # Prints the timer conflict pins.
  14. except TypeError: # Error returned when checking a non-pin object in dir(board).
  15. pass # Passes over non-pin objects in dir(board).

CircuitPython Servo

In order to use servos, we take advantage of pulseio. Now, in theory, you could just use the raw pulseio calls to set the frequency to 50 Hz and then set the pulse widths. But we would rather make it a little more elegant and easy!
So, instead we will use simpleio which manages servos for you quite nicely! simpleio is a library so be sure to grab it from the library bundle if you have not yet! If you need help installing the library, check out the CircuitPython Libraries page.

Servo Wiring

Servos will only work on PWM-capable pins! Check your board details to verify which pins have PWM outputs.
Connect the servo's brown or black ground wire to ground on the CircuitPython board.
Connect the servo's red power wire to 5V power, USB power is good for a servo or two. For more than that, you'll need an external battery back. Do not use 3.3V for powering a servo!
Connect the servo's yellow or white signal wire to the control/data pin, in this case A1 or A2 but you can use any PWM-capable pin.

circuitpython_TrinketM0Servo_bb.jpg
For example, to wire a servo to Trinket, connect the ground wire to GND, the power wire to USB, and the signal wire to 0.

Remember, A2 on Trinket is labeled "0".


circuitpython_GemmaM0Servo_bb.jpg
For Gemma, use jumper wire alligator clips to connect the ground wire to GND, the power wire to VOUT, and the signal wire to A2.

circuitpython_CPXServo_bb.jpg
For Circuit Playground Express, use jumper wire alligator clips to connect the ground wire to GND, the power wire to VOUT, and the signal wire to A2.

circuitpython_FeatherM0ExpressServo_bb.jpg
For boards like Feather M0 Express, ItsyBitsy M0 Express and Metro M0 Express, connect the ground wire to any GND, the power wire to USB or 5V, and the signal wire to A2.

circuitpython_MetroM4ExpressServo_bb.jpg
For the Metro M4 Express, ItsyBitsy M4 Express and the Feather M4 Express, connect the ground wire to any G or GND, the power wire to USB or 5V, and the signal wire to A1.

Servo Code

Here's an example that will sweep a servo connected to pin A2 from 0 degrees to 180 degrees and back.
To use with any of the M0 boards, no changes to the following code are needed.
To use with the Metro M4 Express, ItsyBitsy M4 Express, and the Feather M4 Express, you must comment out the servo = simpleio.Servo(board.A2) line and uncomment the servo = simpleio.Servo(board.A1) line. A2 is not a supported PWM pin on the M4 boards!
  1. import time
  2. import board
  3. import simpleio
  4.  
  5. # For the M0 boards:
  6. servo = simpleio.Servo(board.A2)
  7. # For the M4 boards:
  8. # servo = simpleio.Servo(board.A1)
  9.  
  10. while True:
  11. for angle in range(0, 180, 5): # 0-180 degrees, 5 degrees at a time
  12. servo.angle = angle
  13. time.sleep(0.05)
  14. for angle in range(180, 0, -5): # 180-0 degrees, 5 degrees at a time
  15. servo.angle = angle
  16. time.sleep(0.05)
Pretty simple!
Note that we assume that 0 degrees is 0.5ms and 180 degrees is a pulse width of 2.5ms. That's a bit wider than the official 1-2ms pulse widths. If you have a servo that has a different range you can initialize the servo object with a different min_pulse and max_pulse. For example:
servo = simpleio.Servo(board.A2, min_pulse = 0.5, max_pulse = 2.5)
For more detailed information on using servos with CircuitPython, check out the CircuitPython section of the servo guide!

CircuitPython Cap Touch

Every CircuitPython designed M0 board has capacitive touch capabilities. This means each board has at least one pin that works as an input when you touch it! The capacitive touch is done completely in hardware, so no external resistors, capacitors or ICs required. Which is really nice!
Capacitive touch is not supported on the M4 Express boards.
This example will show you how to use a capacitive touch pin on your board.
Copy and paste the code into code.py using your favorite editor, and save the file.
  1. import time
  2.  
  3. import board
  4. import touchio
  5.  
  6. touch_pad = board.A0 # Will not work for Circuit Playground Express!
  7. # touch_pad = board.A1 # For Circuit Playground Express
  8.  
  9. touch = touchio.TouchIn(touch_pad)
  10.  
  11. while True:
  12. if touch.value:
  13. print("Touched!")
  14. time.sleep(0.05)

Create the Touch Input

First, we assign the variable touch_pad to a pin. The example uses A0, so we assign touch_pad = board.A0. You can choose any touch capable pin from the list below if you'd like to use a different pin. Then we create the touch object, name it touch and attach it to touch_pad.
To use with Circuit Playground Express, comment out touch_pad = board.A0 and uncomment touch_pad = board.A1.

Main Loop

Next, we create a loop that checks to see if the pin is touched. If it is, it prints to the serial console. Connect to the serial console to see the printed results when you touch the pin!
Remember: To "comment out" a line, put a # and a space before it. To "uncomment" a line, remove the # + space from the beginning of the line.
No extra hardware is required, because you can touch the pin directly. However, you may want to attach alligator clips or copper tape to metallic or conductive objects. Try metal flatware, fruit or other foods, liquids, aluminum foil, or other items lying around your desk!
You may need to reload your code or restart your board after changing the attached item because the capacitive touch code "calibrates" based on what it sees when it first starts up. So if you get too many touch responses or not enough, reload your code through the serial console or eject the board and tap the reset button!

Find the Pin(s)

Your board may have more touch capable pins beyond A0. We've included a list below that helps you find A0 (or A1 in the case of CPX) for this example, identified by the magenta arrow. This list also includes information about any other pins that work for touch on each board!
To use the other pins, simply change the number in A0 to the pin you want to use. For example, if you want to use A3 instead, your code would start with touch_pad = board.A3.
If you would like to use more than one pin at the same time, your code may look like the following. If needed, you can modify this code to include pins that work for your board.
  1. # CircuitPython Demo - Cap Touch Multiple Pins
  2. # Example does NOT work with Trinket M0!
  3.  
  4. import time
  5.  
  6. import board
  7. import touchio
  8.  
  9. touch_A1 = touchio.TouchIn(board.A1) # Not a touch pin on Trinket M0!
  10. touch_A2 = touchio.TouchIn(board.A2) # Not a touch pin on Trinket M0!
  11.  
  12. while True:
  13. if touch_A1.value:
  14. print("Touched A1!")
  15. if touch_A2.value:
  16. print("Touched A2!")
  17. time.sleep(0.05)
This example does NOT work for Trinket M0! You must change the pins to use with this board. This example only works with Gemma, Circuit Playground Express, Feather M0 Express, Metro M0 Express and ItsyBitsy M0 Express.
Use the list below to find out what pins you can use with your board. Then, try adding them to your code and have fun!

circuitpython_TrinketM0A0.png
Trinket M0

There are three touch capable pins on Trinket: A0, A3, and A4.

Remember, A0 is labeled "1~" on Trinket M0!

circuitpython_GemmaM0BoardA0.png
Gemma M0

There are three pins on Gemma, in the form of alligator-clip-friendly pads, that work for touch input: A0, A1 and A2.

circuitpython_FeatherM0ExpressBoardA0.png
Feather M0 Express

There are 6 pins on the Feather that have touch capability: A0 - A5.

circuitpython_ItsyBitsyM0ExpressBoardA0.png
ItsyBitsy M0 Express

There are 6 pins on the ItsyBitsy that have touch capability: A0 - A5.

circuitpython_MetroM0ExpressBoardA0.png
Metro M0 Express

There are 6 pins on the Metro that have touch capability: A0 - A5.

circuitpython_CPXTouchA1.png
Circuit Playground Express

Circuit Playground Express has seven touch capable pins!  You have A1 - A7 available, in the form of alligator-clip-friendly pads. See the CPX guide Cap Touch section for more information on using these pads for touch!

Remember: A0 does NOT have touch capabilities on CPX.

CircuitPython Internal RGB LED


Every board has a built in RGB LED. You can use CircuitPython to control the color and brightness of this LED. There are two different types of internal RGB LEDs: DotStar and NeoPixel. This section covers both and explains which boards have which LED.
circuitpython_NeoPixelDotStar.jpg
NeoPixel on the left, DotStar on the right. Not to scale... onboard DotStars are tiny!
The first example will show you how to change the color and brightness of the internal RGB LED.
Copy and paste the code into code.py using your favorite editor, and save the file.
  1. import time
  2. import board
  3.  
  4. # For Trinket M0, Gemma M0, ItsyBitsy M0 Express, and ItsyBitsy M4 Express
  5. import adafruit_dotstar
  6. led = adafruit_dotstar.DotStar(board.APA102_SCK, board.APA102_MOSI, 1)
  7. # For Feather M0 Express, Metro M0 Express, Metro M4 Express, and Circuit Playground Express
  8. # import neopixel
  9. # led = neopixel.NeoPixel(board.NEOPIXEL, 1)
  10.  
  11. led.brightness = 0.3
  12.  
  13. while True:
  14. led[0] = (255, 0, 0)
  15. time.sleep(0.5)
  16. led[0] = (0, 255, 0)
  17. time.sleep(0.5)
  18. led[0] = (0, 0, 255)
  19. time.sleep(0.5)

Create the LED

First, we create the LED object and attach it to the correct pin or pins. In the case of a NeoPixel, there is only one pin necessary, and we have called it NEOPIXEL for easier use. In the case of a DotStar, however, there are two pins necessary, and so we use the pin names APA102_MOSI and APA102_SCK to get it set up. Since we're using the single onboard LED, the last thing we do is tell it that there's only 1 LED!
Trinket M0, Gemma M0, ItsyBitsy M0 Express, and ItsyBitsy M4 Express each have an onboard Dotstar LED, so no changes are needed to the initial version of the example.
Feather M0 Express, Feather M4 Express, Metro M0 Express, Metro M4 Express, and Circuit Playground Express each have an onboard NeoPixel LED, so you must comment out import adafruit_dotstar and led = adafruit_dotstar.DotStar(board.APA102_SCK, board.APA102_MOSI, 1), and uncomment import neopixel and led = neopixel.NeoPixel(board.NEOPIXEL, 1).
Remember: To "comment out" a line, put a # and a space before it. To "uncomment" a line, remove the # + space from the beginning of the line.

Brightness

To set the brightness you simply use the brightness attribute. Brightness is set with a number between 0 and 1, representative of a percent from 0% to 100%. So, led.brightness = (0.3) sets the LED brightness to 30%. The default brightness is 1 or 100%, and at it's maximum, the LED is blindingly bright! You can set it lower if you choose.

Main Loop

LED colors are set using a combination of red, green, and blue, in the form of an (RG, B) tuple. Each member of the tuple is set to a number between 0 and 255 that determines the amount of each color present. Red, green and blue in different combinations can create all the colors in the rainbow! So, for example, to set the LED to red, the tuple would be (255, 0, 0), which has the maximum level of red, and no green or blue. Green would be (0, 255, 0), etc. For the colors between, you set a combination, such as cyan which is (0, 255, 255), with equal amounts of green and blue.
The main loop is quite simple. It sets the first LED to red using (255, 0, 0), then green using (0, 255, 0), and finally blue using (0, 0, 255). Next, we give it a time.sleep() so it stays each color for a period of time. We chose time.sleep(0.5), or half a second. Without the time.sleep() it'll flash really quickly and the colors will be difficult to see!
Note that we set led[0]. This means the first, and in the case of most of the boards, the only LED. In CircuitPython, counting starts at 0. So the first of any object, list, etc will be 0!
Try changing the numbers in the tuples to change your LED to any color of the rainbow. Or, you can add more lines with different color tuples to add more colors to the sequence. Always add the time.sleep(), but try changing the amount of time to create different cycle animations!

Making Rainbows (Because Who Doesn't Love 'Em!)

Coding a rainbow effect involves a little math and a helper function called wheel. For details about how wheel works, see this explanation here!
The last example shows how to do a rainbow animation on the internal RGB LED.
Copy and paste the code into code.py using your favorite editor, and save the file. Remember to comment and uncomment the right lines for the board you're using, as explained above.
  1. import time
  2. import board
  3.  
  4. # For Trinket M0, Gemma M0, ItsyBitsy M0 Express and ItsyBitsy M4 Express
  5. import adafruit_dotstar
  6. led = adafruit_dotstar.DotStar(board.APA102_SCK, board.APA102_MOSI, 1)
  7. # For Feather M0 Express, Metro M0 Express, Metro M4 Express and Circuit Playground Express
  8. # import neopixel
  9. # led = neopixel.NeoPixel(board.NEOPIXEL, 1)
  10.  
  11.  
  12. def wheel(pos):
  13. # Input a value 0 to 255 to get a color value.
  14. # The colours are a transition r - g - b - back to r.
  15. if pos < 0 or pos > 255:
  16. return 0, 0, 0
  17. if pos < 85:
  18. return int(255 - pos * 3), int(pos * 3), 0
  19. if pos < 170:
  20. pos -= 85
  21. return 0, int(255 - pos * 3), int(pos * 3)
  22. pos -= 170
  23. return int(pos * 3), 0, int(255 - (pos * 3))
  24.  
  25.  
  26. led.brightness = 0.3
  27.  
  28. i = 0
  29. while True:
  30. i = (i + 1) % 256 # run from 0 to 255
  31. led.fill(wheel(i))
  32. time.sleep(0.1)
We add the wheel function in after setup but before our main loop.
And right before our main loop, we assign the variable i = 0, so it's ready for use inside the loop.
The main loop contains some math that cycles i from 0 to 255 and around again repeatedly. We use this value to cycle wheel() through the rainbow!
The time.sleep() determines the speed at which the rainbow changes. Try a higher number for a slower rainbow or a lower number for a faster one!

Circuit Playground Express Rainbow

Note that here we use led.fill instead of led[0]. This means it turns on all the LEDs, which in the current code is only one. So why bother with fill? Well, you may have a Circuit Playground Express, which as you can see has TEN NeoPixel LEDs built in. The examples so far have only turned on the first one. If you'd like to do a rainbow on all ten LEDs, change the 1 in:
led = neopixel.NeoPixel(board.NEOPIXEL, 1)
to 10 so it reads:
led = neopixel.NeoPixel(board.NEOPIXEL, 10).
This tells the code to look for 10 LEDs instead of only 1. Now save the code and watch the rainbow go! You can make the same 1 to 10 change to the previous examples as well, and use led.fill to light up all the LEDs in the colors you chose! For more details, check out the NeoPixel section of the CPX guide!

CircuitPython NeoPixel

NeoPixels are a revolutionary and ultra-popular way to add lights and color to your project. These stranded RGB lights have the controller inside the LED, so you just push the RGB data and the LEDs do all the work for you. They're a perfect match for CircuitPython!
You can drive 300 NeoPixel LEDs with brightness control (set brightness=1.0 in object creation) and 1000 LEDs without. That's because to adjust the brightness we have to dynamically recreate the data-stream each write.
You'll need the neopixel.mpy library if you don't already have it in your /lib folder! You can get it from the CircuitPython Library Bundle. If you need help installing the library, check out the CircuitPython Libraries page.

Wiring It Up

You'll need to solder up your NeoPixels first. Verify your connection is on the DATA INPUT or DIN side. Plugging into the DATA OUT or DOUT side is a common mistake! The connections are labeled and some formats have arrows to indicate the direction the data must flow.
For powering the pixels from the board, the 3.3V regulator output can handle about 500mA peak which is about 50 pixels with 'average' use. If you want really bright lights and a lot of pixels, we recommend powering direct from an external power source.
  • On Gemma M0 and Circuit Playground Express this is the Vout pad - that pad has direct power from USB or the battery, depending on which is higher voltage.
  • On Trinket M0, Feather M0 Express, Feather M4 Express, ItsyBitsy M0 Express and ItsyBitsy M4 Express the USB or BAT pins will give you direct power from the USB port or battery.
  • On Metro M0 Express and Metro M4 Express, use the 5V pin regardless of whether it's powered via USB or the DC jack.
If the power to the NeoPixels is greater than 5.5V you may have some difficulty driving some strips, in which case you may need to lower the voltage to 4.5-5V or use a level shifter.
Do not use the VIN pin directly on Metro M0 Express or Metro M4 Express! The voltage can reach 9V and this can destroy your NeoPixels!
Note that the wire ordering on your NeoPixel strip or shape may not exactly match the diagram above. Check the markings to verify which pin is DIN, 5V and GND

The Code

This example includes multiple visual effects. Copy and paste the code into code.py using your favorite editor, and save the file.
  1. # CircuitPython demo - NeoPixel
  2. import time
  3. import board
  4. import neopixel
  5.  
  6. pixel_pin = board.A1
  7. num_pixels = 8
  8.  
  9. pixels = neopixel.NeoPixel(pixel_pin, num_pixels, brightness=0.3, auto_write=False)
  10.  
  11.  
  12. def wheel(pos):
  13. # Input a value 0 to 255 to get a color value.
  14. # The colours are a transition r - g - b - back to r.
  15. if pos < 0 or pos > 255:
  16. return (0, 0, 0)
  17. if pos < 85:
  18. return (255 - pos * 3, pos * 3, 0)
  19. if pos < 170:
  20. pos -= 85
  21. return (0, 255 - pos * 3, pos * 3)
  22. pos -= 170
  23. return (pos * 3, 0, 255 - pos * 3)
  24.  
  25.  
  26. def color_chase(color, wait):
  27. for i in range(num_pixels):
  28. pixels[i] = color
  29. time.sleep(wait)
  30. pixels.show()
  31. time.sleep(0.5)
  32.  
  33.  
  34. def rainbow_cycle(wait):
  35. for j in range(255):
  36. for i in range(num_pixels):
  37. rc_index = (i * 256 // num_pixels) + j
  38. pixels[i] = wheel(rc_index & 255)
  39. pixels.show()
  40. time.sleep(wait)
  41.  
  42.  
  43. RED = (255, 0, 0)
  44. YELLOW = (255, 150, 0)
  45. GREEN = (0, 255, 0)
  46. CYAN = (0, 255, 255)
  47. BLUE = (0, 0, 255)
  48. PURPLE = (180, 0, 255)
  49.  
  50. while True:
  51. pixels.fill(RED)
  52. pixels.show()
  53. # Increase or decrease to change the speed of the solid color change.
  54. time.sleep(1)
  55. pixels.fill(GREEN)
  56. pixels.show()
  57. time.sleep(1)
  58. pixels.fill(BLUE)
  59. pixels.show()
  60. time.sleep(1)
  61.  
  62. color_chase(RED, 0.1) # Increase the number to slow down the color chase
  63. color_chase(YELLOW, 0.1)
  64. color_chase(GREEN, 0.1)
  65. color_chase(CYAN, 0.1)
  66. color_chase(BLUE, 0.1)
  67. color_chase(PURPLE, 0.1)
  68.  
  69. rainbow_cycle(0) # Increase the number to slow down the rainbow

Create the LED

The first thing we'll do is create the LED object. The NeoPixel object has two required arguments and two optional arguments. You are required to set the pin you're using to drive your NeoPixels and provide the number of pixels you intend to use. You can optionally set brightness and auto_write.
NeoPixels can be driven by any pin. We've chosen A1. To set the pin, assign the variable pixel_pin to the pin you'd like to use, in our case board.A1.
To provide the number of pixels, assign the variable num_pixels to the number of pixels you'd like to use. In this example, we're using a strip of 8.
We've chosen to set brightness=0.3, or 30%.
By default, auto_write=True, meaning any changes you make to your pixels will be sent automatically. Since True is the default, if you use that setting, you don't need to include it in your LED object at all. We've chosen to set auto_write=False. If you set auto_write=False, you must include pixels.show() each time you'd like to send data to your pixels. This makes your code more complicated, but it can make your LED animations faster!

NeoPixel Helpers

Next we've included a few helper functions to create the super fun visual effects found in this code. First is wheel() which we just learned with the Internal RGB LED. Then we have color_chase() which requires you to provide a color and the amount of time in seconds you'd like between each step of the chase. Next we have rainbow_cycle(), which requires you to provide the mount of time in seconds you'd like the animation to take. Last, we've included a list of variables for our colors. This makes it much easier if to reuse the colors anywhere in the code, as well as add more colors for use in multiple places. Assigning and using RGB colors is explained in this section of the CircuitPython Internal RGB LED page.

Main Loop

Thanks to our helpers, our main loop is quite simple. We include the code to set every NeoPixel we're using to red, green and blue for 1 second each. Then we call color_chase(), one time for each color on our list with 0.1 second delay between setting each subsequent LED the same color during the chase. Last we call rainbow_cycle(0), which means the animation is as fast as it can be. Increase both of those numbers to slow down each animation!
Note that the longer your strip of LEDs, the longer it will take for the animations to complete.
We have a ton more information on general purpose NeoPixel know-how at our NeoPixel UberGuide https://learn.adafruit.com/adafruit-neopixel-uberguide

NeoPixel RGBW

NeoPixels are available in RGB, meaning there are three LEDs inside, red, green and blue. They're also available in RGBW, which includes four LEDs, red, green, blue and white. The code for RGBW NeoPixels is a little bit different than RGB.
If you run RGB code on RGBW NeoPixels, approximately 3/4 of the LEDs will light up and the LEDs will be the incorrect color even though they may appear to be changing. This is because NeoPixels require a piece of information for each available color (red, green, blue and possibly white).
Therefore, RGB LEDs require three pieces of information and RGBW LEDs require FOUR pieces of information to work. So when you create the LED object for RGBW LEDs, you'll include bpp=4, which sets bits-per-pixel to four (the four pieces of information!).
Then, you must include an extra number in every color tuple you create. For example, red will be (255, 0, 0, 0). This is how you send the fourth piece of information. Check out the example below to see how our NeoPixel code looks for using with RGBW LEDs!
  1. # CircuitPython demo - NeoPixel RGBW
  2.  
  3. import time
  4. import board
  5. import neopixel
  6.  
  7. pixel_pin = board.A1
  8. num_pixels = 8
  9.  
  10. pixels = neopixel.NeoPixel(pixel_pin, num_pixels, brightness=0.3, auto_write=False,
  11. pixel_order=(1, 0, 2, 3))
  12.  
  13.  
  14. def wheel(pos):
  15. # Input a value 0 to 255 to get a color value.
  16. # The colours are a transition r - g - b - back to r.
  17. if pos < 0 or pos > 255:
  18. return (0, 0, 0, 0)
  19. if pos < 85:
  20. return (255 - pos * 3, pos * 3, 0, 0)
  21. if pos < 170:
  22. pos -= 85
  23. return (0, 255 - pos * 3, pos * 3, 0)
  24. pos -= 170
  25. return (pos * 3, 0, 255 - pos * 3, 0)
  26.  
  27.  
  28. def color_chase(color, wait):
  29. for i in range(num_pixels):
  30. pixels[i] = color
  31. time.sleep(wait)
  32. pixels.show()
  33. time.sleep(0.5)
  34.  
  35.  
  36. def rainbow_cycle(wait):
  37. for j in range(255):
  38. for i in range(num_pixels):
  39. rc_index = (i * 256 // num_pixels) + j
  40. pixels[i] = wheel(rc_index & 255)
  41. pixels.show()
  42. time.sleep(wait)
  43.  
  44.  
  45. RED = (255, 0, 0, 0)
  46. YELLOW = (255, 150, 0, 0)
  47. GREEN = (0, 255, 0, 0)
  48. CYAN = (0, 255, 255, 0)
  49. BLUE = (0, 0, 255, 0)
  50. PURPLE = (180, 0, 255, 0)
  51.  
  52. while True:
  53. pixels.fill(RED)
  54. pixels.show()
  55. # Increase or decrease to change the speed of the solid color change.
  56. time.sleep(1)
  57. pixels.fill(GREEN)
  58. pixels.show()
  59. time.sleep(1)
  60. pixels.fill(BLUE)
  61. pixels.show()
  62. time.sleep(1)
  63.  
  64. color_chase(RED, 0.1) # Increase the number to slow down the color chase
  65. color_chase(YELLOW, 0.1)
  66. color_chase(GREEN, 0.1)
  67. color_chase(CYAN, 0.1)
  68. color_chase(BLUE, 0.1)
  69. color_chase(PURPLE, 0.1)
  70.  
  71. rainbow_cycle(0) # Increase the number to slow down the rainbow

CircuitPython DotStar

DotStars use two wires, unlike NeoPixel's one wire. They're very similar but you can write to DotStars much faster with hardware SPI and they have a faster PWM cycle so they are better for light painting.
Any pins can be used but if the two pins can form a hardware SPI port, the library will automatically switch over to hardware SPI. If you use hardware SPI then you'll get 4 MHz clock rate (that would mean updating a 64 pixel strand in about 500uS - that's 0.0005 seconds). If you use non-hardware SPI pins you'll drop down to about 3KHz, 1000 times as slow!
You can drive 300 DotStar LEDs with brightness control (set brightness=1.0 in object creation) and 1000 LEDs without. That's because to adjust the brightness we have to dynamically recreate the data-stream each write.
You'll need the adafruit_dotstar.mpy library if you don't already have it in your /lib folder! You can get it from the CircuitPython Library Bundle. If you need help installing the library, check out the CircuitPython Libraries page.

Wire It Up

You'll need to solder up your DotStars first. Verify your connection is on the DATA INPUT or DI and CLOCK INPUT or CI side. Plugging into the DATA OUT/DO or CLOCK OUT/CO side is a common mistake! The connections are labeled and some formats have arrows to indicate the direction the data must flow. Always verify your wiring with a visual inspection, as the order of the connections can differ from strip to strip!
For powering the pixels from the board, the 3.3V regulator output can handle about 500mA peak which is about 50 pixels with 'average' use. If you want really bright lights and a lot of pixels, we recommend powering direct from an external power source.
  • On Gemma M0 and Circuit Playground Express this is the Vout pad - that pad has direct power from USB or the battery, depending on which is higher voltage.
  • On Trinket M0, Feather M0 Express, Feather M4 Express, ItsyBitsy M0 Express and ItsyBitsy M4 Express the USB or BAT pins will give you direct power from the USB port or battery.
  • On Metro M0 Express and Metro M4 Express, use the 5V pin regardless of whether it's powered via USB or the DC jack.
If the power to the DotStars is greater than 5.5V you may have some difficulty driving some strips, in which case you may need to lower the voltage to 4.5-5V or use a level shifter.
Do not use the VIN pin directly on Metro M0 Express or Metro M4 Express! The voltage can reach 9V and this can destroy your DotStars!
Note that the wire ordering on your DotStar strip or shape may not exactly match the diagram above. Check the markings to verify which pin is DIN, CIN, 5V and GND

The Code

This example includes multiple visual effects. Copy and paste the code into code.py using your favorite editor, and save the file.
  1. # CircuitPython demo - Dotstar
  2. import time
  3. import adafruit_dotstar
  4. import board
  5.  
  6. num_pixels = 30
  7. pixels = adafruit_dotstar.DotStar(board.A1, board.A2, num_pixels, brightness=0.1, auto_write=False)
  8.  
  9.  
  10. def wheel(pos):
  11. # Input a value 0 to 255 to get a color value.
  12. # The colours are a transition r - g - b - back to r.
  13. if pos < 0 or pos > 255:
  14. return (0, 0, 0)
  15. if pos < 85:
  16. return (255 - pos * 3, pos * 3, 0)
  17. if pos < 170:
  18. pos -= 85
  19. return (0, 255 - pos * 3, pos * 3)
  20. pos -= 170
  21. return (pos * 3, 0, 255 - pos * 3)
  22.  
  23.  
  24. def color_fill(color, wait):
  25. pixels.fill(color)
  26. pixels.show()
  27. time.sleep(wait)
  28.  
  29.  
  30. def slice_alternating(wait):
  31. pixels[::2] = [RED] * (num_pixels // 2)
  32. pixels.show()
  33. time.sleep(wait)
  34. pixels[1::2] = [ORANGE] * (num_pixels // 2)
  35. pixels.show()
  36. time.sleep(wait)
  37. pixels[::2] = [YELLOW] * (num_pixels // 2)
  38. pixels.show()
  39. time.sleep(wait)
  40. pixels[1::2] = [GREEN] * (num_pixels // 2)
  41. pixels.show()
  42. time.sleep(wait)
  43. pixels[::2] = [TEAL] * (num_pixels // 2)
  44. pixels.show()
  45. time.sleep(wait)
  46. pixels[1::2] = [CYAN] * (num_pixels // 2)
  47. pixels.show()
  48. time.sleep(wait)
  49. pixels[::2] = [BLUE] * (num_pixels // 2)
  50. pixels.show()
  51. time.sleep(wait)
  52. pixels[1::2] = [PURPLE] * (num_pixels // 2)
  53. pixels.show()
  54. time.sleep(wait)
  55. pixels[::2] = [MAGENTA] * (num_pixels // 2)
  56. pixels.show()
  57. time.sleep(wait)
  58. pixels[1::2] = [WHITE] * (num_pixels // 2)
  59. pixels.show()
  60. time.sleep(wait)
  61.  
  62.  
  63. def slice_rainbow(wait):
  64. pixels[::6] = [RED] * (num_pixels // 6)
  65. pixels.show()
  66. time.sleep(wait)
  67. pixels[1::6] = [ORANGE] * (num_pixels // 6)
  68. pixels.show()
  69. time.sleep(wait)
  70. pixels[2::6] = [YELLOW] * (num_pixels // 6)
  71. pixels.show()
  72. time.sleep(wait)
  73. pixels[3::6] = [GREEN] * (num_pixels // 6)
  74. pixels.show()
  75. time.sleep(wait)
  76. pixels[4::6] = [BLUE] * (num_pixels // 6)
  77. pixels.show()
  78. time.sleep(wait)
  79. pixels[5::6] = [PURPLE] * (num_pixels // 6)
  80. pixels.show()
  81. time.sleep(wait)
  82.  
  83.  
  84. def rainbow_cycle(wait):
  85. for j in range(255):
  86. for i in range(num_pixels):
  87. rc_index = (i * 256 // num_pixels) + j
  88. pixels[i] = wheel(rc_index & 255)
  89. pixels.show()
  90. time.sleep(wait)
  91.  
  92.  
  93. RED = (255, 0, 0)
  94. YELLOW = (255, 150, 0)
  95. ORANGE = (255, 40, 0)
  96. GREEN = (0, 255, 0)
  97. TEAL = (0, 255, 120)
  98. CYAN = (0, 255, 255)
  99. BLUE = (0, 0, 255)
  100. PURPLE = (180, 0, 255)
  101. MAGENTA = (255, 0, 20)
  102. WHITE = (255, 255, 255)
  103.  
  104. while True:
  105. # Change this number to change how long it stays on each solid color.
  106. color_fill(RED, 0.5)
  107. color_fill(YELLOW, 0.5)
  108. color_fill(ORANGE, 0.5)
  109. color_fill(GREEN, 0.5)
  110. color_fill(TEAL, 0.5)
  111. color_fill(CYAN, 0.5)
  112. color_fill(BLUE, 0.5)
  113. color_fill(PURPLE, 0.5)
  114. color_fill(MAGENTA, 0.5)
  115. color_fill(WHITE, 0.5)
  116.  
  117. # Increase or decrease this to speed up or slow down the animation.
  118. slice_alternating(0.1)
  119.  
  120. color_fill(WHITE, 0.5)
  121.  
  122. # Increase or decrease this to speed up or slow down the animation.
  123. slice_rainbow(0.1)
  124.  
  125. time.sleep(0.5)
  126.  
  127. # Increase this number to slow down the rainbow animation.
  128. rainbow_cycle(0)
We've chosen pins A1 and A2, but these are not SPI pins on all boards. DotStars respond faster when using hardware SPI!

Create the LED

The first thing we'll do is create the LED object. The DotStar object has three required arguments and two optional arguments. You are required to set the pin you're using for data, set the pin you'll be using for clock, and provide the number of pixels you intend to use. You can optionally set brightness and auto_write.
DotStars can be driven by any two pins. We've chosen A1 for clock and A2 for data. To set the pins, include the pin names at the beginning of the object creation, in this case board.A1 and board.A2.
To provide the number of pixels, assign the variable num_pixels to the number of pixels you'd like to use. In this example, we're using a strip of 72.
We've chosen to set brightness=0.1, or 10%.
By default, auto_write=True, meaning any changes you make to your pixels will be sent automatically. Since True is the default, if you use that setting, you don't need to include it in your LED object at all. We've chosen to set auto_write=False. If you set auto_write=False, you must include pixels.show() each time you'd like to send data to your pixels. This makes your code more complicated, but it can make your LED animations faster!

DotStar Helpers

We've included a few helper functions to create the super fun visual effects found in this code.
First is wheel() which we just learned with the Internal RGB LED. Then we have color_fill() which requires you to provide a color and the length of time you'd like it to be displayed. Next, are slice_alternating(), slice_rainbow(), and rainbow_cycle() which require you to provide the amount of time in seconds you'd between each step of the animation.
Last, we've included a list of variables for our colors. This makes it much easier if to reuse the colors anywhere in the code, as well as add more colors for use in multiple places. Assigning and using RGB colors is explained in this section of the CircuitPython Internal RGB LED page.
The two slice helpers utilise a nifty feature of the DotStar library that allows us to use math to light up LEDs in repeating patterns. slice_alternating() first lights up the even number LEDs and then the odd number LEDs and repeats this back and forth. slice_rainbow() lights up every sixth LED with one of the six rainbow colors until the strip is filled. Both use our handy color variables. This slice code only works when the total number of LEDs is divisible by the slice size, in our case 2 and 6. DotStars come in strips of 30, 60, 72, and 144, all of which are divisible by 2 and 6. In the event that you cut them into different sized strips, the code in this example may not work without modification. However, as long as you provide a total number of LEDs that is divisible by the slices, the code will work.

Main Loop

Our main loop begins by calling color_fill() once for each color on our list and sets each to hold for 0.5 seconds. You can change this number to change how fast each color is displayed. Next, we call slice_alternating(0.1), which means there's a 0.1 second delay between each change in the animation. Then, we fill the strip white to create a clean backdrop for the rainbow to display. Then, we call slice_rainbow(0.1), for a 0.1 second delay in the animation. Last we call rainbow_cycle(0), which means it's as fast as it can possibly be. Increase or decrease either of these numbers to speed up or slow down the animations!
Note that the longer your strip of LEDs is, the longer it will take for the animations to complete.
We have a ton more information on general purpose DotStar know-how at our DotStar UberGuide https://learn.adafruit.com/adafruit-dotstar-leds

Is it SPI?

We explained at the beginning of this section that the LEDs respond faster if you're using hardware SPI. On some of the boards, there are HW SPI pins directly available in the form of MOSI and SCK. However, hardware SPI is available on more than just those pins. But, how can you figure out which? Easy! We wrote a handy script.
We chose pins A1 and A2 for our example code. To see if these are hardware SPI on the board you're using, copy and paste the code into code.py using your favorite editor, and save the file. Then connect to the serial console to see the results.
To check if other pin combinations have hardware SPI, change the pin names on the line reading: if is_hardware_SPI(board.A1, board.A2): to the pins you want to use. Then, check the results in the serial console. Super simple!
  1. import board
  2. import busio
  3.  
  4.  
  5. def is_hardware_spi(clock_pin, data_pin):
  6. try:
  7. p = busio.SPI(clock_pin, data_pin)
  8. p.deinit()
  9. return True
  10. except ValueError:
  11. return False
  12.  
  13.  
  14. # Provide the two pins you intend to use.
  15. if is_hardware_spi(board.A1, board.A2):
  16. print("This pin combination is hardware SPI!")
  17. else:
  18. print("This pin combination isn't hardware SPI.")

CircuitPython UART Serial


In addition to the USB-serial connection you use for the REPL, there is also a hardware UART you can use. This is handy to talk to UART devices like GPSs, some sensors, or other microcontrollers!
This quick-start example shows how you can create a UART device for communicating with hardware serial devices.
To use this example, you'll need something to generate the UART data. We've used a GPS! Note that the GPS will give you UART data without getting a fix on your location. You can use this example right from your desk! You'll have data to read, it simply won't include your actual location.
You'll need the adafruit_bus_device library folder if you don't already have it in your /lib folder! You can get it from the CircuitPython Library Bundle. If you need help installing the library, check out the CircuitPython Libraries page.
Copy and paste the code into code.py using your favorite editor, and save the file.
  1. # CircuitPython Demo - USB/Serial echo
  2.  
  3. import board
  4. import busio
  5. import digitalio
  6.  
  7. led = digitalio.DigitalInOut(board.D13)
  8. led.direction = digitalio.Direction.OUTPUT
  9.  
  10. uart = busio.UART(board.TX, board.RX, baudrate=9600)
  11.  
  12. while True:
  13. data = uart.read(32) # read up to 32 bytes
  14. # print(data) # this is a bytearray type
  15.  
  16. if data is not None:
  17. led.value = True
  18.  
  19. # convert bytearray to string
  20. data_string = ''.join([chr(b) for b in data])
  21. print(data_string, end="")
  22.  
  23. led.value = False

The Code

First we create the UART object. We provide the pins we'd like to use, board.TX and board.RX, and we set the baudrate=9600. While these pins are labeled on most of the boards, be aware that RX and TX are not labeled on Gemma, and are labeled on the bottom of Trinket. See the diagrams below for help with finding the correct pins on your board.
Once the object is created you read data in with read(numbytes) where you can specify the max number of bytes. It will return a byte array type object if anything was received already. Note it will always return immediately because there is an internal buffer! So read as much data as you can 'digest'.
If there is no data available, read() will return None, so check for that before continuing.
The data that is returned is in a byte array, if you want to convert it to a string, you can use this handy line of code which will run chr() on each byte:
datastr = ''.join([chr(b) for b in data]) # convert bytearray to string
Your results will look something like this:
For more information about the data you're reading and the Ultimate GPS, check out the Ultimate GPS guide: https://learn.adafruit.com/adafruit-ultimate-gps

Wire It Up

You'll need a couple of things to connect the GPS to your board.
For Gemma M0 and Circuit Playground Express, you can use use alligator clips to connect to the Flora Ultimate GPS Module.
For Trinket M0, Feather M0 Express, Metro M0 Express and ItsyBitsy M0 Express, you'll need a breadboard and jumper wires to connect to the Ultimate GPS Breakout.
We've included diagrams show you how to connect the GPS to your board. In these diagrams, the wire colors match the same pins on each board.
  • The black wire connects between the ground pins.
  • The red wire connects between the power pins on the GPS and your board.
  • The blue wire connects from TX on the GPS to RX on your board.
  • The white wire connects from RX on the GPS to TX on your board.
Check out the list below for a diagram of your specific board!
Watch out! A common mixup with UART serial is that RX on one board connects to TX on the other! However, sometimes boards have RX labeled TX and vice versa. So, you'll want to start with RX connected to TX, but if that doesn't work, try the other way around!

circuitpython_CPXUARTGPS_bb.jpg
Circuit Playground Express
  • Connect 3.3v on your CPX to 3.3v on your GPS.
  • Connect GND on your CPX to GND on your GPS.
  • Connect RX/A6 on your CPX to TX on your GPS.
  • Connect TX/A7 on your CPX to RX on your GPS.

circuitpython_TrinketM0UARTGPS_bb.jpg
Trinket M0
  • Connect USB on the Trinket to VIN on the GPS.
  • Connect Gnd on the Trinket to GND on the GPS.
  • Connect D3 on the Trinket to TX on the GPS.
  • Connect D4 on the Trinket to RX on the GPS.

circuitpython_GemmaM0UARTGPS_bb.jpg
Gemma M0
  • Connect 3vo on the Gemma to 3.3v on the GPS.
  • Connect GND on the Gemma to GND on the GPS.
  • Connect A1/D2 on the Gemma to TX on the GPS.
  • Connect A2/D0 on the Gemma to RX on the GPS.

circuitpython_FeatherM0UARTGPS_bb.jpg
Feather M0 Express and Feather M4 Express
  • Connect USB on the Feather to VIN on the GPS.
  • Connect GND on the Feather to GND on the GPS.
  • Connect RX on the Feather to TX on the GPS.
  • Connect TX on the Feather to RX on the GPS.

circuitpython_ItsyBitsyM0ExpressUARTGPS_bb.jpg
ItsyBitsy M0 Express and ItsyBitsy M4 Express
  • Connect USB on the ItsyBitsy to VIN on the GPS
  • Connect G on the ItsyBitsy to GND on the GPS.
  • Connect RX/0 on the ItsyBitsy to TX on the GPS.
  • Connect TX/1 on the ItsyBitsy to RX on the GPS.

circuitpython_MetroM0UARTGPS_bb.jpg
Metro M0 Express and Metro M4 Express
  • Connect 5V on the Metro to VIN on the GPS.
  • Connect GND on the Metro to GND on the GPS.
  • Connect RX/D0 on the Metro to TX on the GPS.
  • Connect TX/D1 on the Metro to RX on the GPS.

Where's my UART?

On the SAMD21, we have the flexibility of using a wide range of pins for UART. Compare this to some chips like the ESP8266 with fixed UART pins. The good news is you can use many but not all pins. Given the large number of SAMD boards we have, its impossible to guarantee anything other than the labeled 'TX' and 'RX'. So, if you want some other setup, or multiple UARTs, how will you find those pins? Easy! We've written a handy script.
All you need to do is copy this file to your board, rename it code.py, connect to the serial console and check out the output! The results print out a nice handy list of RX and TX pin pairs that you can use.
These are the results from a Trinket M0, your output may vary and it might be very long. For more details about UARTs and SERCOMs check out our detailed guide here
  1. import board
  2. import busio
  3. from microcontroller import Pin
  4.  
  5.  
  6. def is_hardware_uart(tx, rx):
  7. try:
  8. p = busio.UART(tx, rx)
  9. p.deinit()
  10. return True
  11. except ValueError:
  12. return False
  13.  
  14.  
  15. def get_unique_pins():
  16. exclude = ['NEOPIXEL', 'APA102_MOSI', 'APA102_SCK']
  17. pins = [pin for pin in [
  18. getattr(board, p) for p in dir(board) if p not in exclude]
  19. if isinstance(pin, Pin)]
  20. unique = []
  21. for p in pins:
  22. if p not in unique:
  23. unique.append(p)
  24. return unique
  25.  
  26.  
  27. for tx_pin in get_unique_pins():
  28. for rx_pin in get_unique_pins():
  29. if rx_pin is tx_pin:
  30. continue
  31. else:
  32. if is_hardware_uart(tx_pin, rx_pin):
  33. print("RX pin:", rx_pin, "\t TX pin:", tx_pin)
  34. else:
  35. pass

Trinket M0: Create UART before I2C

On the Trinket M0 (only), if you are using both busio.UART and busio.I2C, you must create the UART object first, e.g.:
>>> import board,busio
>>> uart = busio.UART(board.TX, board.RX)
>>> i2c = busio.I2C(board.SCL, board.SDA)
Creating busio.I2C first does not work:
>>> import board,busio
>>> i2c = busio.I2C(board.SCL, board.SDA)
>>> uart = busio.UART(board.TX, board.RX)
Traceback (most recent call last):
File "", line 1, in
ValueError: Invalid pins

CircuitPython I2C

I2C is a 2-wire protocol for communicating with simple sensors and devices, meaning it uses two connections for transmitting and receiving data. There are many I2C devices available and they're really easy to use with CircuitPython. We have libraries available for many I2C devices in the library bundle. (If you don't see the sensor you're looking for, keep checking back, more are being written all the time!)
In this section, we're going to do is learn how to scan the I2C bus for all connected devices. Then we're going to learn how to interact with an I2C device.
We'll be using the TSL2561, a common, low-cost light sensor. While the exact code we're running is specific to the TSL2561 the overall process is the same for just about any I2C sensor or device.
You'll need the adafruit_tsl2561.mpy library and adafruit_bus_device library folder if you don't already have it in your /lib folder! You can get it from the CircuitPython Library Bundle. If you need help installing the library, check out the CircuitPython Libraries page.
These examples will use the TSL2561 lux sensor Flora and breakout. The first thing you'll want to do is get the sensor connected so your board has I2C to talk to.

Wire It Up

You'll need a couple of things to connect the TSL2561 to your board.
For Gemma M0 and Circuit Playground Express, you can use use alligator clips to connect to the Flora TSL2561 Lux Sensor.
For Trinket M0, Feather M0 Express, Metro M0 Express and ItsyBitsy M0 Express, you'll need a breadboard and jumper wires to connect to the TSL2561 Lux Sensor breakout board.
We've included diagrams show you how to connect the TSL2561 to your board. In these diagrams, the wire colors match the same pins on each board.
  • The black wire connects between the ground pins.
  • The red wire connects between the power pins on the TSL2561 and your board.
  • The yellow wire connects from SCL on the TSL2561 to SCL on your board.
  • The blue wire connects from SDA on the TSL2561 to SDA on your board.
Check out the list below for a diagram of your specific board!
Be aware that the M0 boards do not have I2C pullup resistors built in! All of the Adafruit breakouts do, but if you're building your own board or using a non-Adafruit breakout, you must add 2.2K-10K ohm pullups on both SDA and SCL to the 3.3V.

circuitpython_CPXI2C_bb.jpg
Circuit Playground Express

  • Connect 3.3v on your CPX to 3.3v on your TSL2561.
  • Connect GND on your CPX to GND on your TSL2561.
  • Connect SCL/A4 on your CPX to SCL on your TSL2561.
  • Connect SDL/A5 on your CPX to SDA on your TSL2561.

circuitpython_TrinketM0I2C_bb.jpg
Trinket M0

  • Connect USB on the Trinket to VIN on the TSL2561.
  • Connect Gnd on the Trinket to GND on the TSL2561.
  • Connect D2 on the Trinket to SCL on the TSL2561.
  • Connect D0 on the Trinket to SDA on the TSL2561.

circuitpython_GemmaM0I2C_bb.jpg
Gemma M0

  • Connect 3vo on the Gemma to 3V on the TSL2561.
  • Connect GND on the Gemma to GND on the TSL2561.
  • Connect A1/D2 on the Gemma to SCL on the TSL2561.
  • Connect A2/D0 on the Gemma to SDA on the TSL2561.

circuitpython_FeatherM0ExpressI2C_bb.jpg
Feather M0 Express and Feather M4 Express

  • Connect USB on the Feather to VIN on the TSL2561.
  • Connect GND on the Feather to GND on the TSL2561.
  • Connect SCL on the Feather to SCL on the TSL2561.
  • Connect SDA on the Feather to SDA on the TSL2561.

circuitpython_ItsyBitsyM0ExpressI2C_bb.jpg
ItsyBitsy M0 Express and ItsyBitsy M4 Express

  • Connect USB on the ItsyBitsy to VIN on the TSL2561
  • Connect G on the ItsyBitsy to GND on the TSL2561.
  • Connect SCL on the ItsyBitsy to SCL on the TSL2561.
  • Connect SDA on the ItsyBitsy to SDA on the TSL2561.

circuitpython_MetroM0ExpressI2C_bb.jpg
Metro M0 Express and Metro M4 Express

  • Connect 5V on the Metro to VIN on the TSL2561.
  • Connect GND on the Metro to GND on the TSL2561.
  • Connect SCL on the Metro to SCL on the TSL2561.
  • Connect SDA on the Metro to SDA on the TSL2561.

Find Your Sensor

The first thing you'll want to do after getting the sensor wired up, is make sure it's wired correctly. We're going to do an I2C scan to see if the board is detected, and if it is, print out its I2C address.
Copy and paste the code into code.py using your favorite editor, and save the file.
  1. # CircuitPython demo - I2C scan
  2.  
  3. import time
  4.  
  5. import board
  6. import busio
  7.  
  8. i2c = busio.I2C(board.SCL, board.SDA)
  9.  
  10. while not i2c.try_lock():
  11. pass
  12.  
  13. while True:
  14. print("I2C addresses found:", [hex(device_address)
  15. for device_address in i2c.scan()])
  16. time.sleep(2)
First we create the i2c object and provide the I2C pins, board.SCL and board.SDA.
To be able to scan it, we need to lock the I2C down so the only thing accessing it is the code. So next we include a loop that waits until I2C is locked and then continues on to the scan function.
Last, we have the loop that runs the actual scan, i2c_scan(). Because I2C typically refers to addresses in hex form, we've included this bit of code that formats the results into hex format: [hex(device_address) for device_address in i2c.scan()].
Open the serial console to see the results! The code prints out an array of addresses. We've connected the TSL2561 which has a 7-bit I2C address of 0x39. The result for this sensor is I2C addresses found: ['0x39']. If no addresses are returned, refer back to the wiring diagrams to make sure you've wired up your sensor correctly.

I2C Sensor Data

Now we know for certain that our sensor is connected and ready to go. Let's find out how to get the data from our sensor!
Copy and paste the code into code.py using your favorite editor, and save the file.
  1. # CircuitPython Demo - I2C sensor
  2.  
  3. import time
  4.  
  5. import adafruit_tsl2561
  6. import board
  7. import busio
  8.  
  9. i2c = busio.I2C(board.SCL, board.SDA)
  10.  
  11. # Lock the I2C device before we try to scan
  12. while not i2c.try_lock():
  13. pass
  14. # Print the addresses found once
  15. print("I2C addresses found:", [hex(device_address)
  16. for device_address in i2c.scan()])
  17.  
  18. # Unlock I2C now that we're done scanning.
  19. i2c.unlock()
  20.  
  21. # Create library object on our I2C port
  22. tsl2561 = adafruit_tsl2561.TSL2561(i2c)
  23.  
  24. # Use the object to print the sensor readings
  25. while True:
  26. print("Lux:", tsl2561.lux)
  27. time.sleep(1.0)
This code begins the same way as the scan code. We've included the scan code so you have verification that your sensor is wired up correctly and is detected. It prints the address once. After the scan, we unlock I2C with i2c_unlock() so we can use the sensor for data.
We create our sensor object using the sensor library. We call it tsl2561 and provide it the i2c object.
Then we have a simple loop that prints out the lux reading using the sensor object we created. We add a time.sleep(1.0), so it only prints once per second. Connect to the serial console to see the results. Try shining a light on it to see the results change!

Where's my I2C?

On the SAMD21, we have the flexibility of using a wide range of pins for I2C. Some chips, like the ESP8266 can use any pins for I2C, using bitbangio. There's some other chips that may have fixed I2C pin.
The good news is you can use many but not all pins. Given the large number of SAMD boards we have, its impossible to guarantee anything other than the labeled 'SDA' and 'SCL'. So, if you want some other setup, or multiple I2C interfaces, how will you find those pins? Easy! We've written a handy script.
All you need to do is copy this file to your board, rename it code.py, connect to the serial console and check out the output! The results print out a nice handy list of SCL and SDA pin pairs that you can use.
These are the results from an ItsyBitsy M0 Express. Your output may vary and it might be very long. For more details about I2C and SERCOMs, check out our detailed guide here.
  1. import board
  2. import busio
  3. from microcontroller import Pin
  4.  
  5. def is_hardware_I2C(scl, sda):
  6. try:
  7. p = busio.I2C(scl, sda)
  8. p.deinit()
  9. return True
  10. except ValueError:
  11. return False
  12. except RuntimeError:
  13. return True
  14.  
  15.  
  16. def get_unique_pins():
  17. exclude = ['NEOPIXEL', 'APA102_MOSI', 'APA102_SCK']
  18. pins = [pin for pin in [
  19. getattr(board, p) for p in dir(board) if p not in exclude]
  20. if isinstance(pin, Pin)]
  21. unique = []
  22. for p in pins:
  23. if p not in unique:
  24. unique.append(p)
  25. return unique
  26.  
  27.  
  28. for scl_pin in get_unique_pins():
  29. for sda_pin in get_unique_pins():
  30. if scl_pin is sda_pin:
  31. continue
  32. else:
  33. if is_hardware_I2C(scl_pin, sda_pin):
  34. print("SCL pin:", scl_pin, "\t SDA pin:", sda_pin)
  35. else:
  36. pass

CircuitPython HID Keyboard and Mouse

One of the things we baked into CircuitPython is 'HID' (Human Interface Device) control - that means keyboard and mouse capabilities. This means your CircuitPython board can act like a keyboard device and press key commands, or a mouse and have it move the mouse pointer around and press buttons. This is really handy because even if you cannot adapt your software to work with hardware, there's almost always a keyboard interface - so if you want to have a capacitive touch interface for a game, say, then keyboard emulation can often get you going really fast!
This section walks you through the code to create a keyboard or mouse emulator. First we'll go through an example that uses pins on your board to emulate keyboard input. Then, we will show you how to wire up a joystick to act as a mouse, and cover the code needed to make that happen.
You'll need the adafruit_hid library folder if you don't already have it in your /lib folder! You can get it from the CircuitPython Library Bundle. If you need help installing the library, check out the CircuitPython Libraries page.

CircuitPython Keyboard Emulator

Copy and paste the code into code.py using your favorite editor, and save the file.
  1. # CircuitPython demo - Keyboard emulator
  2.  
  3. import time
  4.  
  5. import board
  6. import digitalio
  7. from adafruit_hid.keyboard import Keyboard
  8. from adafruit_hid.keyboard_layout_us import KeyboardLayoutUS
  9. from adafruit_hid.keycode import Keycode
  10.  
  11. # A simple neat keyboard demo in CircuitPython
  12.  
  13. # The pins we'll use, each will have an internal pullup
  14. keypress_pins = [board.A1, board.A2]
  15. # Our array of key objects
  16. key_pin_array = []
  17. # The Keycode sent for each button, will be paired with a control key
  18. keys_pressed = [Keycode.A, "Hello World!\n"]
  19. control_key = Keycode.SHIFT
  20.  
  21. # The keyboard object!
  22. time.sleep(1) # Sleep for a bit to avoid a race condition on some systems
  23. keyboard = Keyboard()
  24. keyboard_layout = KeyboardLayoutUS(keyboard) # We're in the US :)
  25.  
  26. # Make all pin objects inputs with pullups
  27. for pin in keypress_pins:
  28. key_pin = digitalio.DigitalInOut(pin)
  29. key_pin.direction = digitalio.Direction.INPUT
  30. key_pin.pull = digitalio.Pull.UP
  31. key_pin_array.append(key_pin)
  32.  
  33. led = digitalio.DigitalInOut(board.D13)
  34. led.direction = digitalio.Direction.OUTPUT
  35.  
  36. print("Waiting for key pin...")
  37.  
  38. while True:
  39. # Check each pin
  40. for key_pin in key_pin_array:
  41. if not key_pin.value: # Is it grounded?
  42. i = key_pin_array.index(key_pin)
  43. print("Pin #%d is grounded." % i)
  44.  
  45. # Turn on the red LED
  46. led.value = True
  47.  
  48. while not key_pin.value:
  49. pass # Wait for it to be ungrounded!
  50. # "Type" the Keycode or string
  51. key = keys_pressed[i] # Get the corresponding Keycode or string
  52. if isinstance(key, str): # If it's a string...
  53. keyboard_layout.write(key) # ...Print the string
  54. else: # If it's not a string...
  55. keyboard.press(control_key, key) # "Press"...
  56. keyboard.release_all() # ..."Release"!
  57.  
  58. # Turn off the red LED
  59. led.value = False
  60.  
  61. time.sleep(0.01)
Connect pin A1 or A2 to ground, using a wire or alligator clip, then disconnect it to send the key press "A" or the string "Hello world!"

circuitpython_CirucitPythonHIDTrinketA1A2Ground_bb.jpg
This wiring example shows A1 and A2 connected to ground.

Remember, on Trinket, A1 and A2 are labeled 2 and 0! On other boards, you will have A1 and A2 labeled as expected.

Create the Objects and Variables

First, we assign some variables for later use. We create three arrays assigned to variables: keypress_pins, key_pin_array, and keys_pressed. The first is the pins we're going to use. The second is empty because we're going to fill it later. The third is what we would like our "keyboard" to output - in this case the letter "A" and the phrase, "Hello world!". We create our last variable assigned to control_key which allows us to later apply the shift key to our keypress. We'll be using two keypresses, but you can have up to six keypresses at once.
Next keyboard and keyboard_layout objects are created. We only have US right now (if you make other layouts please submit a GitHub pull request!). The time.sleep(1) avoids an error that can happen if the program gets run as soon as the board gets plugged in, before the host computer finishes connecting to the board.
Then we take the pins we chose above, and create the pin objects, set the direction and give them each a pullup. Then we apply the pin objects to key_pin_array so we can use them later.
Next we set up the little red LED to so we can use it as a status light.
The last thing we do before we start our loop is print, "Waiting for key pin..." so you know the code is ready and waiting!

The Main Loop

Inside the loop, we check each pin to see if the state has changed, i.e. you connected the pin to ground. Once it changes, it prints, "Pin # grounded." to let you know the ground state has been detected. Then we turn on the red LED. The code waits for the state to change again, i.e. it waits for you to unground the pin by disconnecting the wire attached to the pin from ground.
Then the code gets the corresponding keys pressed from our array. If you grounded and ungrounded A1, the code retrieves the keypress a, if you grounded and ungrounded A2, the code retrieves the string, "Hello world!"
If the code finds that it's retrieved a string, it prints the string, using the keyboard_layout to determine the keypresses. Otherwise, the code prints the keypress from the control_key and the keypress "a", which result in "A". Then it calls keyboard.release_all(). You always want to call this soon after a keypress or you'll end up with a stuck key which is really annoying!
Instead of using a wire to ground the pins, you can try wiring up buttons like we did in CircuitPython Digital In & Out. Try altering the code to add more pins for more keypress options!

CircuitPython Mouse Emulator

Copy and paste the code into code.py using your favorite editor, and save the file.
  1. import time
  2.  
  3. import analogio
  4. import board
  5. import digitalio
  6. from adafruit_hid.mouse import Mouse
  7.  
  8. mouse = Mouse()
  9.  
  10. x_axis = analogio.AnalogIn(board.A0)
  11. y_axis = analogio.AnalogIn(board.A1)
  12. select = digitalio.DigitalInOut(board.A2)
  13. select.direction = digitalio.Direction.INPUT
  14. select.pull = digitalio.Pull.UP
  15.  
  16. pot_min = 0.00
  17. pot_max = 3.29
  18. step = (pot_max - pot_min) / 20.0
  19.  
  20.  
  21. def get_voltage(pin):
  22. return (pin.value * 3.3) / 65536
  23.  
  24.  
  25. def steps(axis):
  26. """ Maps the potentiometer voltage range to 0-20 """
  27. return round((axis - pot_min) / step)
  28.  
  29.  
  30. while True:
  31. x = get_voltage(x_axis)
  32. y = get_voltage(y_axis)
  33.  
  34. if select.value is False:
  35. mouse.click(Mouse.LEFT_BUTTON)
  36. time.sleep(0.2) # Debounce delay
  37.  
  38. if steps(x) > 11.0:
  39. # print(steps(x))
  40. mouse.move(x=1)
  41. if steps(x) < 9.0:
  42. # print(steps(x))
  43. mouse.move(x=-1)
  44.  
  45. if steps(x) > 19.0:
  46. # print(steps(x))
  47. mouse.move(x=8)
  48. if steps(x) < 1.0:
  49. # print(steps(x))
  50. mouse.move(x=-8)
  51.  
  52. if steps(y) > 11.0:
  53. # print(steps(y))
  54. mouse.move(y=-1)
  55. if steps(y) < 9.0:
  56. # print(steps(y))
  57. mouse.move(y=1)
  58.  
  59. if steps(y) > 19.0:
  60. # print(steps(y))
  61. mouse.move(y=-8)
  62. if steps(y) < 1.0:
  63. # print(steps(y))
  64. mouse.move(y=8)
For this example, we've wired up a 2-axis thumb joystick with a select button. We use this to emulate the mouse movement and the mouse left-button click. To wire up this joytick:
  • Connect VCC on the joystick to the 3V on your board. Connect ground to ground.
  • Connect Xout on the joystick to pin A0 on your board.
  • Connect Yout on the joystick to pin A1 on your board.
  • Connect Sel on the joystick to pin A2 on your board.
Remember, Trinket's pins are labeled differently. Check the Trinket Pinouts page to verify your wiring.

To use this demo, simply move the joystick around. The mouse will move slowly if you move the joystick a little off center, and more quickly if you move it as far as it goes. Press down on the joystick to click the mouse. Awesome! Now let's take a look at the code.

Create the Objects and Variables

First we create the mouse object.
Next, we set x_axis and y_axis to pins A0 and A1. Then we set select to A2, set it as input and give it a pullup.
The x and y axis on the joystick act like 2 potentiometers. We'll be using them just like we did in CircuitPython Analog In. We set pot_min and pot_max to be the minimum and maximum voltage read from the potentiometers. We assign step = (pot_max - pot_min) / 20.0 to use in a helper function.

CircuitPython HID Mouse Helpers

First we have the get_voltage() helper so we can get the correct readings from the potentiometers. Look familiar? We learned about it in Analog In.
Second, we have steps(axis). To use it, you provide it with the axis you're reading. This is where we're going to use the step variable we assigned earlier. The potentiometer range is 0-3.29. This is a small range. It's even smaller with the joystick because the joystick sits at the center of this range, 1.66, and the + and - of each axis is above and below this number. Since we need to have thresholds in our code, we're going to map that range of 0-3.29 to while numbers between 0-20.0 using this helper function. That way we can simplify our code and use larger ranges for our thresholds instead of trying to figure out tiny decimal number changes.

Main Loop

First we assign x and y to read the voltages from x_axis and y_axis.
Next, we check to see when the state of the select button is False. It defaults to True when it is not pressed, so if the state is False, the button has been pressed. When it's pressed, it sends the command to click the left mouse button. The time.sleep(0.2) prevents it from reading multiple clicks when you've only clicked once.
Then we use the steps() function to set our mouse movement. There are two sets of two if statements for each axis. Remember that 10 is the center step, as we've mapped the range 0-20. The first set for each axis says if the joystick moves 1 step off center (left or right for the x axis and up or down for the y axis), to move the mouse the appropriate direction by 1 unit. The second set for each axis says if the joystick is moved to the lowest or highest step for each axis, to move the mouse the appropriate direction by 8 units. That way you have the option to move the mouse slowly or quickly!
To see what step the joystick is at when you're moving it, uncomment the print statements by removing the from the lines that look like # print(steps(x)), and connecting to the serial console to see the output. Consider only uncommenting one set at a time, or you end up with a huge amount of information scrolling very quickly, which can be difficult to read!
For more detail check out the documentation at https://circuitpython.readthedocs.io/projects/hid/en/latest/

CircuitPython Storage

CircuitPython boards show up as as USB drive, allowing you to edit code directly on the board. You've been doing this for a while. By now, maybe you've wondered, "Can I write data from CircuitPython to the storage drive to act as a datalogger?" The answer is yes!
However, it is a little tricky. You need to add some special code to boot.py, not just code.py. That's because you have to set the filesystem to be read-only when you need to edit code to the disk from your computer, and set it to writeable when you want the CircuitPython core to be able to write.
You can only have either your computer edit the CIRCUITPY drive files, or CircuitPython. You cannot have both write to the drive at the same time. (Bad Things Will Happen so we do not allow you to do it!)
The following is your new boot.py. Copy and paste the code into boot.py using your favorite editor. You may need to create a new file.
  1. import board
  2. import digitalio
  3. import storage
  4.  
  5. # For Gemma M0, Trinket M0, Metro M0/M4 Express, ItsyBitsy M0/M4 Express
  6. switch = digitalio.DigitalInOut(board.D2)
  7. # switch = digitalio.DigitalInOut(board.D5) # For Feather M0/M4 Express
  8. # switch = digitalio.DigitalInOut(board.D7) # For Circuit Playground Express
  9. switch.direction = digitalio.Direction.INPUT
  10. switch.pull = digitalio.Pull.UP
  11.  
  12. # If the switch pin is connected to ground CircuitPython can write to the drive
  13. storage.remount("/", switch.value)
For Gemma M0, Trinket M0, Metro M0 Express, Metro M4 Express, ItsyBitsy M0 Express and ItsyBitsy M4 Express, no changes to the initial code are needed.
For Feather M0 Express and Feather M4 Express, comment out switch = digitalio.DigitalInOut(board.D2), and uncomment switch = digitalio.DigitalInOut(board.D5).
For Circuit Playground Express, comment out switch = digitalio.DigitalInOut(board.D2), and uncomment switch = digitalio.DigitalInOut(board.D7).
Remember: To "comment out" a line, put a # and a space before it. To "uncomment" a line, remove the # + space from the beginning of the line.
The following is your new code.py. Copy and paste the code into code.py using your favorite editor.
  1. import time
  2.  
  3. import board
  4. import digitalio
  5. import microcontroller
  6.  
  7. led = digitalio.DigitalInOut(board.D13)
  8. led.switch_to_output()
  9.  
  10. try:
  11. with open("/temperature.txt", "a") as fp:
  12. while True:
  13. temp = microcontroller.cpu.temperature
  14. # do the C-to-F conversion here if you would like
  15. fp.write('{0:f}\n'.format(temp))
  16. fp.flush()
  17. led.value = not led.value
  18. time.sleep(1)
  19. except OSError as e:
  20. delay = 0.5
  21. if e.args[0] == 28:
  22. delay = 0.25
  23. while True:
  24. led.value = not led.value
  25. time.sleep(delay)

Logging the Temperature

The way boot.py works is by checking to see if the pin you specified in the switch setup in your code is connected to a ground pin. If it is, it changes the read-write state of the file system, so the CircuitPython core can begin logging the temperature to the board.
For help finding the correct pins, see the wiring diagrams and information in the Find the Pins section of the CircuitPython Digital In & Out guide. Instead of wiring up a switch, however, you'll be connecting the pin directly to ground with alligator clips or jumper wires.
boot.py only runs on first boot of the device, not if you re-load the serial console with ctrl+D or if you save a file. You must EJECT the USB drive, then physically press the reset button!
Once you copied the files to your board, eject it and unplug it from your computer. If you're using your Circuit Playground Express, all you have to do is make sure the switch is to the right. Otherwise, use alligator clips or jumper wires to connect the chosen pin to ground. Then, plug your board back into your computer.
You will not be able to edit code on your CIRCUITPY drive anymore!
The red LED should blink once a second and you will see a new temperature.txt file on CIRCUITPY.
This file gets updated once per second, but you won't see data come in live. Instead, when you're ready to grab the data, eject and unplug your board. For CPX, move the switch to the left, otherwise remove the wire connecting the pin to ground. Now it will be possible for you to write to the filesystem from your computer again, but it will not be logging data.
We have a more detailed guide on this project available here: CPU Temperature Logging with CircuitPython. If you'd like more details, check it out!

CircuitPython CPU Temp

There is a CPU temperature sensor built into every ATSAMD21 chip. CircuitPython makes it really simple to read the data from this sensor. This works on the M0, M0 Express and Circuit Playground Express boards, because it's built into the microcontroller used for these boards. It does not work on the ESP8266 as this uses a different chip.
The data is read using two simple commands. We're going to enter them in the REPL. Plug in your board, connect to the serial console, and enter the REPL. Then, enter the following commands into the REPL:
  1. import microcontroller
  2. microcontroller.cpu.temperature
That's it! You've printed the temperature in Celsius to the REPL. Note that it's not exactly the ambient temperature and it's not super precise. But it's close!
If you'd like to print it out in Fahrenheit, use this simple formula: Celsius * (9/5) + 32. It's super easy to do math using CircuitPython. Check it out!

CircuitPython Expectations

Switching Between CircuitPython and Arduino

Many of the CircuitPython boards also run Arduino. But how do you switch between the two? Switching between CircuitPython and Arduino is easy.
If you're currently running Arduino and would like to start using CircuitPython, follow the steps found in Welcome to CircuitPython: Installing CircuitPython.
If you're currently running CircuitPython and would like to start using Arduino, plug in your board, and then load your Arduino sketch. If there are any issues, you can double tap the reset button to get into the bootloader and then try loading your sketch. Always backup any files you're using with CircuitPython that you want to save as they could be deleted.
That's it! It's super simple to switch between the two.

The Difference Between Express And Non-Express Boards

We often reference "Express" and "Non-Express" boards when discussing CircuitPython. What does this mean?
Express refers to the inclusion of an extra 2MB flash chip on the board that provides you with extra space for CircuitPython and your code. This means that we're able to include more functionality in CircuitPython and you're able to do more with your code on an Express board than you would on a non-Express board.
Express boards include Circuit Playground Express, ItsyBitsy M0 Express, Feather M0 Express, Metro M0 Express and Metro M4 Express.
Non-Express boards include Trinket M0, Gemma M0, Feather M0 Basic, and other non-Express Feather M0 variants.

Non-Express Boards: Gemma and Trinket

CircuitPython runs nicely on the Gemma M0 or Trinket M0 but there are some constraints

Small Disk Space

Since we use the internal flash for disk, and that's shared with runtime code, its limited! Only about 50KB of space.

No Audio or NVM

Part of giving up that FLASH for disk means we couldn't fit everything in. There is, at this time, no support for hardware audio playpack or NVM 'eeprom'. Modules audioio and bitbangio are not included. For that support, check out the Circuit Playground Express or other Express boards.
However, I2C, UART, capacitive touch, NeoPixel, DotStar, PWM, analog in and out, digital IO, logging storage, and HID do work! Check the CircuitPython Essentials for examples of all of these.

Differences Between CircuitPython and MicroPython

For the differences between CircuitPython and MicroPython, check out the CircuitPython documentation.

Differences Between CircuitPython and Python

Python (also known as CPython) is the language that MicroPython and CircuitPython are based on. There are many similarities, but there are also many differences. This is a list of a few of the differences.

Python Libraries

Python is advertised as having "batteries included", meaning that many standard libraries are included. Unfortunately, for space reasons, many Python libraries are not available. So for instance while we wish you could import numpy, numpy isn't available. So you may have to port some code over yourself!

Integers in CircuitPython

On the non-Express boards, integers can only be up to 31 bits long. Integers of unlimited size are not supported. The largest positive integer that can be represented is 230-1, 1073741823, and the most negative integer possible is -230, -1073741824.
As of CircuitPython 3.0, Express boards have arbitrarily long integers as in Python.

Floating Point Numbers and Digits of Precision for Floats in CircuitPython

Floating point numbers are single precision in CircuitPython (not double precision as in Python). The largest floating point magnitude that can be represented is about +/-3.4e38. The smallest magnitude that can be represented with full accuracy is about +/-1.7e-38, though numbers as small as +/-5.6e-45 can be represented with reduced accuracy.
CircuitPython's floats have 8 bits of exponent and 22 bits of mantissa (not 24 like regular single precision floating point), which is about five or six decimal digits of precision.

Differences between MicroPython and Python

For a more detailed list of the differences between CircuitPython and Python, you can look at the MicroPython documentation. We keep up with MicroPython stable releases, so check out the core 'differences' they document here.

Frequently Asked Questions

These are some of the common questions regarding CircuitPython and CircuitPython microcontrollers.

What is a MemoryError?

Memory allocation errors happen when you're trying to store too much on the board. The CircuitPython microcontroller boards have a limited amount of memory available. You can have about 250 lines of code on the M0 Express boards. If you try to import too many libraries, a combination of large libraries, or run a program with too many lines of code, your code will fail to run and you will receive a MemoryError in the serial console (REPL).

What do I do when I encounter a MemoryError?

Try resetting your board. Each time you reset the board, it reallocates the memory. While this is unlikely to resolve your issue, it's a simple step and is worth trying.
Make sure you are using .mpy versions of libraries. All of the CircuitPython libraries are available in the bundle in a .mpy format which takes up less memory than .py format. Be sure that you're using the latest library bundle for your version of CircuitPython.
If that does not resolve your issue, try shortening your code. Shorten comments, remove extraneous or unneeded code, or any other clean up you can do to shorten your code. If you're using a lot of functions, you could try moving those into a separate library, creating a .mpy of that library, and importing it into your code.
You can turn your entire file into a .mpy and import that into code.py. This means you will be unable to edit your code live on the board, but it can save you space.

How can I create my own .mpy files?

You can make your own .mpy versions of files with mpy-cross.
You can download the CircuitPython 2.x version of mpy-cross for your operating system from the CircuitPython Releases page under the latest 2.x version.
You can build mpy-cross for CircuitPython 3.x by cloning the CircuitPython GitHub repo, and running make in the circuitpython/mpy-cross/ directory. Then run ./mpy-cross path/to/foo.py to create a foo.mpy in the same directory as the original file.

How do I check how much memory I have free?

import gc
gc.mem_free()
Will give you the number of bytes available for use.

Does CircuitPython support interrupts?

No. CircuitPython does not currently support interrupts. We do not have an estimated time for when they will be included.

Does CircuitPython support ESP32?

No. We are not currently developing for it. It will be pulled from MicroPython when development there for it is complete. We do not have an estimated time for when that will happen.

Does Feather M0 support WINC1500?

No, WINC1500 will not fit into the M0 flash space.

No comments:

Post a Comment