# Adafruit Metro ESP32-S3
## Overview
What's Metro-shaped and has an ESP32-S3 WiFi module? What has a STEMMA QT connector for I2C devices and a Lipoly charger circuit? What has your favorite Espressif WiFi microcontroller and lots of memory for your next IoT project?
That's right - it's the new **Adafruit Metro ESP32-_S3_**! With native USB and a load of PSRAM, this board is perfect for use with CircuitPython or Arduino to add low-cost WiFi while retaining shield compatibility.
**As of Nov 8, 2023** - We've fixed this hardware to be revision B which has changed the NeoPixel pin and the SPI/SD card pins to no longer use the same pins as the octal PSRAM. This means that the hardware now works correctly when PSRAM is activated! If you have a rev A hardware board, contact support to get a replacement rev B.
Warning:
The Metro ESP32-S3 has a dual-core 240 MHz chip, so it is comparable to ESP32's dual-core. However, there is no Bluetooth **Classic ** support, only Bluetooth LE. This chip is a great step up from the earlier ESP32-S2! This ESP32-S3 mini-module we are using on the Metro comes with massive 16 MB flash and 8 MB PSRAM, as well as 512KB of SRAM, so it's perfect for use with CircuitPython support or any time massive buffers are needed: for fast memory access use SRAM, for slower-but-roomier access use PSRAM. It's also great for use in ESP-IDF or with Arduino support.
The ESP32-S3 is a highly-integrated, low-power, 2.4 GHz Wi-Fi/BLE System-on-Chip (SoC) solution that has built-in native USB as well as some other interesting new technologies like Time of Flight distance measurements and AI acceleration. With its state-of-the-art power and RF performance, this SoC is an ideal choice for a wide variety of application scenarios relating to the [Internet of Things (IoT)](https://www.adafruit.com/category/342), [wearable electronics](https://www.adafruit.com/category/65), and smart homes.
**Features:**
- **ESP32-S3 Dual Core 240MHz Tensilica processor ** - the next generation of ESP32-Sx, with native USB so it can act like a keyboard/mouse, MIDI device, disk drive, etc.!
- **Mini module** has FCC/CE certification and comes with 16 MByte of Flash, 8 MByte PSRAM
- **Power options** - USB type C **or** Lipoly battery
- **Built-in battery charging** when powered over USB-C
- **LiPoly battery monitor** - MAX17048 chip actively monitors your battery for voltage and state of charge / percentage reporting over I2C
- **Reset and DFU** (BOOT0) buttons to get into the ROM bootloader (which is a USB serial port so you don't need a separate cable!)
- **JTAG 2x5 Header** for more intense debugging
- **Serial debug output pins** (optional, for checking the hardware serial debug console)
- **STEMMA QT** connector for I2C devices, with switchable power, so you can go into low power mode
- **On/Charge/User** LEDs + status **NeoPixel ** with pin-controlled power for low power usage
- **Low Power friendly**! In deep sleep mode we can get down to approximately 100uA of current draw from the Lipoly connection. Quiescent current is from the power regulator, ESP32-S3 chip, and Lipoly monitor. Turn off the NeoPixel and external I2C power for the lowest quiescent current draw.
- **Works with ESP-IDF, Arduino** **or CircuitPython **
# Adafruit Metro ESP32-S3
## Pinouts
Warning:
The Metro ESP32-S3 is packed with features. It's time to take a tour!
PrettyPins PDF [on GitHub](https://github.com/adafruit/Adafruit-Metro-ESP32-S3-PCB/blob/main/Adafruit%20Metro%20ESP32-S3%20Pinout.pdf).
# Power
There's a lot of power options available on the Metro ESP32-S3, and they're a little different than most Metro/Arduinos.
## Power Inputs
You have **three power input options:**
- **USB C port** - This is used for both powering and programming the board. You can power it with any USB C cable and will request 5V from a USB C PD.
When USB is plugged in it will charge the Lipoly battery. If there is no battery attached, the yellow LED will flicker (it's looking for a battery!)
- **DC barrel jack** - The DC Jack is a 5.5mm/2.1mm center-positive DC connector, which is the most common available. Provide about 6V-12V here to power the Metro. Great for when you have a wall adapter power supply. Don't use a center-negative adapter, it won't work (the on green LED will not light)
When DC power is plugged in it will charge the Lipoly battery. If there is no battery attached, the yellow LED will flicker (it's looking for a battery!)
If both DC and USB are plugged in, the metro will power itself & recharge the battery from whichever input is highest.
- **LiPoly connector/charger** - You can plug in any 250mAh or larger 3.7/4.2V Lipoly battery into this **JST 2-PH port** to both power your Metro and charge the battery. The battery will charge from the USB or DC power (whichever is plugged in and higher voltage), even if the board is powered off via the switch.
If the battery is plugged in _and USB or DC is plugged in_, the Metro will power itself from USB or DC _and_ it will charge the battery up.
When the battery is charging, the yellow CHG LED will be lit. When charging is complete, the LED will turn off.
## Power Control
- **On/Off switch** - This switch controls power to the board. If you plug in your board and nothing happens, make sure the switch is flipped to "ON"!
When switched off it will disable the 3.3V power which turns off the ESP32-S3, but **it does _not_ turn off the NeoPixel or the VHI or VIN pins** (see below) and will leave the battery charging.
## Power Outputs
- **3.3** - This is the output pin from the 3.3V regulator, you can grab up to 400mA from this regulator for accessories, it's also used by the ESP32-S3 which can have spiky current draw.
- **VHI** - This pin is usually marked 5V on Arduinos, and when USB or DC is plugged in, it will in fact provide 5V. However, _if you have the Metro on LiPo battery power, it will be powered from the battery_ and thus _between 3.7V to 4.2V._
When powered from USB or DC it is regulated to 5V, when powered from battery only, it's not regulated, but it is high-current, great for driving servos and NeoPixels.
- **GND** - This is the common ground for all power and logic.
- **VIN** - This is the _higher_ of the DC jack or USB voltage. So if the DC jack is plugged in and 9V, VIN is 9V. If only USB connected, this will be 5V.
## Power Indicator LEDs
- **ON** - The small green LED next to the NeoPixel is the **ON** LED. It is lit green when the board is on.
- **CHG** - Below the battery connector is the **CHG** **LED**. While a battery is connected, is lit up amber while charging, and turns off once charging is complete. While a battery is not connected, this LED may flicker amber. This is normal! It is looking for the battery.
# ESP32-S3 WiFi Module
The **ESP32-S3** is a highly-integrated, low-power, 2.4 GHz Wi-Fi/BLE System-on-Chip (SoC) solution that has built-in native USB as well as some other interesting new technologies like Time of Flight distance measurements and AI acceleration.
With its state-of-the-art power and RF performance, this SoC is an ideal choice for a wide variety of application scenarios relating to the [Internet of Things (IoT)](https://www.adafruit.com/category/342), [wearable electronics](https://www.adafruit.com/category/65), and smart homes.
This module includes a dual-core 240 MHz Tensilica processor, so it is comparable to ESP32's dual-core. However, there is no Bluetooth _Classic_ ** ** support, only Bluetooth LE. This ESP32-S3 mini-module we are using on the Metro comes with massive **16 MB flash** and **8 MB PSRAM** , as well as lots of **512KB of SRAM** so it's perfect for use with CircuitPython support or any time massive buffers are needed: for fast memory access use SRAM, for slower-but-roomier access use PSRAM. It's also great for use in ESP-IDF or with Arduino support.
# Logic Pins
These are the logic pins that can be used to connect shields, sensors, servos, LEDs and more!
No pins are shared, and no pins are 'special' bootstrapping pins, so you can use any of them for input, or output, with pullups or pulldowns, without worry.
ESP32 chips allow for 'multiplexing' of almost all signals so it isn't like some pins can do PWM and others can. You can connect any of the available PWM channels, I2S channels, UART, I2C or SPI ports to _any_ pin. There are some exceptions....
There are six analog pins.
- **A0 thru A5** are the analog inputs. A0 thru A4 are on ADC2, and A5 is on ADC1.
The SPI pins are on the ESP32-S3 high-speed peripheral. You can set any pins to be the low-speed peripheral but you won't get the speedy interface!
- **SCK** - This is the SPI clock pin.
- **MOSI** - This is the SPI **M** icrocontroller **O** ut / **S** ensor **I** n pin.
- **MISO** - This is the SPI **M** icrocontroller **I** n / **S** ensor **O** ut pin.
The UART interface.
- **RX** - This is the UART receive pin. Connect to TX (transmit) pin on your sensor or breakout.
- **TX** - This is the UART transmit pin. Connect to RX (receive) pin on your sensor or breakout.
The digital pins.
- **D2-D13** - These are digital pins. D2-D10 are on ADC1. D11-D13 are on ADC2.
The I2C interface. This is shared by the STEMMA QT connector.
- **SCL** - This is the I2C clock pin. There is a 10k pullup on this pin.
- **SDA** - This is the I2C data pin. There is a 10k pullup on this pin.
_Check the ESP32-S3 datasheet or the PrettyPins diagram above for the ADC channel names for each pin if you need them!_
# MAX17048 Battery Monitor
The **MAX17048 LiPoly Battery** **Monitor** , located below the 3.7V Lipoly label on the board silk, reports the voltage and charge percent over I2C. Connect it to your [Lipoly or LiIon battery](https://www.adafruit.com/category/916) and it will let you know the voltage of the cell, and it does the annoying math of decoding the non-linear voltage to get you a valid percentage as well!
The battery monitor is available over I2C on address **0x36**.
Our [Arduino](https://github.com/adafruit/Adafruit_MAX1704x) or [CircuitPython/Python](https://github.com/adafruit/Adafruit_CircuitPython_MAX1704x) library code allows you to to set the pack size (mAh of the battery, this helps tune the calculation) and read the voltage and percentage whenever you like. There is no pin on the Metro ESP32-S3 that returns battery voltage, but this I2C monitor makes it super simple to get that data!
# MicroSD Slot
The Metro ESP32-S3 comes with a MicroSD card slot. It is wired up for SPI interfacing.
To access the SD card, use the following pins:
- **SCK/GPIO39** - This is the SPI clock pin.
- **MOSI/GPIO42** - This is the SPI **M** icrocontroller **O** ut / **S** ensor **I** n pin.
- **MISO/GPIO21** - This is the SPI **M** icrocontroller **I** n / **S** ensor **O** ut pin.
- **SD\_CS/GPIO45** - This is the chip select pin.
# NeoPixel and Red LED
The Metro ESP32-S3 has two user-controllable LEDs.
- **NeoPixel** - Next to the JTAG port is an addressable **RGB NeoPixel LED** labeled Neo on the board silk. This is controllable in CircuitPython and Arduino using the NeoPixel libraries, and is also used as a status LED in CircuitPython. You can access it with `board.NEOPIXEL` in CircuitPython, and `PIN_NEOPIXEL` in Arduino.
- **L LED** - To the right of the on LED is the little **red LED** labeled L on the board silk. It is available for blinky goodness, as well as showing status such as pulsing while in the UF2 bootloader. You can access this LED with `board.LED` in CircuitPython, and `LED_BUILTIN` in Arduino.
# NeoPixel Power Jumper
On the back of the board, you'll find the **NeoPixel power jumper** , labeled Neo Pwr on the board silk.
Simply "turning off" the NeoPixel LED does not halt power being sent to it. Therefore, for low-power applications, you may wish to cut this jumper to cut off the power to the LED.
To reverse the process, simply solder the jumper closed again.
# STEMMA QT Connector
On the top-left corner of the Metro is the **JST SH 4-pin [STEMMA QT](https://learn.adafruit.com/introducing-adafruit-stemma-qt) connector**, labeled QT I2C on the board silk. It breaks out I2C (SCL, SDA, 3.3V, GND).
It is accessible in CircuitPython as `board.STEMMA_I2C()`, and in Arduino using `SCL`/`GPIO48` and `SDA`/`GPIO47`.
This connector allows you to connect to [various breakouts and sensors with **STEMMA QT** connectors](https://www.adafruit.com/category/1018) or to other things using [assorted associated accessories](https://www.adafruit.com/?q=JST%20SH%204). It works great with any STEMMA QT or Qwiic sensor/device. You can also use it with Grove I2C devices thanks to [this handy cable](https://www.adafruit.com/product/4528).
# Buttons and RST Pins
There are two buttons on the Metro ESP32-S3: reset and boot.
- **Reset** - The **Reset button** , located in the top-left corner of the board and labeled Reset on the board silk, is used to reset the board and enter the UF2 bootloader.
- **Boot** - The **Boot button** , located next to the Metro label and labeled Boot on the board silk, is used to enter the ROM bootloader.
- **RST** - There are two **RST** **pins**. The first is located on the bottom row of pins. The second is in the lower-left corner of the 6-pin ICSP header. Tie a RST pin to ground to reset the board manually.
# Debug and JTAG
There are two debug options on the Metro ESP32-S3: hardware UART and JTAG.
## UART Debug
The **hardware UART debug port** has two broken out pins, labeled De-bug on the board silk. [You can connect these to a USB console cable in order to read the debug output from the ESP32 IDF](https://www.adafruit.com/product/954). This is useful if you are writing software and need to see the low level debug output without using JTAG debugging.
This is _not_ where default `Serial.print()` or CircuitPython `print()` outputs go, because those go through the USB port instead!
- **TXD0** - The pin on the left (closest to the USB connector) is the TX pin.
- **RXD0** - The pin on the right (furthest from the USB connector) is the RX pin.
## JTAG Debug
If you'd like to do more advanced development, trace-debugging, or not use the bootloader, we have the **JTAG interface** available via a 2x5 1.27mm pitch connector. A JLink or similar is needed to perform debugging.
### SEGGER J-Link EDU Mini - JTAG/SWD Debugger
[SEGGER J-Link EDU Mini - JTAG/SWD Debugger](https://www.adafruit.com/product/3571)
Doing some serious development on any ARM-based platform, and tired of 'printf' plus an LED to debug? A proper JTAG/SWD HW debugger can make debugging more of a pleasure and less of a pain. It allows you to program your devices at the click of a button, read or write memory addresses...
In Stock
[Buy Now](https://www.adafruit.com/product/3571)
[Related Guides to the Product](https://learn.adafruit.com/products/3571/guides)
# Adafruit Metro ESP32-S3
## Power Management
# Battery + USB Power
We wanted to make the Metro board easy to power both when connected to a computer as well as via battery.
There's **three ways to power** this microcontroller:
1. You can connect with a USB cable (just plug into the jack) and the board will regulate the 5V USB down to 3.3V.
2. You can also connect a 4.2/3.7V Lithium Polymer (LiPo/LiPoly) or Lithium Ion (LiIon) battery to the JST jack. This will let the board run on a rechargeable battery.
3. You can connect a 6-12V power supply to the barrel jack. It requires a 5.5mm/2.1mm center-positive DC connector, which is the most common available.
**When the USB or DC power is connected, it will automatically switch over, as well as start charging the battery (if attached). If both are connected, it will use whichever is highest.** The switchover happens "hot-swap" style so you can always keep the LiPoly connected as a "backup" power that will only get used when USB or DC power is lost.
Danger:
The above shows the USB C jack (left), the LiPoly JST jack (top right), as well as the 3.3V regulator and changeover diode (towards the center), and the LiPoly charging circuitry (around the JST jack).
There's also a **CHG** **LED** below the JST connector, which will light up amber while the battery is charging. This LED might also flicker if the battery is not connected, it's normal.
Info:
# Power Supplies
You have a lot of power supply options here!
We have the **3.3V** pin which has the output from the 3.3V regulator. We use a 500mA peak regulator. While you can get 400mA from it, you can't do it continuously from 5V as it will overheat the regulator.
There is also the **VHI** pin. This pin is usually marked 5V on Arduinos, and when USB or DC is plugged in, it will in fact provide 5V. However, _if you have the Metro on LiPo battery power, it will be powered from the battery_ and thus _between 3.7V to 4.2V ._ When powered from USB or DC it is regulated to 5V, when powered from battery only, it's not regulated, but it is high-current, great for driving servos and NeoPixels.
The **VIN** pin is the _higher_ of the DC jack or USB voltage. So if the DC jack is plugged in and 9V, VIN is 9V. If only USB connected, this will be 5V.
# Measuring Battery
If you're running off of a battery, chances are you wanna know what the voltage is at! That way you can tell when the battery needs recharging. LiPoly batteries are 'maxed out' at 4.2V and stick around 3.7V for much of the battery life, then slowly sink down to 3.2V or so before the protection circuitry cuts it off. By measuring the voltage you can quickly tell when you're heading below 3.7V.
The Metro ESP32-S3 comes with a MAX17048 I2C battery monitor build right in. You can connect to it and read the battery info.
To read the battery data in CircuitPython, run the following program, and connect to the serial console.
https://github.com/adafruit/Adafruit_CircuitPython_MAX1704x/blob/main/examples/max1704x_simpletest.py
To read the battery data in Arduino, upload the following sketch, and open the serial monitor.
https://github.com/adafruit/Adafruit_MAX1704X/blob/main/examples/MAX17048_basic/MAX17048_basic.ino
For more details, check out the [main guide](https://learn.adafruit.com/admin/guides/3652/editor/24844).
# Power Notes
The three primary ways for powering the Metro are a 3.7/4.2V LiPo battery plugged into the JST port_, _6-12V DC power, or a USB power cable.
If you want a mobile option for your Metro, where you don't want a LiPoly, [use a USB battery pack!](https://www.adafruit.com/product/1959)
Here's what you cannot do:
- **Do not use alkaline or NiMH batteries** and connect to the battery port - this will destroy the LiPoly charger and there's no way to disable the charger.
- **Do not use 7.4V RC batteries on the battery port** - this will destroy the board.
# Adafruit Metro ESP32-S3
## Low Power Usage
This microcontroller board can be used for low power usage thanks to the ESP32's multiple sleep modes.
There are three basic operating states to Espressif chips: normal, light sleep and deep sleep.
**Normal power** usage is as you expect: you can use the chip and run code as you like - connecting to WiFi, reading sensors, etc.
**Light sleep** is sort of a 'hibernation' - power usage is minimal and WiFi is disconnected, but the internal clock and memory is kept. That means you can wake up where you left off, in the middle of the code as desired. You'll still need to re-initialize any external hardware that got disconnected, and WiFi, but it's often faster than waking from a deep sleep
**Deep sleep** is the lowest power but the tradeoff is that all memory and state is lost - the only thing that's running is the real time clock that can wake the chip up. When woken up, the chip starts as if it was physically reset - from the beginning of the code. This can be beneficial if you want to have a fresh start each time
A _rough_ guideline is:
- Normal power: 100mA+ can be as much power as need and spike during WiFi connection
- Light sleep: 2mA assuming all external hardware is de-powered
- Deep sleep: 100uA assuming all external hardware is de-powered
There is a **NeoPixel power jumper** on the back of the board, labeled Neo Pwr. Left intact, the board will continue to power the NeoPixel even if you "turn it off". If you need super low power, cut the trace on this jumper. The differences are shown below.
Here's a generic sketch we use for all our boards that has a macro-defined section for enabling and disabling all external powered elements. For example, if there's a power pin for NeoPixels, I2C port, TFT, etc...we turn that off before going into light or deep sleep! This will minimize power usage
Warning:
https://github.com/adafruit/Adafruit_Learning_System_Guides/blob/main/Adafruit_ESP32_Arduino_Demos/ESP32_sleeptest/ESP32_sleeptest.ino
The best way to really test power draw is with a specialty power meter such as the Nordic PPK 2
### Nordic nRF-PPK2 - Power Profiler Kit II
[Nordic nRF-PPK2 - Power Profiler Kit II](https://www.adafruit.com/product/5048)
The **Power Profiler Kit II** is a standalone unit, which can measure and optionally supply currents all the way from sub-uA and as high as 1A on all Nordic DKs, in addition to external hardware. [As we've featured on...](https://www.youtube.com/watch?v=60q8QCiYhjc)
In Stock
[Buy Now](https://www.adafruit.com/product/5048)
[Related Guides to the Product](https://learn.adafruit.com/products/5048/guides)
When running the above code and monitoring with a PPK, you'll get a graph like this:
The big pulse is normal mode, you can see the ESP32 booting up, loading code, and then pausing 1 second. Then there's a big drop for one sec to light sleep, and finally one more 1 second pause at deep sleep.
## Including NeoPixel Power
When the board is powered, it draws a bit over 40mA.
When the board is in light sleep, it draws around 2mA.
When the board is in deep sleep, it draws less than 500uA.
## Without NeoPixel Power
The following shows the power draws when the trace is cut on the Neo Pwr jumper on the back of the board. As you can see, you can save a small amount of power by cutting the trace.
Powered without the Neopixel powered it draws less than 40mA.
In light sleep, without the NeoPixel powered, it draws around 2mA.
In deep sleep, without the NeoPixel powered, it draws around 150uA.
# Adafruit Metro ESP32-S3
## CircuitPython
[CircuitPython](https://github.com/adafruit/circuitpython) is a derivative of [MicroPython](https://micropython.org) designed to simplify experimentation and education on low-cost microcontrollers. It makes it easier than ever to get prototyping by requiring no upfront desktop software downloads. Simply copy and edit files on the **CIRCUITPY** drive to iterate.
## CircuitPython Quickstart
Follow this step-by-step to quickly get CircuitPython running on your board.
[Download the latest version of CircuitPython for this board via circuitpython.org](https://circuitpython.org/board/adafruit_metro_esp32s3/)
**Click the link above to download the latest CircuitPython UF2 file.**
Save it wherever is convenient for you.
Plug your board into your computer, using a known-good data-sync cable, directly, or via an adapter if needed.
Double-click the **reset** button (highlighted in red above), and you will see the **RGB status LED(s)** turn green (highlighted in green above). If you see red, try another port, or if you're using an adapter or hub, try without the hub, or different adapter or hub.
For this board, tap reset and wait for the LED to turn purple, and as soon as it turns purple, tap reset again. The second tap needs to happen while the LED is still purple.
If double-clicking doesn't work the first time, try again. Sometimes it can take a few tries to get the rhythm right!
A lot of people end up using charge-only USB cables and it is very frustrating! **Make sure you have a USB cable you know is good for data sync.**
You will see a new disk drive appear called **METROS3BOOT**.
Drag the **adafruit\_circuitpython\_etc.uf2** file to **METROS3BOOT**.
The **BOOT** drive will disappear and a new disk drive called **CIRCUITPY** will appear.
That's it!
# Adafruit Metro ESP32-S3
## The CIRCUITPY Drive
When CircuitPython finishes installing, or you plug a CircuitPython board into your computer with CircuitPython already installed, the board shows up on your computer as a USB drive called **CIRCUITPY**.
The **CIRCUITPY** drive is where your code and the necessary libraries and files will live. You can edit your code directly on this drive and when you save, it will run automatically. When you create and edit code, you'll save your code in a **code.py** file located on the **CIRCUITPY** drive. If you're following along with a Learn guide, you can paste the contents of the tutorial example into **code.py** on the **CIRCUITPY** drive and save it to run the example.
With a fresh CircuitPython install, on your **CIRCUITPY** drive, you'll find a **code.py** file containing `print("Hello World!")` and an empty **lib** folder. If your **CIRCUITPY** drive does not contain a **code.py** file, you can easily create one and save it to the drive. CircuitPython looks for **code.py** and executes the code within the file automatically when the board starts up or resets. Following a change to the contents of **CIRCUITPY** , such as making a change to the **code.py** file, the board will reset, and the code will be run. You do not need to manually run the code. This is what makes it so easy to get started with your project and update your code!
Note that all changes to the contents of **CIRCUITPY** , such as saving a new file, renaming a current file, or deleting an existing file will trigger a reset of the board.
## Boards Without CIRCUITPY
CircuitPython is available for some microcontrollers that do not support native USB. Those boards cannot present a **CIRCUITPY** drive. This includes boards using ESP32 or ESP32-C3 microcontrollers.
On these boards, there are alternative ways to transfer and edit files. You can use the [Thonny editor](https://thonny.org), which uses hidden commands sent to the REPL to read and write files. Or you can use the CircuitPython web workflow, introduced in Circuitpython 8. The web workflow provides browser-based WiFi access to the CircuitPython filesystem. These guides will help you with the web workflow:
- [CircuitPython on ESP32 Quick Start](https://learn.adafruit.com/circuitpython-with-esp32-quick-start)
- [CircuitPython Web Workflow Code Editor Quick Start](https://learn.adafruit.com/getting-started-with-web-workflow-using-the-code-editor)
# Adafruit Metro ESP32-S3
## CircuitPython Pins and Modules
CircuitPython is designed to run on microcontrollers and allows you to interface with all kinds of sensors, inputs and other hardware peripherals. There are tons of guides showing how to wire up a circuit, and use CircuitPython to, for example, read data from a sensor, or detect a button press. Most CircuitPython code includes hardware setup which requires various modules, such as `board` or `digitalio`. You import these modules and then use them in your code. How does CircuitPython know to look for hardware in the specific place you connected it, and where do these modules come from?
This page explains both. You'll learn how CircuitPython finds the pins on your microcontroller board, including how to find the available pins for your board and what each pin is named. You'll also learn about the modules built into CircuitPython, including how to find all the modules available for your board.
# CircuitPython Pins
When using hardware peripherals with a CircuitPython compatible microcontroller, you'll almost certainly be utilising pins. This section will cover how to access your board's pins using CircuitPython, how to discover what pins and board-specific objects are available in CircuitPython for your board, how to use the board-specific objects, and how to determine all available pin names for a given pin on your board.
## `import board`
When you're using any kind of hardware peripherals wired up to your microcontroller board, the import list in your code will include `import board`. The `board` module is built into CircuitPython, and is used to provide access to a series of board-specific objects, including pins. Take a look at your microcontroller board. You'll notice that next to the pins are pin labels. You can always access a pin by its pin label. However, there are almost always multiple names for a given pin.
To see all the available board-specific objects and pins for your board, enter the REPL (`>>>`) and run the following commands:
```python
import board
dir(board)
```
Here is the output for the QT Py SAMD21. **You may have a different board, and this list will vary, based on the board.**
The following pins have labels on the physical QT Py SAMD21 board: A0, A1, A2, A3, SDA, SCL, TX, RX, SCK, MISO, and MOSI. You see that there are many more entries available in `board` than the labels on the QT Py.
You can use the pin names on the physical board, regardless of whether they seem to be specific to a certain protocol.
For example, you do not _have_ to use the SDA pin for I2C - you can use it for a button or LED.
On the flip side, there may be multiple names for one pin. For example, on the QT Py SAMD21, pin **A0** is labeled on the physical board silkscreen, but it is available in CircuitPython as both `A0` and `D0`. For more information on finding all the names for a given pin, see the [What Are All the Available Pin Names?](https://learn.adafruit.com/circuitpython-essentials/circuitpython-pins-and-modules#what-are-all-the-available-names-3082670-14) section below.
The results of `dir(board)` for CircuitPython compatible boards will look similar to the results for the QT Py SAMD21 in terms of the pin names, e.g. A0, D0, etc. However, some boards, for example, the Metro ESP32-S2, have different styled pin names. Here is the output for the Metro ESP32-S2.
Note that most of the pins are named in an IO# style, such as **IO1** and **IO2**. Those pins on the physical board are labeled only with a number, so an easy way to know how to access them in CircuitPython, is to run those commands in the REPL and find the pin naming scheme.
Info:
## I2C, SPI, and UART
You'll also see there are often (_ **but not always!** _) three special board-specific objects included: `I2C`, `SPI`, and `UART` - each one is for the default pin-set used for each of the three common protocol busses they are named for. These are called _singletons_.
What's a singleton? When you create an object in CircuitPython, you are _instantiating_ ('creating') it. Instantiating an object means you are creating an instance of the object with the unique values that are provided, or "passed", to it.
For example, When you instantiate an I2C object using the `busio` module, it expects two pins: clock and data, typically SCL and SDA. It often looks like this:
```python
i2c = busio.I2C(board.SCL, board.SDA)
```
Then, you pass the I2C object to a driver for the hardware you're using. For example, if you were using the TSL2591 light sensor and its CircuitPython library, the next line of code would be:
```python
tsl2591 = adafruit_tsl2591.TSL2591(i2c)
```
However, CircuitPython makes this simpler by including the `I2C` singleton in the `board` module. Instead of the two lines of code above, you simply provide the singleton as the I2C object. So if you were using the TSL2591 and its CircuitPython library, the two above lines of code would be replaced with:
```python
tsl2591 = adafruit_tsl2591.TSL2591(board.I2C())
```
Info:
This eliminates the need for the `busio` module, and simplifies the code. Behind the scenes, the `board.I2C()` object is instantiated when you call it, but not before, and on subsequent calls, it returns the same object. Basically, it does not create an object until you need it, and provides the same object every time you need it. You can call `board.I2C()` as many times as you like, and it will always return the same object.
Info:
## What Are All the Available Names?
Many pins on CircuitPython compatible microcontroller boards have multiple names, however, typically, there's only one name labeled on the physical board. So how do you find out what the other available pin names are? Simple, with the following script! Each line printed out to the serial console contains the set of names for a particular pin.
On a microcontroller board running CircuitPython, first, connect to the serial console.
In the example below, click the **Download Project Bundle** button below to download the necessary libraries and the **code.py** file in a zip file. Extract the contents of the zip file, open the directory **CircuitPython\_Essentials/Pin\_Map\_Script/** and then click on the directory that matches the version of CircuitPython you're using and copy the contents of that directory to your **CIRCUITPY** drive.
Your **CIRCUITPY** drive should now look similar to the following image:
https://github.com/adafruit/Adafruit_Learning_System_Guides/blob/main/CircuitPython_Essentials/Pin_Map_Script/code.py
Here is the result when this script is run on QT Py SAMD21:
Each line represents a single pin. Find the line containing the pin name that's labeled on the physical board, and you'll find the other names available for that pin. For example, the first pin on the board is labeled **A0**. The first line in the output is `board.A0 board.D0 (PA02)`. This means that you can access pin **A0** in CircuitPython using both `board.A0` and `board.D0`.
The pins in parentheses are the microcontroller pin names. See the next section for more info on those.
You'll notice there are two "pins" that aren't labeled on the board but appear in the list: `board.NEOPIXEL` and `board.NEOPIXEL_POWER`. Many boards have several of these special pins that give you access to built-in board hardware, such as an LED or an on-board sensor. The QT Py SAMD21 only has one on-board extra piece of hardware, a NeoPixel LED, so there's only the one available in the list. But you can also control whether or not power is applied to the NeoPixel, so there's a separate pin for that.
That's all there is to figuring out the available names for a pin on a compatible microcontroller board in CircuitPython!
## Microcontroller Pin Names
The pin names available to you in the CircuitPython `board` module are not the same as the names of the pins on the microcontroller itself. The board pin names are aliases to the microcontroller pin names. If you look at the datasheet for your microcontroller, you'll likely find a pinout with a series of pin names, such as "PA18" or "GPIO5". If you want to get to the actual microcontroller pin name in CircuitPython, you'll need the `microcontroller.pin` module. As with `board`, you can run `dir(microcontroller.pin)` in the REPL to receive a list of the microcontroller pin names.
# CircuitPython Built-In Modules
There is a set of modules used in most CircuitPython programs. One or more of these modules is always used in projects involving hardware. Often hardware requires installing a separate library from the Adafruit CircuitPython Bundle. But, if you try to find `board` or `digitalio` in the same bundle, you'll come up lacking. So, where do these modules come from? They're built into CircuitPython! You can find an comprehensive list of built-in CircuitPython modules and the technical details of their functionality from CircuitPython [here](https://circuitpython.readthedocs.io/en/latest/shared-bindings/index.html#modules) and the Python-like modules included [here](https://circuitpython.readthedocs.io/en/latest/docs/library/index.html). However, **not every module is available for every board** due to size constraints or hardware limitations. How do you find out what modules are available for your board?
There are two options for this. You can check the [support matrix](https://circuitpython.readthedocs.io/en/latest/shared-bindings/support_matrix.html#), and search for your board by name. Or, you can use the REPL.
Plug in your board, connect to the serial console and enter the REPL. Type the following command.
```python
help("modules")
```
![](https://cdn-learn.adafruit.com/assets/assets/000/099/208/medium800/circuitpython_Essentials_help_modules_QT_Py.png?1612372532 help("modules") results for QT Py)
That's it! You now know two ways to find all of the modules built into CircuitPython for your compatible microcontroller board.
# Adafruit Metro ESP32-S3
## Installing the 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!
Info: Mu is our recommended editor - please use it (unless you are an experienced coder with a favorite editor already!). While it has been announced end of life in 2026, it still works fine.
You are free to use whatever text editor you wish along with a terminal program to connect to the CircuitPython REPL. Thonny is one such editor.
## Download and Install Mu
Download Mu from [https://codewith.mu](https://codewith.mu/).
Click the **Download** link for downloads and installation instructions.
Click **Start Here ** to find a wealth of other information, including extensive tutorials and and how-to's.
Warning:
## Starting Up 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 **CircuitPython**!
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 the **Mode** button in the upper left, and then choose "CircuitPython" in the dialog box that appears.
Mu attempts to auto-detect your board on startup, so if you do not have a CircuitPython board plugged in with a **CIRCUITPY** drive available, Mu will inform you where it will store any code you save until you plug in a board.
To avoid this warning, plug in a board and ensure that the **CIRCUITPY** drive is mounted before starting Mu.
## Using Mu
You can now explore Mu! The three main sections of the window are labeled below; the button bar, the text editor, and the serial console / REPL.
Now you're ready to code! Let's keep going...
# Adafruit Metro ESP32-S3
## Creating and Editing Code
One of the best things about CircuitPython is how simple it is to get code up and running. This section covers 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. **Adafruit strongly recommends 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 a number of other editors that work quite well. The [Recommended Editors page](https://learn.adafruit.com/welcome-to-circuitpython/recommended-editors) has more details. Otherwise, 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 was formerly not a problem on macOS, but see the warning below.)
Warning: macOS Sonoma 14.1 introduced a bug that delays writes to small drives such as CIRCUITPY drives. This caused errors when saving files to CIRCUITPY. There is a [workaround](https://learn.adafruit.com/welcome-to-circuitpython/troubleshooting#macos-sonoma-14-dot-x-disk-errors-writing-to-circuitpy-3160304). The bug was fixed in Sonoma 14.4, but at the cost of greatly slowed writes to drives 1GB or smaller.
## Creating Code
Installing CircuitPython generates a **code.py** file on your **CIRCUITPY** drive. To begin your own program, open your editor, and load the **code.py** file from the **CIRCUITPY** drive.
If you are using Mu, click the **Load** button in the button bar, navigate to the **CIRCUITPY** drive, and choose **code.py**.
Copy and paste the following code into your editor:
```python
import board
import digitalio
import time
led = digitalio.DigitalInOut(board.LED)
led.direction = digitalio.Direction.OUTPUT
while True:
led.value = True
time.sleep(0.5)
led.value = False
time.sleep(0.5)
```
Danger: The KB2040, QT Py , Qualia, and the Trinkeys do not have a built-in little red LED! There is an addressable RGB NeoPixel LED. The above example will NOT work on the KB2040, QT Py, Qualia, or the Trinkeys!
If you're using a KB2040, QT Py, Quaila, or a Trinkey, or any other board without a single-color LED that can blink, please download the [NeoPixel blink example](https://github.com/adafruit/Adafruit_Learning_System_Guides/blob/master/Welcome_to_CircuitPython/code.py).
Info:
It will look like this. Note that under the `while True:` line, the next four lines begin with four spaces to indent them, and they're indented exactly the same amount. All the lines before that have no spaces before the text.
Save the **code.py** file on your **CIRCUITPY** drive.
The little LED should now be blinking. Once per half-second.
Congratulations, you've just run your first CircuitPython program!
Info: On most boards you'll find a tiny red LED. On the ItsyBitsy nRF52840, you'll find a tiny blue LED. On QT Py M0, QT Py RP2040, Qualia, and the Trinkey series, you will find only an RGB NeoPixel LED.
## Editing Code
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 one warning before you continue...
Danger:
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. 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 couple of ways to avoid filesystem corruption.
### **1. Use an editor that writes out the file completely when you save it.**
Check out the [Recommended Editors page](https://learn.adafruit.com/welcome-to-circuitpython/recommended-editors) for details on different editing options.
Info:
### **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.
You also need to do this if you use Windows Explorer or a Linux graphical file manager to drag a file onto **CIRCUITPY**.
###
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](https://learn.adafruit.com/welcome-to-circuitpython/troubleshooting) page of every board guide to get your board up and running again.
Info: If you are having trouble saving code on Windows 10, try including this code snippet at the top of code.py:
```python
import supervisor
supervisor.runtime.autoreload = False
```
## Back to Editing Code...
Now! Let's try editing the program you added to your board. Open your **code.py** file into your editor. You'll make a simple change. Change the first `0.5` to `0.1`. The code should look like this:
```python
import board
import digitalio
import time
led = digitalio.DigitalInOut(board.LED)
led.direction = digitalio.Direction.OUTPUT
while True:
led.value = True
time.sleep(0.1)
led.value = False
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?
You don't have to stop there! Let's keep going. Change the second `0.5` to `0.1` so it looks like this:
```
while True:
led.value = True
time.sleep(0.1)
led.value = False
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 **code.py** is the recommended name for 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.
# Adafruit Metro ESP32-S3
## Exploring Your First CircuitPython Program
First, you'll take a look at the code you're editing.
Here is the original code again for the LED blink example (if your board doesn't have a single-color LED to blink, look instead at the NeoPixel blink example):
```python
import board
import digitalio
import time
led = digitalio.DigitalInOut(board.LED)
led.direction = digitalio.Direction.OUTPUT
while True:
led.value = True
time.sleep(0.5)
led.value = False
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. The files built into CircuitPython are called **modules** , and the files you load separately are called **libraries**. Modules are built into CircuitPython. Libraries are stored on your **CIRCUITPY** drive in a folder called **lib**.
```python
import board
import digitalio
import time
```
The `import` statements tells the board that you're going to use a particular library or module in your code. In this example, you imported three modules: `board`, `digitalio`, and `time`. All three of these modules are built into CircuitPython, so no separate library files are needed. That's one of the things that makes this an excellent first example. You don't need anything extra to make it work!
These three modules each have a purpose. The first one,`board`, gives you access to the _hardware on your board_. The second, `digitalio`, lets you _access that hardware as inputs/outputs_._ _The third, `time`, let's you control the flow of your code in multiple ways, including passing time by 'sleeping'.
## Setting Up The LED
The next two lines setup the code to use the LED.
```auto
led = digitalio.DigitalInOut(board.LED)
led.direction = digitalio.Direction.OUTPUT
```
Your board knows the red LED as `LED`. So, you initialise that pin, and you set it to output. You set `led` to equal the rest of that information so you 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, you have four items:
```python
while True:
led.value = True
time.sleep(0.5)
led.value = False
time.sleep(0.5)
```
First, you have `led.value = True`. This line tells the LED to turn on. On the next line, you 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!
## What Happens When My Code Finishes Running?
When your code finishes running, CircuitPython resets your microcontroller board to prepare it for the next run of code. That means any set up you did earlier no longer applies, and the pin states are reset.
For example, try reducing the code snippet above by eliminating the loop entirely, and replacing it with `led.value = True`. The LED will flash almost too quickly to see, and turn off. This is because the code finishes running and resets the pin state, and the LED is no longer receiving a signal.
To that end, most CircuitPython programs involve some kind of loop, infinite or otherwise.
## What if I Don't Have the Loop?
If you don't have the loop, the code will run to the end and exit. This can lead to some unexpected behavior in simple programs like this since the "exit" also resets the state of the hardware. This is a different behavior than running commands via REPL. So if you are writing a simple program that doesn't seem to work, you may need to add a loop to the end so the program doesn't exit.
The simplest loop would be:
```python
while True:
pass
```
And remember - you can press CTRL+C to exit the loop.
See also the [Behavior section in the docs](https://circuitpython.readthedocs.io/en/latest/README.html#behavior).
# Adafruit Metro ESP32-S3
## 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 (and Python) looks like this:
`print("Hello, world!")`
This line in your code.py 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 display those too.
The serial console requires an editor that has a built in terminal, or a separate 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 serial console _really really easy_.
First, make sure your CircuitPython board is plugged in.
If you open Mu without a board plugged in, you may encounter the error seen here, letting you know no CircuitPython board was found and indicating where your code will be stored until you plug in a board.
[If you are using Windows 7, make sure you installed the drivers](https://learn.adafruit.com/welcome-to-circuitpython/windows-7-and-8-1-drivers).
Once you've opened Mu with your board plugged in, look for the **Serial** button in the button bar and click it.
The Mu window will split in two, horizontally, and display the serial console at the bottom.
Info:
## Serial Console Issues or Delays on Linux
If you're on Linux, and are seeing multi-second delays connecting to the serial console, or are seeing "AT" and other gibberish when you connect, then the `modemmanager` service might be interfering. Just remove it; it doesn't have much use unless you're still using dial-up modems.
To remove `modemmanager`, type the following command at a shell:
```terminal
sudo apt purge modemmanager
```
## Setting Permissions on Linux
On Linux, if you see an error box something like the one below when you press the **Serial** button, you need to add yourself to a user group to have permission to connect to the serial console.
On Ubuntu and Debian, add yourself to the **dialout** group by doing:
```terminal
sudo adduser $USER dialout
```
After running the command above, reboot your machine to gain access to the group. On other Linux distributions, the group you need may be different. See the [Advanced Serial Console on Linux](https://learn.adafruit.com/welcome-to-circuitpython/advanced-serial-console-on-linux) for details on how to add yourself to the right group.
# Using Something Else?
If you're not using Mu to edit, or if for some reason you are not a fan of its built in serial console, you can run the serial console from a separate program.
Windows requires you to download a terminal program. [Check out the Advanced Serial Console on Windows page for more details.](../../../../welcome-to-circuitpython/advanced-serial-console-on-windows)
MacOS has serial connection programs you can run in Terminal. [Check the Advanced Serial Console on Mac page for more details.](../../../../welcome-to-circuitpython/advanced-serial-console-on-mac-and-linux)
Linux has multiple terminal programs included options are available for download. [Check the Advanced Serial Console on Linux page for more details.](https://learn.adafruit.com/welcome-to-circuitpython/advanced-serial-console-on-linux)
Once connected, you'll see something like the following.
# Adafruit Metro ESP32-S3
## 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, you'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:
```python
import board
import digitalio
import time
led = digitalio.DigitalInOut(board.LED)
led.direction = digitalio.Direction.OUTPUT
while True:
print("Hello, CircuitPython!")
led.value = True
time.sleep(1)
led.value = False
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.
```python
import board
import digitalio
import time
led = digitalio.DigitalInOut(board.LED)
led.direction = digitalio.Direction.OUTPUT
while True:
print("Hello back to you!")
led.value = True
time.sleep(1)
led.value = False
time.sleep(1)
```
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 you 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`
```python
import board
import digitalio
import time
led = digitalio.DigitalInOut(board.LED)
led.direction = digitalio.Direction.OUTPUT
while True:
print("Hello back to you!")
led.value = Tru
time.sleep(1)
led.value = False
time.sleep(1)
```
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. You 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, which is called "print debugging". Essentially, 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!
# Adafruit Metro ESP32-S3
## The REPL
The other feature of the serial connection is the **R** ead- **E** valuate **-**** P **rint-** L**oop, 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.
## Entering the REPL
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, in this case code measuring distance, 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 your **code.py** file is empty or does not contain a loop, it will show an empty output and `Code done running.`. There is no information about what your board was doing before you interrupted it because there is no code running.
If you have no **code.py** on your **CIRCUITPY** drive, you will enter the REPL immediately after pressing CTRL+C. Again, there is no information about what your board was doing before you interrupted it because there is no code running.
Regardless, 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.
## Interacting with the REPL
From this prompt you can run all sorts of commands and code. The first thing you'll do is run `help()`. This will tell you 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 type `help("modules").` Remember the modules 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 modules built into CircuitPython, including `board`. Remember, `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 `LED`? 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." You'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. 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 modules are available and explore those modules.
Try typing more into the REPL to see what happens!
Warning:
# 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!
# Adafruit Metro ESP32-S3
## CircuitPython Libraries
Danger:
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 great 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, it's in the base directory of the drive. If not, simply create the folder yourself. When you first install CircuitPython, an empty **lib** directory will be created for you.
CircuitPython libraries work in the same way as regular Python modules so the [Python docs](https://docs.python.org/3/tutorial/modules.html) are an excellent reference for how it all should work. In Python terms, you can place our library files in the **lib** directory because it's 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, there is a library bundle.
The bundle and the library releases on GitHub 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.
Due to the regular updates and space constraints, Adafruit does not ship boards with the entire bundle. Therefore, you will need to load the libraries you need when you begin working with your board. You can find example code in the guides for your board that depends on external libraries.
Either way, as you start to explore CircuitPython, you'll want to know how to get libraries on board.
# The Adafruit Learn Guide Project Bundle
The quickest and easiest way to get going with a project from the Adafruit Learn System is by utilising the Project Bundle. Most guides now have a **Download Project Bundle** button available at the top of the full code example embed. This button downloads all the necessary files, including images, etc., to get the guide project up and running. Simply click, open the resulting zip, copy over the right files, and you're good to go!
The first step is to find the Download Project Bundle button in the guide you're working on.
Info:
Warning:
The Download Project Bundle button downloads a zip file. This zip contains a series of directories, nested within which is the **code.py** , any applicable assets like images or audio, and the **lib/** folder containing all the necessary libraries. The following zip was downloaded from the Piano in the Key of Lime guide.
Info:
When you open the zip, you'll find some nested directories. Navigate through them until you find what you need. You'll eventually find a directory for your CircuitPython version (in this case, 7.x). In the version directory, you'll find the file and directory you need: **code.py** and **lib/**. Once you find the content you need, you can copy it all over to your **CIRCUITPY** drive, replacing any files already on the drive with the files from the freshly downloaded zip.
Info:
Once you copy over all the relevant files, the project should begin running! If you find that the project is not running as expected, make sure you've copied ALL of the project files onto your microcontroller board.
That's all there is to using the Project Bundle!
# The Adafruit CircuitPython Library Bundle
Adafruit provides CircuitPython libraries for much of the hardware they provide, including sensors, breakouts and more. To eliminate the need for searching for each library individually, the libraries are available together in the Adafruit CircuitPython Library Bundle. The bundle contains all the files needed to use each library.
## Downloading the Adafruit CircuitPython Library Bundle
You can download the latest Adafruit CircuitPython Library Bundle release by clicking the button below. The libraries are being constantly updated and improved, so you'll always want to download the latest bundle.
**Match up the bundle version with the version of CircuitPython you are running.** For example, you would download the 6.x library bundle if you're running any version of CircuitPython 6, or the 7.x library bundle if you're running any version of CircuitPython 7, etc. If you mix libraries with major CircuitPython versions, you will get incompatible mpy errors due to changes in library interfaces possible during major version changes.
[Click to visit circuitpython.org for the latest Adafruit CircuitPython Library Bundle](https://circuitpython.org/libraries)
**Download the bundle version that matches your CircuitPython firmware version.** If you don't know the version, check the version info in **boot\_out.txt** file on the **CIRCUITPY** drive, or the initial prompt in the CircuitPython REPL. For example, if you're running v7.0.0, download the 7.x library bundle.
There's also a **py** bundle which contains the uncompressed python files, you probably _don't_ want that unless you are doing advanced work on libraries.
# The CircuitPython Community Library Bundle
The CircuitPython Community Library Bundle is made up of libraries written and provided by members of the CircuitPython community. These libraries are often written when community members encountered hardware not supported in the Adafruit Bundle, or to support a personal project. The authors all chose to submit these libraries to the Community Bundle make them available to the community.
**These libraries are maintained by their authors and are not supported by Adafruit.** As you would with any library, if you run into problems, feel free to file an issue on the GitHub repo for the library. Bear in mind, though, that most of these libraries are supported by a single person and you should be patient about receiving a response. Remember, these folks are not paid by Adafruit, and are volunteering their personal time when possible to provide support.
## Downloading the CircuitPython Community Library Bundle
You can download the latest CircuitPython Community Library Bundle release by clicking the button below. The libraries are being constantly updated and improved, so you'll always want to download the latest bundle.
[Click for the latest CircuitPython Community Library Bundle release](https://github.com/adafruit/CircuitPython_Community_Bundle/releases)
The link takes you to the latest release of the CircuitPython Community Library Bundle on GitHub. There are multiple versions of the bundle available. **Download the bundle version that matches your CircuitPython firmware version.** If you don't know the version, check the version info in **boot\_out.txt** file on the **CIRCUITPY** drive, or the initial prompt in the CircuitPython REPL. For example, if you're running v7.0.0, download the 7.x library bundle.
# Understanding the Bundle
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.
Open the bundle folder. Inside you'll find two information files, and two folders. One folder is the lib bundle, and the other folder is the examples bundle.
Now open the lib folder. When you open the folder, you'll see a large number of **.**** mpy** files, and folders.
## Example Files
All example files from each library are now included in the bundles in an **examples** directory (as seen above), as well as an examples-only bundle. These are included for two main reasons:
- Allow for quick testing of devices.
- Provide an example base of code, that is easily built upon for individualized purposes.
## Copying Libraries to Your Board
First open the **lib** folder on your **CIRCUITPY** drive. 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**.
If the library is a directory with multiple **.mpy** files in it, be sure to **copy the entire folder to CIRCUITPY/lib**.
This also applies to example files. Open the **examples** folder you extracted from the downloaded zip, and copy the applicable file to your **CIRCUITPY** drive. Then, rename it to **code.py** to run it.
Info:
# Understanding Which Libraries to Install
You now know how to load libraries on to your CircuitPython-compatible microcontroller board. You may now be wondering, how do you know _which_ libraries you need to install? Unfortunately, it's not always straightforward. Fortunately, there is an obvious place to start, and a relatively simple way to figure out the rest. First up: the best place to start.
When you look at most CircuitPython examples, you'll see they begin with one or more `import` statements. These typically look like the following:
- `import library_or_module`
However, `import` statements can also sometimes look like the following:
- `from library_or_module import name`
- `from library_or_module.subpackage import name`
- `from library_or_module import name as local_name`
They can also have more complicated formats, such as including a `try` / `except` block, etc.
The important thing to know is that **an** `import` **statement will always include the name of the module or library that you're importing**.
Therefore, the best place to start is by reading through the `import` statements.
Here is an example import list for you to work with in this section. There is no setup or other code shown here, as the purpose of this section involves only the import list.
```python
import time
import board
import neopixel
import adafruit_lis3dh
import usb_hid
from adafruit_hid.consumer_control import ConsumerControl
from adafruit_hid.consumer_control_code import ConsumerControlCode
```
Keep in mind, not all imported items are libraries. Some of them are almost always built-in CircuitPython modules. How do you know the difference? Time to visit the REPL.
In the [Interacting with the REPL section](https://learn.adafruit.com/welcome-to-circuitpython/the-repl#interacting-with-the-repl-2977486-14) on [The REPL page](https://learn.adafruit.com/welcome-to-circuitpython/the-repl) in this guide, the `help("modules")` command is discussed. This command provides a list of all of the built-in modules available in CircuitPython for your board. So, if you connect to the serial console on your board, and enter the REPL, you can run `help("modules")` to see what modules are available for your board. Then, as you read through the `import` statements, you can, for the purposes of figuring out which libraries to load, ignore the statement that import modules.
The following is the list of modules built into CircuitPython for the Feather RP2040. Your list may look similar or be anything down to a significant subset of this list for smaller boards.
Now that you know what you're looking for, it's time to read through the import statements. The first two, `time` and `board`, are on the modules list above, so they're built-in.
The next one, `neopixel`, is not on the module list. That means it's your first library! So, you would head over to the bundle zip you downloaded, and search for **neopixel**. There is a **neopixel.mpy** file in the bundle zip. Copy it over to the **lib** folder on your **CIRCUITPY** drive. The following one, `adafruit_lis3dh`, is also not on the module list. Follow the same process for **adafruit\_lis3dh** , where you'll find **adafruit\_lis3dh.mpy** , and copy that over.
The fifth one is `usb_hid`, and it is in the modules list, so it is built in. Often all of the built-in modules come first in the import list, but sometimes they don't! Don't assume that everything after the first library is also a library, and verify each import with the modules list to be sure. Otherwise, you'll search the bundle and come up empty!
The final two imports are not as clear. Remember, when `import` statements are formatted like this, the first thing after the `from` is the library name. In this case, the library name is `adafruit_hid`. A search of the bundle will find an **adafruit\_hid _folder_**. When a library is a folder, you must copy the **entire folder and its contents _as it is in the bundle_** to the **lib** folder on your **CIRCUITPY** drive. In this case, you would copy the entire **adafruit\_hid** folder to your **CIRCUITPY/lib** folder.
Notice that there are _two_ imports that begin with `adafruit_hid`. Sometimes you will need to import more than one thing from the same library. Regardless of how many times you import the same library, you only need to load the library by copying over the **adafruit\_hid** folder _once_.
That is how you can use your example code to figure out what libraries to load on your CircuitPython-compatible board!
There are cases, however, where libraries require other libraries internally. The internally required library is called a _dependency_. In the event of library dependencies, the easiest way to figure out what other libraries are required is to connect to the serial console and follow along with the `ImportError` printed there. The following is a very simple example of an `ImportError`, but the concept is the same for any missing library.
# Example: `ImportError` Due to Missing Library
If you choose to load libraries as you need them, or you're starting fresh with an existing example, you may end up with code that tries to use a library you haven't yet loaded. This section will 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 Blink example.
```auto
import board
import time
import simpleio
led = simpleio.DigitalOut(board.LED)
while True:
led.value = True
time.sleep(0.5)
led.value = False
time.sleep(0.5)
```
Save this file. Nothing happens to your board. Let's check the serial console to see what's going on.
You have an `ImportError`. It says there is `no module named 'simpleio'`. That's the one you just included in your 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 you'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 an M0 non-Express board such as Trinket M0, Gemma M0, QT Py M0, or one of the M0 Trinkeys, you'll want to follow the same steps in the example above to install libraries as you need them. Remember, you don't need to wait for an `ImportError` if you know what library you added to your code. Open the library bundle you downloaded, find the library you need, and drag it to the **lib** folder on your **CIRCUITPY** drive.
You can still end up running out of space on your M0 non-Express board 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 suggestions on the [Troubleshooting page](https://learn.adafruit.com/welcome-to-circuitpython/troubleshooting).
# Updating CircuitPython Libraries and Examples
Libraries and examples 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 or example, 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!
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.
## CircUp CLI Tool
There is a command line interface (CLI) utility called [CircUp](https://learn.adafruit.com/keep-your-circuitpython-libraries-on-devices-up-to-date-with-circup) that can be used to easily install and update libraries on your device. Follow the directions on the [install page within the CircUp learn guide](https://learn.adafruit.com/keep-your-circuitpython-libraries-on-devices-up-to-date-with-circup/install-circup). Once you've got it installed you run the command `circup update` in a terminal to interactively update all libraries on the connected CircuitPython device. See the [usage page in the CircUp guide](https://learn.adafruit.com/keep-your-circuitpython-libraries-on-devices-up-to-date-with-circup/usage) for a full list of functionality
# Adafruit Metro ESP32-S3
## CircuitPython Documentation
You've learned about the CircuitPython built-in modules and external libraries. You know that you can find the modules in CircuitPython, and the libraries in the Library Bundles. There are guides available that explain the basics of many of the modules and libraries. However, there's sometimes more capabilities than are necessarily showcased in the guides, and often more to learn about a module or library. So, where can you find more detailed information? That's when you want to look at the API documentation.
The entire CircuitPython project comes with extensive documentation available on Read the Docs. This includes both the [CircuitPython core](https://circuitpython.readthedocs.io/) and the [Adafruit CircuitPython libraries](https://circuitpython.readthedocs.io/projects/bundle/en/latest/).
## CircuitPython Core Documentation
The [CircuitPython core documentation](https://circuitpython.readthedocs.io/) covers many of the details you might want to know about the CircuitPython core and related topics. It includes API and usage info, a design guide and information about porting CircuitPython to new boards, MicroPython info with relation to CircuitPython, and general information about the project.
The main page covers the basics including where to **download CircuitPython** , how to **contribute** , **differences from MicroPython** , information about the **project structure** , and a **full table of contents** for the rest of the documentation.
The list along the left side leads to more information about specific topics.
The first section is **API and Usage**. This is where you can find information about how to use individual built-in **core modules** , such as `time` and `digitalio`, details about the **supported ports** , suggestions for **troubleshooting** , and basic info and links to the **library bundles**. The **Core Modules** section also includes the **Support Matrix** , which is a table of which core modules are available on which boards.
The second section is **Design and Porting** **Reference**. It includes a **design guide** , **architecture** information, details on **porting** , and **adding module support** to other ports.
The third section is **MicroPython Specific**. It includes information on **MicroPython and related libraries** , and a **glossary** of terms.
The fourth and final section is **About the Project**. It includes further information including details on **building, testing, and debugging CircuitPython** , along with various other useful links including the **Adafruit Community Code of Conduct**.
Whether you're a seasoned pro or new to electronics and programming, you'll find a wealth of information to help you along your CircuitPython journey in the documentation!
## CircuitPython Library Documentation
The Adafruit CircuitPython libraries are documented in a very similar fashion. Each library has its own page on Read the Docs. There is a comprehensive list available [here](https://circuitpython.readthedocs.io/projects/bundle/en/latest/). Otherwise, to view the documentation for a specific library, you can visit the GitHub repository for the library, and find the link in the README.
For the purposes of this page, the [LED Animation library](https://github.com/adafruit/Adafruit_CircuitPython_LED_Animation) documentation will be featured. There are two links to the documentation in each library GitHub repo. The first one is the **docs badge** near the top of the README.
The second place is the **Documentation section** of the README. Scroll down to find it, and click on Read the Docs to get to the documentation.
Now that you know how to find it, it's time to take a look at what to expect.
Info:
The **Introduction** page is generated from the README, so it includes all the same info, such as PyPI installation instructions, a quick demo, and some build details. It also includes a full table of contents for the rest of the documentation (which is not part of the GitHub README). The page should look something like the following.
The left side contains links to the rest of the documentation, divided into three separate sections: **Examples** , **API Reference** , and **Other Links**.
### Examples
The [Examples section](https://circuitpython.readthedocs.io/projects/led-animation/en/latest/examples.html) is a list of library examples. This list contains anywhere from a small selection to the full list of the examples available for the library.
This section will always contain at least one example - the **simple test** example.
The simple test example is usually a basic example designed to show your setup is working. It may require other libraries to run. Keep in mind, it's _simple_ - it won't showcase a comprehensive use of all the library features.
The LED Animation simple test demonstrates the Blink animation.
In some cases, you'll find a longer list, that may include examples that explore other features in the library. The LED Animation documentation includes a series of examples, all of which are available in the library. These examples include demonstrations of both basic and more complex features. Simply click on the example that interests you to view the associated code.
Info:
You can view the rest of the examples by clicking through the list or scrolling down the page. These examples are fully working code. Which is to say, while they may rely on other libraries as well as the library for which you are viewing the documentation, they should not require modification to otherwise work.
### API Reference
The [API Reference section](https://circuitpython.readthedocs.io/projects/led-animation/en/latest/api.html) includes a list of the library functions and classes. The API (Application Programming Interface) of a library is the set of functions and classes the library provides. Essentially, the API defines how your program interfaces with the functions and classes that you call in your code to use the library.
There is always at least one list item included. Libraries for which the code is included in a single Python ( **.py** ) file, will only have one item. Libraries for which the code is multiple Python files in a directory (called subpackages) will have multiple items in this list. The LED Animation library has a series of subpackages, and therefore, multiple items in this list.
Click on the first item in the list to begin viewing the API Reference section.
Info:
When you click on an item in the API Reference section, you'll find details about the classes and functions in the library. In the case of only one item in this section, all the available functionality of the library will be contained within that first and only subsection. However, in the case of a library that has subpackages, each item will contain the features of the particular subpackage indicated by the link. The documentation will cover _all_ of the available functions of the library, including more complex ones that may not interest you.
The first list item is the animation subpackage. If you scroll down, you'll begin to see the available features of animation. They are listed alphabetically. Each of these things can be called in your code. It includes the name and a description of the specific function you would call, and if any parameters are necessary, lists those with a description as well.
You can view the other subpackages by clicking the link on the left or scrolling down the page. You may be interested in something a little more practical. Here is an example. To use the LED Animation library Comet animation, you would run the following example.
https://github.com/adafruit/Adafruit_CircuitPython_LED_Animation/blob/main/examples/led_animation_comet.py
Note the line where you create the `comet` object. There are a number of items inside the parentheses. In this case, you're provided with a fully working example. But what if you want to change how the comet works? The code alone does not explain what the options mean.
So, in the API Reference documentation list, click the `adafruit_led_animation.animation.comet` link and scroll down a bit until you see the following.
Look familiar? It is! This is the documentation for setting up the comet object. It explains what each argument provided in the comet setup in the code meant, as well as the other available features. For example, the code includes `speed=0.02`. The documentation clarifies that this is the "Animation speed in seconds". The code doesn't include `ring`. The documentation indicates this is an available setting that enables "Ring mode".
This type of information is available for any function you would set up in your code. If you need clarification on something, wonder whether there's more options available, or are simply interested in the details involved in the code you're writing, check out the documentation for the CircuitPython libraries!
### Other Links
This section is the same for every library. It includes a list of links to external sites, which you can visit for more information about the CircuitPython Project and Adafruit.
That covers the CircuitPython library documentation! When you are ready to go beyond the basic library features covered in a guide, or you're interested in understanding those features better, the library documentation on Read the Docs has you covered!
# Adafruit Metro ESP32-S3
## Recommended Editors
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.
To avoid the likelihood of filesystem corruption, use an editor that writes out the file completely when you save it. Check out the list of recommended editors below.
## Recommended editors
- [**mu**](https://learn.adafruit.com/welcome-to-circuitpython/installing-mu-editor) is an editor that safely writes all changes (it's also our recommended editor!)
- [**emacs**](https://www.gnu.org/software/emacs/) is also an editor that will [fulIy write files on save](https://www.gnu.org/software/emacs/manual/html_node/emacs/Customize-Save.html)
- **[Sublime Text](https://www.sublimetext.com/) **safely writes all changes
- **[Visual Studio Code](https://code.visualstudio.com/)** appears to safely write all changes
- **gedit** on Linux appears to safely write all changes
- [IDLE](https://docs.python.org/3/library/idle.html), in Python 3.8.1 or later, [was fixed](https://bugs.python.org/issue36807) to write all changes immediately
- [Thonny](https://thonny.org/) fully writes files on save
- [Notepad++](https://notepad-plus-plus.org/) flushes files after writes, as of several years ago. In addition, you can change the path used for "Enable session snapshot and periodic backup" to write somewhere else than the CIRCUITPY drive. This will save space on CIRCUITPY and reduce writes to the drive.
## Recommended _only_ with particular settings or add-ons
- [**vim**](http://www.vim.org/) / **vi** safely writes all changes. But set up **vim** to not write [swapfiles](https://vi.stackexchange.com/a/179) (.swp files: temporary records of your edits) to **CIRCUITPY**. Run vim with `vim -n`, set the `no swapfile` option, or set the `directory` option to write swapfiles elsewhere. Otherwise the swapfile writes trigger restarts of your program.
- The **[PyCharm IDE](https://www.jetbrains.com/pycharm/)** is safe if "Safe Write" is turned on in Settings-\>System Settings-\>Synchronization (true by default).
- If you are using [**Atom**](https://atom.io/), install the [fsync-on-save package](https://atom.io/packages/fsync-on-save) or the [language-circuitpython package](https://atom.io/packages/language-circuitpython) so that it will always write out all changes to files on **CIRCUITPY**.
- [**SlickEdit**](https://www.slickedit.com/) works only if you [add a macro to flush the disk](https://forums.adafruit.com/viewtopic.php?f=57&t=144412#p713290).
Danger:
## Editors that are NOT recommended
- **notepad** (the default Windows editor) can be slow to write, so the editors above are recommended! If you are using notepad, be sure to eject the drive.
- **IDLE** in Python 3.8.0 or earlier does not force out changes immediately. Later versions do force out changes.
- **nano** (on Linux) does not force out changes.
- **geany** (on Linux) does not force out changes.
- **Anything else** - Other editors have not been tested so please use a recommended one!
# Adafruit Metro ESP32-S3
## Advanced Serial Console on Windows
# 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.
You'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.
## Windows Serial Port Terminal Programs
- Putty is a venerable serial port connection program. More details are below.
- [Tera Term](https://teratermproject.github.io/index-en.html) is a nice terminal program. It will reconnect automatically after disconnections
- VSCode has a number of serial port extensions, such as [Serial Monitor](https://marketplace.visualstudio.com/items?itemName=ms-vscode.vscode-serial-monitor).
- PyCharm has a [Serial Port Monitor](https://plugins.jetbrains.com/plugin/8031-serial-port-monitor) plugin.
## Install Putty
PuTTY is a well-known choice for connecting to serial ports on Windows.
The first thing to do is download the [latest version of PuTTY](https://www.chiark.greenend.org.uk/~sgtatham/putty/latest.html). 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!
# Windows 7 and 8.1
If you're using Windows 7 (or 8 or 8.1), you'll need to install drivers. See the [Windows 7 and 8.1 Drivers page](https://learn.adafruit.com/welcome-to-circuitpython/windows-7-and-8-1-drivers) for details. You will not need to install drivers on Mac, Linux or Windows 10 or 11.
# Adafruit Metro ESP32-S3
## Advanced Serial Console on Mac
Connecting to the serial console on Mac does not require installing any drivers or extra software. You'll use a terminal program to find your board, and `screen` to connect to it. Terminal and `screen` both come installed by default.
## 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.
The easiest way to determine which port the board is using is to first check **without** the board plugged in. 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, you'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.
Now, plug your board. In Terminal, type:
`ls /dev/tty.*`
This will show you the current serial connections, which will now include your board.
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.
Danger: Using the `screen` terminal program can cause your CircuitPython program to hang when trying to print, if you exit `screen` after you've used it to connect.
## macOS Serial Port Terminal Programs
- `screen` is included with macOS. However, it's problematic because when it starts up, it enables the using DTR/RTS flow control signals and does not turn that off when it quits. This causes CircuitPython to block sending output when `screen` has exited, which will cause your program to stall until it is reconnected. See [this issue](https://github.com/adafruit/circuitpython/issues/10814) for a discussion.
- `tio` is a nice terminal program that works properly. You can install it with [Homebrew](https://brew.sh/).
- VSCode has a number of serial port extensions, such as [Serial Monitor](https://marketplace.visualstudio.com/items?itemName=ms-vscode.vscode-serial-monitor).
- PyCharm has a [Serial Port Monitor](https://plugins.jetbrains.com/plugin/8031-serial-port-monitor) plugin.
## Connect with screen
Despite the caveats above, if you can't download a better terminal program, you can use `screen`. The `screen` command is included with MacOS. 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.
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!
# Adafruit Metro ESP32-S3
## Advanced Serial Console on Linux
Connecting to the serial console on Linux does not require installing any drivers, but you may need to install `screen` using your package manager. You'll use a terminal program to find your board, and `screen` to connect to it. There are a variety of terminal programs such as gnome-terminal (called Terminal) or Konsole on KDE.
The `tio` program works as well to connect to your board, and has the benefit of automatically reconnecting. You would need to install it using your package manager.
## 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.
The easiest way to determine which port the board is using is to first check **without** the board plugged in. Open your terminal program and type the following:
`ls /dev/ttyACM*`
Each serial connection shows up in the **/dev/** directory. It has a name that starts with **ttyACM**. 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, You're asking to see all of the listings in **/dev/** that start with **ttyACM** `` and end in anything. This will show us the current serial connections.
In the example below, the error is indicating that are no current serial connections starting with **ttyACM**.
Now plug in your board. In your terminal program, type:
`ls /dev/ttyACM*`
This will show you the current serial connections, which will now include your board.
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.
## Linux Serial Port Terminal Programs
- `tio` is a nice terminal program that works properly. You can install it using your package manager.
- VSCode has a number of serial port extensions, such as [Serial Monitor](https://marketplace.visualstudio.com/items?itemName=ms-vscode.vscode-serial-monitor).
- PyCharm has a [Serial Port Monitor](https://plugins.jetbrains.com/plugin/8031-serial-port-monitor) plugin.
## Connect with `tio`
Now that you know the name your board is using, you're ready connect to the serial console. Install `tio` using your package manager..
ype the following command, replacing `ttyACMx` with the name you found your board is using:
`tio /dev/ttyACMx`
This will connect to the serial port and display a header like this:
```terminal
$ tio /dev/ttyACM0
[11:07:00.578] tio v2.7
[11:07:00.578] Press ctrl-t q to quit
```
## Permissions on Linux
If you try to run `tio` and it doesn't work, then you may be running into an issue with permissions. Your Linux distribution may not allow access to serial ports by defaut. You may see something like this; note the "permission denied".
```terminal
[11:13:42.754] tio v2.7
[11:13:42.754] Press ctrl-t q to quit
[11:13:42.754] Warning: Could not open tty device (Permission denied)
[11:13:42.754] Waiting for tty device..
```
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.
```terminal
$ sudo tio /dev/ttyACM0
[sudo] password for smith:
```
Once you enter your password, you should be in:
The second way is to add yourself to the user 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**.
On Debian-based distributions, such as,Ubuntu the group will be **dialout** , not **adm**.
After you add yourself to the group, you'll need to logout and log back in, or in some cases, reboot your machine. After you log in again, verify that you have been added to the group using the command `groups`. If you are still not in the group, reboot and check again.
And now you should be able to run `screen` without using `sudo`.
And you're in:
# Adafruit Metro ESP32-S3
## Frequently Asked Questions
These are some of the common questions regarding CircuitPython and CircuitPython microcontrollers.
###
What are some common acronyms to know?
CP or CPy = [CircuitPython](https://circuitpython.org)
CPC = [Circuit Playground Classic](https://www.adafruit.com/product/3000) (does not run CircuitPython)
CPX = [Circuit Playground Express](https://www.adafruit.com/product/3333)
CPB = [Circuit Playground Bluefruit](https://www.adafruit.com/product/4333)
## Using Older Versions
Danger:
### I have to continue using CircuitPython 8.x or earlier. Where can I find compatible libraries?
**We are no longer building or supporting the CircuitPython 8.x or earlier library bundles. We highly encourage you to [update CircuitPython to the latest version](https://circuitpython.org/downloads) and use [the current version of the libraries](https://circuitpython.org/libraries).** However, if for some reason you cannot update, here are the last available library bundles for older versions:
- [2.x bundle](https://github.com/adafruit/Adafruit_CircuitPython_Bundle/releases/download/20190903/adafruit-circuitpython-bundle-2.x-mpy-20190903.zip)
- [3.x bundle](https://github.com/adafruit/Adafruit_CircuitPython_Bundle/releases/download/20190903/adafruit-circuitpython-bundle-3.x-mpy-20190903.zip)
- [4.x bundle](https://github.com/adafruit/Adafruit_CircuitPython_Bundle/releases/download/20200707/adafruit-circuitpython-bundle-4.x-mpy-20200707.zip)
- [5.x bundle](https://github.com/adafruit/Adafruit_CircuitPython_Bundle/releases/download/20210129/adafruit-circuitpython-bundle-5.x-mpy-20210129.zip)
- [6.x bundle](https://github.com/adafruit/Adafruit_CircuitPython_Bundle/releases/download/20211213/adafruit-circuitpython-bundle-6.x-mpy-20211213.zip)
- [7.x bundle](https://github.com/adafruit/Adafruit_CircuitPython_Bundle/releases/download/20231003/adafruit-circuitpython-bundle-7.x-mpy-20231003.zip)
- [8.x bundle](https://github.com/adafruit/Adafruit_CircuitPython_Bundle/releases/download/20250213/adafruit-circuitpython-bundle-8.x-mpy-20250213.zip)
## Python Arithmetic
###
Does CircuitPython support floating-point numbers?
All CircuitPython boards support floating point arithmetic, even if the microcontroller chip does not support floating point in hardware. Floating point numbers are stored in 30 bits, with an 8-bit exponent and a 22-bit mantissa. Note that this is two bits less than standard 32-bit single-precision floats. You will get about 5-1/2 digits of decimal precision.
(The **broadcom** port may provide 64-bit floats in some cases.)
###
Does CircuitPython support long integers, like regular Python?
Python long integers (integers of arbitrary size) are available on most builds, except those on boards with the smallest available firmware size. On these boards, integers are stored in 31 bits.
Boards without long integer support are mostly SAMD21 ("M0") boards without an external flash chip, such as the Adafruit Gemma M0, Trinket M0, QT Py M0, and the Trinkey series. There are also a number of third-party boards in this category. There are also a few small STM third-party boards without long integer support.
`time.localtime()`, `time.mktime()`, `time.time()`, and `time.monotonic_ns()` are available only on builds with long integers.
## Wireless Connectivity
###
How do I connect to the Internet with CircuitPython?
If you'd like to include WiFi in your project, your best bet is to use a board that is running natively on ESP32 chipsets - those have WiFi built in!
If your development board has an SPI port and at least 4 additional pins, you can check out [this guide](https://learn.adafruit.com/adafruit-io-basics-airlift) on using AirLift with CircuitPython - extra wiring is required and some boards like the MacroPad or NeoTrellis do not have enough available pins to add the hardware support.
For further project examples, and guides about using AirLift with specific hardware, check out [the Adafruit Learn System](https://learn.adafruit.com/search?q=airlift).
### How do I do BLE (Bluetooth Low Energy) with CircuitPython?
nRF52840, nRF52833, and **as of CircuitPython 9.1.0** , ESP32, ESP32-C3, and ESP32-S3 boards (with 8MB) have the most complete BLE implementation. Your program can act as both a BLE central and peripheral. As a central, you can scan for advertisements, and connect to an advertising board. As a peripheral, you can advertise, and you can create services available to a central. Pairing and bonding are supported.
**Most Espressif boards with only 4MB of flash do not have enough room to include BLE in CircuitPython 9.** Check the [Module Support Matrix](https://docs.circuitpython.org/en/latest/shared-bindings/support_matrix.html) to see if your board has support for `_bleio`. CircuitPython 10 is planned to support `_bleio` on Espressif boards with 4MB flash.
Note that the ESP32-S2 does not have Bluetooth capability.
On most other boards with adequate firmware space, [BLE is available for use with AirLift](https://learn.adafruit.com/adafruit-airlift-breakout/circuitpython-ble) or other NINA-FW-based co-processors. Some boards have this coprocessor on board, such as the [PyPortal](https://learn.adafruit.com/adafruit-pyportal/circuitpython-ble). Currently, this implementation only supports acting as a BLE peripheral. Scanning and connecting as a central are not yet implemented. Bonding and pairing are not supported.
###
Are there other ways to communicate by radio with CircuitPython?
Check out [Adafruit's RFM boards](https://www.adafruit.com/?q=rfm&sort=BestMatch)for simple radio communication supported by CircuitPython, which can be used over distances of 100m to over a km, depending on the version. The RFM SAMD21 M0 boards can be used, but they were not designed for CircuitPython, and have limited RAM and flash space; using the RFM breakouts or FeatherWings with more capable boards will be easier.
## Asyncio and Interrupts
###
Is there asyncio support in CircuitPython?
There is support for asyncio starting with CircuitPython 7.1.0, on all boards except the smallest SAMD21 builds. Read about using it in the [Cooperative Multitasking in CircuitPython](https://learn.adafruit.com/cooperative-multitasking-in-circuitpython) Guide.
###
Does CircuitPython support interrupts?
No. CircuitPython does not currently support interrupts - please use asyncio for multitasking / 'threaded' control of your code
## Status RGB LED
###
My RGB NeoPixel/DotStar LED is blinking funny colors - what does it mean?
The status LED can tell you what's going on with your CircuitPython board. [Read more here for what the colors mean!](https://learn.adafruit.com/welcome-to-circuitpython/troubleshooting#circuitpython-rgb-status-light-2978455-24)
## Memory Issues
###
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.
###
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](https://github.com/adafruit/Adafruit_CircuitPython_Bundle/releases) 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.
###
Can the order of my .mpy files?
You can make your own **.mpy** versions of files with `mpy-cross`.
You can download **mpy-cross** for your operating system from [here](https://adafruit-circuit-python.s3.amazonaws.com/index.html?prefix=bin/mpy-cross/). Builds are available for Windows, macOS, x64 Linux, and Raspberry Pi Linux. Choose the latest **mpy-cross** whose version matches the version of CircuitPython you are using.
On macOS and Linux, after you download **mpy-cross** , you must make the the file executable by doing `chmod +x name-of-the-mpy-cross-executable`.
To make a **.mpy** file, run `./mpy-cross path/to/yourfile.py` to create a **yourfile.mpy** in the same directory as the original file.
###
How do I check how much memory I have free?
Run the following to see the number of bytes available for use:
`import gc`
`gc.mem_free()`
## Unsupported Hardware
###
Is ESP8266 or ESP32 supported in CircuitPython? Why not?
We dropped ESP8266 support as of 4.x - For more information please read about it [here](https://learn.adafruit.com/welcome-to-circuitpython/circuitpython-for-esp8266)!
[As of CircuitPython 8.x we have started to support ESP32 and ESP32-C3 and have added a WiFi workflow for wireless coding!](https://learn.adafruit.com/circuitpython-with-esp32-quick-start)
We also support ESP32-S2 & ESP32-S3, which have native USB.
###
Does Feather M0 support WINC1500?
No, WINC1500 will not fit into the M0 flash space.
###
Can AVRs such as ATmega328 or ATmega2560 run CircuitPython?
No.
# Adafruit Metro ESP32-S3
## 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.
Danger:
# Always Run the Latest Version of CircuitPython and Libraries
As CircuitPython development continues and there are new releases, Adafruit will stop supporting older releases. **You need to [update to the latest CircuitPython.](https://circuitpython.org/downloads).**
You need to download the CircuitPython Library Bundle that matches your version of CircuitPython. **Please update CircuitPython and then [download the latest bundle](https://circuitpython.org/libraries)**.
As new versions of CircuitPython are released, Adafruit will stop providing the previous bundles as automatically created downloads on the Adafruit CircuitPython Library Bundle repo. If you must continue to use an earlier version, you can still download the appropriate version of `mpy-cross` from the particular release of CircuitPython on the CircuitPython repo and create your own compatible .mpy library files. **However, it is best to update to the latest for both CircuitPython and the library bundle.**
## I have to continue using CircuitPython 7.x or earlier. Where can I find compatible libraries?
**Adafruit is no longer building or supporting the CircuitPython 7.x or earlier library bundles. You are highly encourged to [update CircuitPython to the latest version](https://circuitpython.org/downloads) and use [the current version of the libraries](https://circuitpython.org/libraries).** However, if for some reason you cannot update, links to the previous bundles are available in the [FAQ](https://learn.adafruit.com/welcome-to-circuitpython/frequently-asked-questions#faq-3105289).
# macOS Sonoma before 14.4: Errors Writing to CIRCUITPY macOS 14.4 - 15.1: Slow Writes to CIRCUITPY
macOS Sonoma before 14.4 took many seconds to complete writes to small FAT drives, 8MB or smaller. This causes errors when writing to CIRCUITPY. The best solution was to remount the CIRCUITPY drive after it is automatically mounted. Or consider downgrading back to Ventura if that works for you. This problem was tracked in [CircuitPython GitHub issue 8449](https://github.com/adafruit/circuitpython/issues/8449).
Below is a shell script to do this remount conveniently (courtesy [@czei in GitHub](https://github.com/adafruit/circuitpython/issues/8449#issuecomment-1779981373)). Copy the code here into a file named, say, **remount-CIRCUITPY.sh**. Place the file in a directory on your PATH, or in some other convenient place.
macOS Sonoma 14.4 and versions of macOS before Sequoia 15.2 did not have the problem above, but did take an inordinately long time to write to FAT drives of size 1GB or less (40 times longer than 2GB drives). As of macOS 15.2, writes are no longer very slow. This problem was tracked in [CircuitPython GitHub issue 8918](https://github.com/adafruit/circuitpython/issues/8918).
```auto
#!/bin/sh
#
# This works around bug where, by default,
# macOS 14.x before 14.4 writes part of a file immediately,
# and then doesn't update the directory for 20-60 seconds, causing
# the file system to be corrupted.
#
disky=`df | grep CIRCUITPY | cut -d" " -f1`
sudo umount /Volumes/CIRCUITPY
sudo mkdir /Volumes/CIRCUITPY
sleep 2
sudo mount -v -o noasync -t msdos $disky /Volumes/CIRCUITPY
```
Then in a Terminal window, do this to make this script executable:
```terminal
chmod +x remount-CIRCUITPY.sh
```
Place the file in a directory on your `PATH`, or in some other convenient place.
Now, each time you plug in or reset your CIRCUITPY board, run the file **remount-CIRCUITPY.sh**. You can run it in a Terminal window or you may be able to place it on the desktop or in your dock to run it just by double-clicking.
This will be something of a nuisance but it is the safest solution.
This problem is being tracked in [this CircuitPython issue](https://github.com/adafruit/circuitpython/issues/8449).
# Bootloader (_boardname_BOOT) Drive Not Present
### **You may have a different board.**
Only Adafruit Express boards and the SAMD21 non-Express boards ship with the [UF2 bootloader](../../../adafruit-feather-m0-express-designed-for-circuit-python-circuitpython/uf2-bootloader?view=all#uf2-bootloader)installed. The Feather M0 Basic, Feather M0 Adalogger, and similar boards use a regular Arduino-compatible bootloader, which does not show a **_boardname_BOOT** drive.
### **MakeCode**
If you are running a [MakeCode](../../../makecode/sharing-and-saving?view=all#step-1-bootloader-mode) 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.
### **macOS**
**DriveDx** and its accompanything **SAT SMART Driver** can interfere with seeing the BOOT drive. [See this forum post](https://forums.adafruit.com/viewtopic.php?f=58&t=161917&p=799309#p799215) for how to fix the problem.
### **Windows 10 or later**
Did you install the Adafruit Windows Drivers package by mistake, or did you upgrade to Windows 10 or later with the driver package installed? You don't need to install this package on Windows 10 or 11for 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 or 8.1**
Windows 7 and 8.1 have reached end of life. It is [recommended](https://learn.adafruit.com/welcome-to-circuitpython/installing-circuitpython#windows-7-and-8-dot-1-drivers-2977910-9) that you upgrade to Windows 10 or 11 if possible. Drivers are available for some older CircuitPython boards, but there are no plans to release drivers for newer boards.
Info: The Windows Drivers installer was last updated in November 2020 (v2.5.0.0) . Windows 7 drivers for CircuitPython boards released since then, including RP2040 boards, are not available. There are no plans to release drivers for newer boards. The boards work fine on Windows 10 and later.
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 **_boardname_BOOT** drive.
Let us know in the [Adafruit support forums](https://forums.adafruit.com) or on the [Adafruit Discord](https://adafru.it/discord) if this does not work for you!
# Windows Explorer Locks Up When Accessing **_boardname_BOOT** Drive
On Windows, several third-party programs that can cause issues. The symptom is that you try to access the **_boardname_BOOT** drive, and Windows or Windows Explorer seems to lock up. These programs are known to cause trouble:
- **AIDA64** : to fix, stop the program. This problem has been reported to AIDA64. They acquired hardware to test, and released a beta version that fixes the problem. This may have been incorporated into the latest release. Please let us know in the forums if you test this.
- **BitDefender anti-virus**
- **Hard Disk Sentinel**
- **Kaspersky anti-virus** : To fix, you may need to disable Kaspersky completely. Disabling some aspects of Kaspersky does not always solve the problem. This problem has been reported to Kaspersky.
- **ESET NOD32 anti-virus** : There have been problems with at least version 9.0.386.0, solved by uninstallation.
# Copying UF2 to **_boardname_BOOT** Drive Hangs at 0% Copied
On Windows, a **Western DIgital (WD) utility** that comes with their external USB drives can interfere with copying UF2 files to the **_boardname_BOOT** drive. Uninstall that utility to fix the problem.
# CIRCUITPY Drive Does Not Appear or Disappears Quickly
**BitDefender anti-virus has been reported to block access to** **CIRCUITPY**. You can set an exception for the drive letter.
Kaspersky **anti-virus** can block the appearance of the **CIRCUITPY** drive. There has not yet been settings change discovered that prevents this. Complete uninstallation of Kaspersky fixes the problem.
**Norton anti-virus** can interfere with **CIRCUITPY**. A user has reported this problem on Windows 7. The user turned off both Smart Firewall and Auto Protect, and **CIRCUITPY** then appeared.
**Sophos Endpoint** security software [can cause CIRCUITPY to disappear](https://forums.adafruit.com/viewtopic.php?f=60&t=187629) and the BOOT drive to reappear. It is not clear what causes this behavior.
**Samsung Magician** can cause CIRCUITPY to disappear (reported [here](https://forums.adafruit.com/viewtopic.php?t=205159) and [here](https://forums.adafruit.com/viewtopic.php?p=987596#p987596)).
## "M105" Seen on Display, Crashes, Missing CIRCUITPY
The **Cura** 3D printing program sends 3D printing GCODE commands to unused serial ports to try to find 3D printers connected over serial. This causes a variety of problems. Disable (uncheck) **USB Printing** in Cura in the **Market** -\> **Installed** menu, or uninstall Cura. For more information see [this forum post](https://forums.adafruit.com/viewtopic.php?t=192784), [this CircuitPython issue](https://github.com/adafruit/circuitpython/issues/2585), and [this Cura issue](https://github.com/Ultimaker/Cura/issues/5207).
# Device Errors or Problems on Windows
Windows can become confused about USB device installations. Try cleaning up your USB devices. Use [Uwe Sieber's Device Cleanup Tool](https://www.uwe-sieber.de/misc_tools_e.html) (on that page, scroll down to "Device Cleanup Tool"). Download and unzip the tool. Unplug all the boards and other USB devices you want to clean up. Run the tool as Administrator. You will see a listing like this, probably with many more devices. It is listing all the USB devices that are _not_ currently attached.
Select all the devices you want to remove, and then press Delete. It is usually safe just to select everything. Any device that is removed will get a fresh install when you plug it in. Using the Device Cleanup Tool also discards all the COM port assignments for the unplugged boards. If you have used many Arduino and CircuitPython boards, you have probably seen higher and higher COM port numbers used, seemingly without end. This will fix that problem.
# Serial Console in Mu Not Displaying Anything
There are times when the serial console will accurately not display anything, such as, when no code is currently running, or when code with no serial output is already running before you open the console. However, if you find yourself in a situation where you feel it should be displaying something like an error, consider the following.
Depending on the size of your screen or Mu window, when you open the serial console, the serial console panel may be very small. This can be a problem. A basic CircuitPython error takes 10 lines to display!
```
Auto-reload is on. Simply save files over USB to run them or enter REPL to disable.
code.py output:
Traceback (most recent call last):
File "code.py", line 7
SyntaxError: invalid syntax
Press any key to enter the REPL. Use CTRL-D to reload.
```
More complex errors take even more lines!
Therefore, if your serial console panel is five lines tall or less, you may only see blank lines or blank lines followed by `Press any key to enter the REPL. Use CTRL-D to reload.`. If this is the case, you need to either mouse over the top of the panel to utilise the option to resize the serial panel, or use the scrollbar on the right side to scroll up and find your message.
This applies to any kind of serial output whether it be error messages or print statements. So before you start trying to debug your problem on the hardware side, be sure to check that you haven't simply missed the serial messages due to serial output panel height.
# code.py Restarts Constantly
CircuitPython will restart **code.py** if you or your computer writes to something on the CIRCUITPY drive. This feature is called _auto-reload_, and lets you test a change to your program immediately.
Some utility programs, such as backup, anti-virus, or disk-checking apps, will write to the CIRCUITPY as part of their operation. Sometimes they do this very frequently, causing constant restarts.
**Acronis True Image** and related Acronis programs on Windows are known to cause this problem. It is possible to prevent this by [disabling the "](https://forum.acronis.com/forum/acronis-true-image-2018-forum/acronis-ati-2018-contantly-touch-usb-port-causing-issue-adafruit-circuitpython-folder)[Acronis Managed Machine Service Mini"](https://forum.acronis.com/forum/acronis-true-image-2018-forum/acronis-ati-2018-contantly-touch-usb-port-causing-issue-adafruit-circuitpython-folder).
If you cannot stop whatever is causing the writes, you can disable auto-reload by putting this code in **boot.py** or **code.py** :
```python
import supervisor
supervisor.runtime.autoreload = False
```
# CircuitPython RGB Status Light
Nearly all CircuitPython-capable boards have a single NeoPixel or DotStar RGB LED on the board that indicates the status of CircuitPython. A few boards designed before CircuitPython existed, such as the Feather M0 Basic, do not.
**Circuit Playground Express and Circuit Playground Bluefruit have multiple RGB LEDs, but do NOT have a status LED. The LEDs are all green when in the bootloader. In versions before 7.0.0, they do NOT indicate any status while running CircuitPython.**
## **CircuitPython 7.0.0 and Later**
The status LED blinks were changed in CircuitPython 7.0.0 in order to save battery power and simplify the blinks. These blink patterns will occur on single color LEDs when the board does not have any RGB LEDs. Speed and blink count also vary for this reason.
On start up, the LED will blink **YELLOW** multiple times for 1 second. Pressing the RESET button (or on Espressif, the BOOT button) during this time will restart the board and then enter safe mode. On Bluetooth capable boards, after the yellow blinks, there will be a set of faster blue blinks. Pressing reset during the **BLUE** blinks will clear Bluetooth information and start the device in discoverable mode, so it can be used with a BLE code editor.
Once started, CircuitPython will blink a pattern every 5 seconds when no user code is running to indicate why the code stopped:
- 1 **GREEN** blink: Code finished without error.
- 2 **RED** blinks: Code ended due to an exception. Check the serial console for details.
- 3 **YELLOW** blinks: CircuitPython is in safe mode. No user code was run. Check the serial console for safe mode reason.
When in the REPL, CircuitPython will set the status LED to **WHITE**. You can change the LED color from the REPL. The status indicator will not persist on non-NeoPixel or DotStar LEDs.
## **CircuitPython 6.3.0 and earlier**
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
- steady **YELLOW** at start up: (4.0.0-alpha.5 and newer) CircuitPython is waiting for a reset to indicate that it should start in safe mode
- pulsing **YELLOW** : Circuit Python is in safe mode: it crashed and restarted
- steady **WHITE** : REPL is running
- steady **BLUE** : **boot.py** is running
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.
# Serial console showing `ValueError: Incompatible .mpy file`
This error occurs when importing a module that is stored as a **.mpy** binary file that was generated by a different version of CircuitPython than the one its being loaded into. In particular, the mpy binary format changed between CircuitPython versions 6.x and 7.x, 2.x and 3.x, and 1.x and 2.x.
So, for instance, if you upgraded to CircuitPython 7.x from 6.x you’ll need to download a newer version of the library that triggered the error on `import`. All libraries are available in the [Adafruit bundle](https://github.com/adafruit/Adafruit_CircuitPython_Bundle/releases/latest).
# 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. 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, though it is more common on Windows.
Be aware, if you have used Arduino to program your board, CircuitPython is no longer able to provide the USB services. You will need to reload CircuitPython to resolve this situation.
The easiest first step is to reload CircuitPython. Double-tap reset on the board so you get a **_boardname_BOOT** drive rather than a **CIRCUITPY** drive, and copy the latest version of CircuitPython ( **.uf2** ) back to the board. This may restore **CIRCUITPY** functionality.
If reloading CircuitPython does not resolve your issue, the next step is to try putting the board into safe mode.
## Safe Mode
Whether you've run into a situation where you can no longer edit your **code.py** on your **CIRCUITPY** drive, your board has gotten into a state where **CIRCUITPY** is read-only, or you have turned off the **CIRCUITPY** drive altogether, safe mode can help.
**Safe mode** in CircuitPython does not run any user code on startup, and disables auto-reload. This means a few things. First, safe mode _bypasses any code in_ **boot.py** (where you can set **CIRCUITPY** read-only or turn it off completely). Second, _it does not run the code in_ **code.py**. And finally, _it does not automatically soft-reload when data is written to the_ **CIRCUITPY** _drive_.
Therefore, whatever you may have done to put your board in a non-interactive state, safe mode gives you the opportunity to correct it without losing all of the data on the **CIRCUITPY** drive.
### Entering Safe Mode in CircuitPython 7.x and Later
You can enter safe by pressing reset during the right time when the board boots. Immediately after the board starts up or resets, it waits one second. On some boards, the onboard status LED will blink yellow during that time. If you press reset during that one second period, the board will start up in safe mode. It can be difficult to react to the yellow LED, so you may want to think of it simply as a "slow" double click of the reset button. (Remember, a fast double click of reset enters the bootloader.)
### Entering Safe Mode in CircuitPython 6.x
You can enter safe by pressing reset during the right time when the board boots.. Immediately after the board starts up or resets, it waits 0.7 seconds. On some boards, the onboard status LED (highlighted in green above) will turn solid yellow during this time. If you press reset during that 0.7 seconds, the board will start up in safe mode. It can be difficult to react to the yellow LED, so you may want to think of it simply as a slow double click of the reset button. (Remember, a fast double click of reset enters the bootloader.)
### In Safe Mode
Once you've entered safe mode successfully in CircuitPython 6.x, the LED will pulse yellow.
If you successfully enter safe mode on CircuitPython 7.x, the LED will intermittently blink yellow three times.
If you connect to the serial console, you'll find the following message.
```terminal
Auto-reload is off.
Running in safe mode! Not running saved code.
CircuitPython is in safe mode because you pressed the reset button during boot. Press again to exit safe mode.
Press any key to enter the REPL. Use CTRL-D to reload.
```
You can now edit the contents of the **CIRCUITPY** drive. Remember, _your code will not run until you press the reset button, or unplug and plug in your board, to get out of safe mode._
At this point, you'll want to remove any user code in **code.py** and, if present, the **boot.py** file from **CIRCUITPY**. Once removed, tap the reset button, or unplug and plug in your board, to restart CircuitPython. This will restart the board and may resolve your drive issues. If resolved, you can begin coding again as usual.
If safe mode does not resolve your issue, the board must be completely erased and CircuitPython must be reloaded onto the board.
Danger:
## To erase CIRCUITPY: `storage.erase_filesystem()`
CircuitPython includes a built-in function to erase and reformat the filesystem. If you have a version of CircuitPython older than 2.3.0 on your board, you can [update to the newest version](../../../../welcome-to-circuitpython/installing-circuitpython) to do this.
1. [Connect to the CircuitPython REPL](../../../../welcome-to-circuitpython/kattni-connecting-to-the-serial-console) using Mu or a terminal program.
2. Type the following into the REPL:
```terminal
>>> import storage
>>> storage.erase_filesystem()
```
CIRCUITPY will be erased and reformatted, and your board will restart. That's it!
## Erase CIRCUITPY Without Access to the REPL
If you can't access the REPL, or you're running a version of CircuitPython previous to 2.3.0 and you don't want to upgrade, there are options available for some specific boards.
**The options listed below are considered to be the "old way" of erasing your board. The method shown above using the REPL is highly recommended as the best method for erasing your board.**
Warning:
## For the specific boards listed below:
If the board you are trying to erase is listed below, follow the steps to use the file to erase your board.
1. Download the correct erase file:
[Circuit Playground Express](https://cdn-learn.adafruit.com/assets/assets/000/048/745/original/flash_erase_express.ino.circuitplay.uf2?1512152080)
[Feather M0 Express](https://cdn-learn.adafruit.com/assets/assets/000/048/746/original/flash_erase_express.ino.feather_m0_express.uf2?1512152098)
[Feather M4 Express](https://cdn-learn.adafruit.com/assets/assets/000/076/217/original/flash_erase.ino.feather_m4.uf2)
[Metro M0 Express](https://cdn-learn.adafruit.com/assets/assets/000/048/747/original/flash_erase_express.ino.metro_m0.uf2?1512152103)
[Metro M4 Express QSPI Eraser](https://cdn-learn.adafruit.com/assets/assets/000/073/820/original/Metro_M4_QSPI_Eraser.UF2?1553805937)
[Trellis M4 Express (QSPI)](https://cdn-learn.adafruit.com/assets/assets/000/067/535/original/Trellis_M4_QSPI_Eraser.UF2?1544719380)
[Grand Central M4 Express (QSPI)](https://cdn-learn.adafruit.com/assets/assets/000/069/314/original/GC_M4_QSPI_Erase.UF2?1547404471)
[PyPortal M4 Express (QSPI)](https://cdn-learn.adafruit.com/assets/assets/000/072/252/original/PYPORTAL_QSPI_Eraser.UF2?1551738305)
[Circuit Playground Bluefruit (QSPI)](https://cdn-learn.adafruit.com/assets/assets/000/082/950/original/CP_Bluefruit_QSPI_Erase.UF2?1572026649)
[Monster M4SK (QSPI)](https://cdn-learn.adafruit.com/assets/assets/000/083/330/original/M4SK_QSPI_Eraser.UF2?1572551433)
[PyBadge/PyGamer QSPI Eraser.UF2](https://cdn-learn.adafruit.com/assets/assets/000/083/331/original/PyBadge_QSPI_Eraser.UF2?1572551613)
[CLUE_Flash_Erase.UF2](https://cdn-learn.adafruit.com/assets/assets/000/088/454/original/CLUE_Flash_Erase.UF2?1581873830)
[Matrix_Portal_M4_(QSPI).UF2](https://cdn-learn.adafruit.com/assets/assets/000/098/741/original/Matrix_Portal_M4_%28QSPI%29.UF2?1611076081)
[RP2040 boards (flash_nuke.uf2)](https://cdn-learn.adafruit.com/assets/assets/000/101/659/original/flash_nuke.uf2)
2. Double-click the reset button on the board to bring up the **_boardname_BOOT** drive.
3. Drag the erase **.uf2** file to the **_boardname_BOOT** drive.
4. The status LED will turn yellow or blue, indicating the erase has started.
5. After approximately 15 seconds, the status LED will light up green. On the NeoTrellis M4 this is the first NeoPixel on the grid
6. Double-click the reset button on the board to bring up the **_boardname_BOOT** drive.
7. [Drag the appropriate latest release of CircuitPython](https://circuitpython.org/downloads) **.uf2** file to the **_boardname_BOOT** 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](../../../../welcome-to-circuitpython/installing-circuitpython). You'll also need to load your code and reinstall your libraries!
## For SAMD21 non-Express boards that have a UF2 bootloader:
Any SAMD21-based microcontroller that does not have external flash available is considered a SAMD21 non-Express board. Non-Express boards that have a UF2 bootloader include Trinket M0, GEMMA M0, QT Py M0, and the SAMD21-based Trinkey boards.
If you are trying to erase a SAMD21 non-Express board, follow these steps to erase your board.
1. Download the erase file:
[SAMD21 non-Express Boards](https://cdn-learn.adafruit.com/assets/assets/000/048/748/original/erase_m0.uf2)
2. Double-click the reset button on the board to bring up the **_boardname_BOOT** drive.
3. Drag the erase **.uf2** file to the **_boardname_BOOT** drive.
4. The boot LED will start flashing again, and the **_boardname_BOOT** drive will reappear.
5. [Drag the appropriate latest release CircuitPython](https://circuitpython.org/downloads) **.uf2** file to the _boardname_BOOT 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](../../../../welcome-to-circuitpython/installing-circuitpython) YYou'll also need to load your code and reinstall your libraries!
## For SAMD21 non-Express boards that do not have a UF2 bootloader:
Any SAMD21-based microcontroller that does not have external flash available is considered a SAMD21 non-Express board. Non-Express boards that do **not** have a UF2 bootloader include the Feather M0 Basic Proto, Feather Adalogger, or the Arduino Zero.
If you are trying to erase a non-Express board that does not have a UF2 bootloader, [follow these directions to reload CircuitPython using `bossac`](../../../../welcome-to-circuitpython/non-uf2-installation), which will erase and re-create **CIRCUITPY**.
# Running Out of File Space on SAMD21 Non-Express Boards
Any SAMD21-based microcontroller that does not have external flash available is considered a SAMD21 non-Express board. This includes boards like the Trinket M0, GEMMA M0, QT Py M0, and the SAMD21-based Trinkey 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 number of ways to free up space.
## 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. Don't delete the **lib** folder completely, though, just remove what you don't need.
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. It's ~12KiB or so.
## 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, that is recommended 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 you're counting bytes.
## On macOS?
MacOS loves to generate hidden files. Luckily you can disable some of the extra hidden files that macOS 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 macOS.
## Prevent & Remove macOS 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:
```
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](http://apple.stackexchange.com/questions/6707/how-to-stop-os-x-from-writing-spotlight-and-trash-files-to-memory-cards-and-usb/7135#7135) to run these terminal commands that stop hidden files from being created on the board:
```terminal
mdutil -i off /Volumes/CIRCUITPY
cd /Volumes/CIRCUITPY
rm -rf .{,_.}{fseventsd,Spotlight-V*,Trashes}
mkdir .fseventsd
touch .fseventsd/no_log .metadata_never_index .Trashes
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.
Alternatively, with CircuitPython 4.x and above, the special files and folders mentioned above will be created automatically if you erase and reformat the filesystem. **WARNING: Save your files first!** Do this in the REPL:
`>>> import storage`
`>>> storage.erase_filesystem()`
However there are still some cases where hidden files will be created by MacOS. In particular if you copy a file that was downloaded from the internet it will have special metadata that MacOS 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 macOS Without Creating Hidden Files
Once you've disabled and removed hidden files with the above commands on macOS 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 **file\_name.mpy** file to the board use a command like:
```terminal
cp -X file_name.mpy /Volumes/CIRCUITPY
```
(Replace **file\_name.mpy** with the name of the file you want to copy.)
Or to copy a folder and all of the files and folders contained within, use a command like:
```terminal
cp -rX folder_to_copy /Volumes/CIRCUITPY
```
If you are copying to the **lib** folder, or another folder, make sure it exists before copying.
```terminal
# if lib does not exist, you'll create a file named lib !
cp -X file_name.mpy /Volumes/CIRCUITPY/lib
# This is safer, and will complain if a lib folder does not exist.
cp -X file_name.mpy /Volumes/CIRCUITPY/lib/
```
## Other macOS 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, move into the **Volumes/** directory with `cd /Volumes/`, and then list the amount of space used on the **CIRCUITPY** drive with the `df` command.
That's not very much space left! The next step is to show a list of the files currently on the **CIRCUITPY** drive, _including_ the hidden files, using the `ls` command. You cannot use Finder to do this, you must do it via command line!
There are a few of the hidden files that MacOS loves to generate, all of which begin with a **.\_** before the file name. Remove the **.\_** files using the `rm` command. You can remove them all once by running `rm CIRCUITPY/._*`. The `*` acts as a _wildcard_ to apply the command to everything that begins with **.\_** at the same time.
Finally, you can run `df` again to see the current space used.
Nice! You have 12Ki more than before! This space can now be used for libraries and code!
# Device Locked Up or Boot Looping
In rare cases, it may happen that something in your **code.py** or **boot.py** files causes the device to get locked up, or even go into a boot loop. A _boot loop_ occurs when the board reboots repeatedly and never fully loads. These are not caused by your everyday Python exceptions, typically it's the result of a deeper problem within CircuitPython. In this situation, it can be difficult to recover your device if **CIRCUITPY** is not allowing you to modify the **code.py** or **boot.py** files. Safe mode is one recovery option. When the device boots up in safe mode it will not run the **code.py** or **boot.py** scripts, but will still connect the **CIRCUITPY** drive so that you can remove or modify those files as needed.
For more information on safe mode and how to enter safe mode, see the [Safe Mode section on this page](https://learn.adafruit.com/welcome-to-circuitpython/troubleshooting#safe-mode-3105351).
# Adafruit Metro ESP32-S3
## 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. Whether this is your first microcontroller board or you're a seasoned software engineer, you have something important to offer the Adafruit CircuitPython community. This page highlights 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 #help-with-projects channel for assistance with your current project or help coming up with ideas for your next one. There's the #show-and-tell 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 help with CircuitPython channel is where to go with your CircuitPython questions. #help-with-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. Your contributions are important! The #circuitpython-dev channel is available for development discussions as well.
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](https://adafru.it/discord)to sign up for Discord. Everyone is looking forward to meeting you!
## CircuitPython.org
Beyond the Adafruit Learn System, which you are viewing right now, the best place to find information about CircuitPython is [circuitpython.org](https://circuitpython.org). Everything you need to get started with your new microcontroller and beyond is available. You can do things like [download CircuitPython for your microcontroller](https://circuitpython.org/downloads) or [download the latest CircuitPython Library bundle](https://circuitpython.org/libraries), or check out [which single board computers support Blinka](https://circuitpython.org/blinka). You can also get to various other CircuitPython related things like Awesome CircuitPython or the Python for Microcontrollers newsletter. This is all incredibly useful, but it isn't necessarily community related. So why is it included here? The [Contributing page](https://circuitpython.org/contributing).
CircuitPython itself is written in C. However, all of the Adafruit CircuitPython libraries are written in _Python_. If you're interested in contributing to CircuitPython on the Python side of things, check out [circuitpython.org/contributing](https://circuitpython.org/contributing). You'll find information pertaining to every Adafruit CircuitPython library GitHub repository, giving you the opportunity to join the community by finding a contributing option that works for you.
Note the date on the page next to **Current Status for** :
If you submit any contributions to the libraries, and do not see them reflected on the Contributing page, it could be that the job that checks for new updates hasn't yet run for today. Simply check back tomorrow!
Now, a look at the different options.
### Pull Requests
The first tab you'll find is a list of **open pull requests**.
GitHub pull requests, or PRs, are opened when folks have added something to an Adafruit CircuitPython library GitHub repo, and are asking for Adafruit to add, or merge, their changes into the main library code. For PRs to be merged, they must first be reviewed. Reviewing is a great way to contribute! Take a look at the list of open pull requests, and pick one that interests you. If you have the hardware, you can test code changes. If you don't, you can still check the code updates for syntax. In the case of documentation updates, you can verify the information, or check it for spelling and grammar. Once you've checked out the update, you can leave a comment letting us know that you took a look. Once you've done that for a while, and you're more comfortable with it, you can consider joining the CircuitPythonLibrarians review team. The more reviewers we have, the more authors we can support. Reviewing is a crucial part of an open source ecosystem, CircuitPython included.
### Open Issues
The second tab you'll find is a list of **open issues**.
GitHub issues are filed for a number of reasons, including when there is a bug in the library or example code, or when someone wants to make a feature request. Issues are a great way to find an opportunity to contribute directly to the libraries by updating code or documentation. If you're interested in contributing code or documentation, take a look at the open issues and find one that interests you.
If you're not sure where to start, you can search the issues by label. Labels are applied to issues to make the goal easier to identify at a first glance, or to indicate the difficulty level of the issue. Click on the dropdown next to "Sort by issue labels" to see the list of available labels, and click on one to choose it.
If you're new to everything, new to contributing to open source, or new to contributing to the CircuitPython project, you can choose "Good first issue". Issues with that label are well defined, with a finite scope, and are intended to be easy for someone new to figure out.
If you're looking for something a little more complicated, consider "Bug" or "Enhancement". The Bug label is applied to issues that pertain to problems or failures found in the library. The Enhancement label is applied to feature requests.
Don't let the process intimidate you. If you're new to Git and GitHub, there is [a guide](https://learn.adafruit.com/contribute-to-circuitpython-with-git-and-github) to walk you through the entire process. As well, there are always folks available on [Discord](https:adafru.it/discord) to answer questions.
### Library Infrastructure Issues
The third tab you'll find is a list of **library infrastructure issues**.
This section is generated by a script that runs checks on the libraries, and then reports back where there may be issues. It is made up of a list of subsections each containing links to the repositories that are experiencing that particular issue. This page is available mostly for internal use, but you may find some opportunities to contribute on this page. If there's an issue listed that sounds like something you could help with, mention it on Discord, or file an issue on GitHub indicating you're working to resolve that issue. Others can reply either way to let you know what the scope of it might be, and help you resolve it if necessary.
### CircuitPython Localization
The fourth tab you'll find is the **CircuitPython Localization** tab.
If you speak another language, you can help translate CircuitPython! The translations apply to informational and error messages that are within the CircuitPython core. It means that folks who do not speak English have the opportunity to have these messages shown to them in their own language when using CircuitPython. This is incredibly important to provide the best experience possible for all users. CircuitPython uses Weblate to translate, which makes it much simpler to contribute translations. You will still need to know some CircuitPython-specific practices and a few basics about coding strings, but as with any CircuitPython contributions, folks are there to help.
Regardless of your skill level, or how you want to contribute to the CircuitPython project, there is an opportunity available. The [Contributing page](https://circuitpython.org/contributing) is an excellent place to start!
## 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 the CircuitPython project. The CircuitPython core is written in C. The libraries are written in Python. GitHub is the best source of ways to contribute to the [CircuitPython core](https://github.com/adafruit/circuitpython), and the [CircuitPython libraries](https://circuitpython.org/contributing/open-issues). If you need an account, visit [https://github.com/](https://github.com/) and sign up.
If you're new to GitHub or programming in general, there are great opportunities for you. For the CircuitPython core, head over to the CircuitPython repository on GitHub, click on "[Issues](https://github.com/adafruit/circuitpython/issues)", and you'll find a list that includes issues labeled "[good first issue](https://github.com/adafruit/circuitpython/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)". For the libraries, head over to the [Contributing page Issues list](https://circuitpython.org/contributing/open-issues), and use the drop down menu to search for "[good first issue](https://circuitpython.org/contributing/open-issues?label=good-first-issue)". These issues are things that have been 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. If you need help getting started with GitHub, there is an excellent guide on [Contributing to CircuitPython with Git and GitHub](https://learn.adafruit.com/contribute-to-circuitpython-with-git-and-github).
Already experienced and looking for a challenge? Checkout the rest of either issues list and you'll find plenty of ways to contribute. You'll find all sorts of things, from new driver requests, to library bugs, to core module updates. There's plenty of opportunities for everyone at any level!
When working with or using CircuitPython or the CircuitPython libraries, you may find problems. If you find a bug, that's great! The team loves bugs! Posting a detailed issue to GitHub is an invaluable way to contribute to improving CircuitPython. For CircuitPython itself, file an issue [here](https://github.com/adafruit/circuitpython/issues). For the libraries, file an issue on the specific library repository on GitHub. 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 stable and unstable releases is a very important part of contributing CircuitPython. The developers can't possibly find all the problems themselves! They 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!
## Adafruit Forums
The [Adafruit Forums](https://forums.adafruit.com) 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](https://forums.adafruit.com/viewforum.php?f=60) 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!
## Read the Docs
[Read the Docs](https://circuitpython.readthedocs.io/) is a an excellent resource for a more detailed look at the CircuitPython core and the CircuitPython libraries. This is where you'll find things like API documentation and example code. For an in depth look at viewing and understanding Read the Docs, check out the [CircuitPython Documentation](https://learn.adafruit.com/welcome-to-circuitpython/circuitpython-documentation) page!
# Adafruit Metro ESP32-S3
## CircuitPython Essentials
You've been introduced to CircuitPython, and worked through getting everything set up. What's next? CircuitPython Essentials!
There are a number of core modules built into CircuitPython, which can be used along side the many CircuitPython libraries available. The following pages demonstrate some of these modules. Each page presents a different concept including a code example with an explanation. All of the examples are designed to work with your microcontroller board.
Time to get started learning the CircuitPython essentials!
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.
The following components are needed to complete all of the examples:
### Tactile Button switch (6mm) x 20 pack
[Tactile Button switch (6mm) x 20 pack](https://www.adafruit.com/product/367)
Little clicky switches are standard input "buttons" on electronic projects. These work best in a PCB but [can be used on a solderless breadboard as shown in this tutorial](https://learn.adafruit.com/adafruit-arduino-lesson-6-digital-inputs?view=all). The pins are normally...
In Stock
[Buy Now](https://www.adafruit.com/product/367)
[Related Guides to the Product](https://learn.adafruit.com/products/367/guides)
### Premium Male/Male Jumper Wires - 40 x 6" (150mm)
[Premium Male/Male Jumper Wires - 40 x 6" (150mm)](https://www.adafruit.com/product/758)
Handy for making wire harnesses or jumpering between headers on PCB's. These premium jumper wires are 6" (150mm) long and come in a 'strip' of 40 (4 pieces of each of ten rainbow colors). They have 0.1" male header contacts on either end and fit cleanly next to each other...
Out of Stock
[Buy Now](https://www.adafruit.com/product/758)
[Related Guides to the Product](https://learn.adafruit.com/products/758/guides)
### STEMMA Wired Potentiometer Breakout Board - 10K ohm Linear
[STEMMA Wired Potentiometer Breakout Board - 10K ohm Linear](https://www.adafruit.com/product/4493)
For the easiest way possible to measure twists, turn to this STEMMA potentiometer breakout (ha!). This plug-n-play pot comes with a JST-PH 2mm connector and a matching [JST PH 3-Pin to Male Header Cables - 200mm](https://www.adafruit.com/product/3893), so wiring up is a cinch....
Out of Stock
[Buy Now](https://www.adafruit.com/product/4493)
[Related Guides to the Product](https://learn.adafruit.com/products/4493/guides)
### Adafruit MCP9808 High Accuracy I2C Temperature Sensor Breakout
[Adafruit MCP9808 High Accuracy I2C Temperature Sensor Breakout](https://www.adafruit.com/product/5027)
The MCP9808 digital temperature sensor is one of the more accurate/precise we've ever seen, with a typical accuracy of ±0.25°C over the sensor's -40°C to +125°C range and precision of +0.0625°C. They work great with any microcontroller using standard I2C. With...
Out of Stock
[Buy Now](https://www.adafruit.com/product/5027)
[Related Guides to the Product](https://learn.adafruit.com/products/5027/guides)
### STEMMA QT / Qwiic JST SH 4-Pin Cable - 50mm Long
[STEMMA QT / Qwiic JST SH 4-Pin Cable - 50mm Long](https://www.adafruit.com/product/4399)
This 4-wire cable is 50mm / 1.9" long and fitted with JST SH female 4-pin connectors on both ends. Compared with the chunkier JST PH these are 1mm pitch instead of 2mm, but still have a nice latching feel, while being easy to insert and remove.
In Stock
[Buy Now](https://www.adafruit.com/product/4399)
[Related Guides to the Product](https://learn.adafruit.com/products/4399/guides)
### SD/MicroSD Memory Card (8 GB SDHC)
[SD/MicroSD Memory Card (8 GB SDHC)](https://www.adafruit.com/product/1294)
Add mega-storage in a jiffy using this 8 GB class 4 micro-SD card. It comes with a SD adapter so you can use it with any of our shields or adapters. Preformatted to FAT so it works out of the box with our projects. Tested and works great with our
In Stock
[Buy Now](https://www.adafruit.com/product/1294)
[Related Guides to the Product](https://learn.adafruit.com/products/1294/guides)
### Adafruit I2S 3W Class D Amplifier Breakout - MAX98357A
[Adafruit I2S 3W Class D Amplifier Breakout - MAX98357A](https://www.adafruit.com/product/3006)
Listen to this good news - we now have an all in one digital audio amp breakout board that works incredibly well with the [Raspberry Pi](https://www.adafruit.com/category/105)! If you're looking for an easy and low cost way to get your digital sound files...
In Stock
[Buy Now](https://www.adafruit.com/product/3006)
[Related Guides to the Product](https://learn.adafruit.com/products/3006/guides)
### Mono Enclosed Speaker with Plain Wires - 3W 4 Ohm
[Mono Enclosed Speaker with Plain Wires - 3W 4 Ohm](https://www.adafruit.com/product/4445)
Listen up! This single 2.8" x 1.2" speaker is the perfect addition to any audio project where you need 4 ohm impedance and 3W or less of power. We particularly like these speakers as they are small and enclosed for good audio volume and quality. This speaker _does..._
In Stock
[Buy Now](https://www.adafruit.com/product/4445)
[Related Guides to the Product](https://learn.adafruit.com/products/4445/guides)
### NeoPixel Ring - 16 x 5050 RGB LED with Integrated Drivers
[NeoPixel Ring - 16 x 5050 RGB LED with Integrated Drivers](https://www.adafruit.com/product/1463)
Round and round and round they go! 16 ultra bright smart LED NeoPixels are arranged in a circle with 1.75" (44.5mm) outer diameter. The rings are 'chainable' - connect the output pin of one to the input pin of another. Use only one microcontroller pin to control as many as you can...
In Stock
[Buy Now](https://www.adafruit.com/product/1463)
[Related Guides to the Product](https://learn.adafruit.com/products/1463/guides)
### Hook-up Wire Spool Set - 22AWG Solid Core - 6 x 25 ft
[Hook-up Wire Spool Set - 22AWG Solid Core - 6 x 25 ft](https://www.adafruit.com/product/1311)
Perfect for bread-boarding, free wiring, etc. This box contains 6 spools of solid-core wire. The wire is easy to solder to and when bent it keeps its shape pretty well. We like to have a few spools of this stuff around which is why this set is quite nice! We suggest picking up wire strippers...
Out of Stock
[Buy Now](https://www.adafruit.com/product/1311)
[Related Guides to the Product](https://learn.adafruit.com/products/1311/guides)
# Adafruit Metro ESP32-S3
## Blink
In learning any programming language, you often begin with some sort of `Hello, World!` program. In CircuitPython, Hello, World! is blinking an LED. Blink is one of the simplest programs in CircuitPython. It involves three built-in modules, two lines of set up, and a short loop. Despite its simplicity, it shows you many of the basic concepts needed for most CircuitPython programs, and provides a solid basis for more complex projects. Time to get blinky!
## LED Location
The **red LED** (highlighted in red), labeled L on the board silk, is located towards the middle-top of the board.
## Blinking an LED
In the example below, click the **Download Project Bundle** button below to download the necessary libraries and the **code.py** file in a zip file. Extract the contents of the zip file, open the directory **CircuitPython\_Templates/blink/** and then click on the directory that matches the version of CircuitPython you're using and copy the contents of that directory to your **CIRCUITPY** drive.
Your **CIRCUITPY** drive should now look similar to the following image:
https://github.com/adafruit/Adafruit_Learning_System_Guides/blob/main/CircuitPython_Templates/blink/code.py
The built-in LED begins blinking!
Note that the code is a little less "Pythonic" than it could be. It could also be written as `led.value = not led.value` with a single `time.sleep(0.5)`. That way is more difficult to understand if you're new to programming, so the example is a bit longer than it needed to be to make it easier to read.
It's important to understand what is going on in this program.
First you `import` three modules: `time`, `board` and `digitalio`. This makes these modules available for use in your code. All three are built-in to CircuitPython, so you don't need to download anything to get started.
Next, you set up the LED. To interact with hardware in CircuitPython, your code must let the board know where to look for the hardware and what to do with it. So, you create a `digitalio.DigitalInOut()` object, provide it the LED pin using the `board` module, and save it to the variable `led`. Then, you tell the pin to act as an `OUTPUT`.
Finally, you create a `while True:` loop. This means all the code inside the loop will repeat indefinitely. Inside the loop, you set `led.value = True` which powers on the LED. Then, you use `time.sleep(0.5)` to tell the code to wait half a second before moving on to the next line. The next line sets `led.value = False` which turns the LED off. Then you use another `time.sleep(0.5)` to wait half a second before starting the loop over again.
With only a small update, you can control the blink speed. The blink speed is controlled by the amount of time you tell the code to wait before moving on using `time.sleep()`. The example uses `0.5`, which is one half of one second. Try increasing or decreasing these values to see how the blinking changes.
That's all there is to blinking an LED using CircuitPython!
# Adafruit Metro ESP32-S3
## Create Your settings.toml File
CircuitPython works with WiFi-capable boards to enable you to make projects that have network connectivity. This means working with various passwords and API keys. As of [CircuitPython 8](https://circuitpython.org/downloads), there is support for a **settings.toml** file. This is a file that is stored on your **CIRCUITPY** drive, that contains all of your secret network information, such as your SSID, SSID password and any API keys for IoT services. It is designed to separate your sensitive information from your **code.py** file so you are able to share your code without sharing your credentials.
CircuitPython previously used a **secrets.py** file for this purpose. The **settings.toml** file is quite similar.
Warning: Your **settings.toml** file should be stored in the main directory of your **CIRCUITPY** drive. It should not be in a folder.
## CircuitPython **settings.toml** File
This section will provide a couple of examples of what your **settings.toml** file should look like, specifically for CircuitPython WiFi projects in general.
The most minimal **settings.toml** file must contain your WiFi SSID and password, as that is the minimum required to connect to WiFi. Copy this example, paste it into your **settings.toml** , and update:
- `your_wifi_ssid`
- `your_wifi_password`
```auto
CIRCUITPY_WIFI_SSID = "your_wifi_ssid"
CIRCUITPY_WIFI_PASSWORD = "your_wifi_password"
```
Many CircuitPython network-connected projects on the Adafruit Learn System involve using Adafruit IO. For these projects, you must _also_ include your Adafruit IO username and key. Copy the following example, paste it into your settings.toml file, and update:
- `your_wifi_ssid`
- `your_wifi_password`
- `your_aio_username`
- `your_aio_key`
```auto
CIRCUITPY_WIFI_SSID = "your_wifi_ssid"
CIRCUITPY_WIFI_PASSWORD = "your_wifi_password"
ADAFRUIT_AIO_USERNAME = "your_aio_username"
ADAFRUIT_AIO_KEY = "your_aio_key"
```
Some projects use different variable names for the entries in the **settings.toml** file. For example, a project might use `ADAFRUIT_AIO_ID` in the place of `ADAFRUIT_AIO_USERNAME`. **If you run into connectivity issues, one of the first things to check is that the names in the settings.toml file match the names in the code.**
Warning: Not every project uses the same variable name for each entry in the **settings.toml** file! Always verify it matches the code.
## **settings.toml** File Tips
Here is an example **settings.toml** file.
```auto
# Comments are supported
CIRCUITPY_WIFI_SSID = "guest wifi"
CIRCUITPY_WIFI_PASSWORD = "guessable"
CIRCUITPY_WEB_API_PORT = 80
CIRCUITPY_WEB_API_PASSWORD = "passw0rd"
test_variable = "this is a test"
thumbs_up = "\U0001f44d"
```
In a **settings.toml** file, it's important to keep these factors in mind:
- Strings are wrapped in double quotes; ex: `"your-string-here"`
- Integers are _ **not** _ quoted and may be written in decimal with optional sign (`+1`, `-1`, `1000`) or hexadecimal (`0xabcd`).
- Floats (decimal numbers), octal (`0o567`) and binary (`0b11011`) are not supported.
- Use `\u` escapes for weird characters, `\x` and `\ooo` escapes are not available in **.toml** files
- Example: `\U0001f44d` for 👍 (thumbs up emoji) and `\u20ac` for € (EUR sign)
- Unicode emoji, and non-ASCII characters, stand for themselves as long as you're careful to save in "UTF-8 without BOM" format
When your **settings.toml ** file is ready, you can save it in your text editor with the **.toml** extension.
## Accessing Your **settings.toml** Information in **code.py**
In your **code.py** file, you'll need to `import` the `os` library to access the **settings.toml** file. Your settings are accessed with the `os.getenv()` function. You'll pass your settings entry to the function to import it into the **code.py** file.
```python
import os
print(os.getenv("test_variable"))
```
In the upcoming CircuitPython WiFi examples, you'll see how the **settings.toml ** file is used for connecting to your SSID and accessing your API keys.
# Adafruit Metro ESP32-S3
## CircuitPython Internet Test
One of the great things about most Espressif microcontrollers are their built-in WiFi capabilities. This page covers the basics of getting connected using CircuitPython.
The first thing you need to do is update your **code.py** to the following (it will error until WiFi details are added). Click the **Download Project Bundle** button to download the necessary libraries and the **code.py** file in a zip file. Extract the contents of the zip file, and copy the **entire** **lib** **folder** and the **code.py** file to your **CIRCUITPY** drive.
https://github.com/adafruit/Adafruit_Learning_System_Guides/blob/main/ESP32_S2_WiFi_Tests/CPy_Native_WiFi_Test/code.py
Your **CIRCUITPY** drive should resemble the following.
To get connected, the next thing you need to do is update the **settings.toml** file.
## The settings.toml File
We expect people to share tons of projects as they build CircuitPython WiFi widgets. What we want to avoid is people accidentally sharing their passwords or secret tokens and API keys. So, we designed all our examples to use a **settings.toml** file, that is on your **CIRCUITPY** drive, to hold secret/private/custom data. That way you can share your main project without worrying about accidentally sharing private stuff.
If you have a fresh install of CircuitPython on your board, the initial **settings.toml** file on your **CIRCUITPY** drive is empty.
To get started, you can update the **settings.toml** on your **CIRCUITPY** drive to contain the following code.
https://github.com/adafruit/Adafruit_Learning_System_Guides/blob/main/ESP32_S2_WiFi_Tests/CPy_Native_WiFi_Test/settings.toml
This file should contain a series of Python variables, each assigned to a string. Each variable should describe what it represents (say `wifi_ssid`), followed by an **= ** (equals sign), followed by the data in the form of a Python string (such as `"my-wifi-password"` including the quote marks).
**At a minimum you'll need to add/update your WiFi SSID and WiFi password, so do that now!**
As you make projects you may need more tokens and keys, just add them one line at a time. See for example other tokens such as one for accessing GitHub or the Hackaday API. Other non-secret data like your timezone can also go here.
For the correct time zone string, look at [http://worldtimeapi.org/timezones](http://worldtimeapi.org/timezones) and remember that if your city is not listed, look for a city in the same time zone, for example Boston, New York, Philadelphia, Washington DC, and Miami are all on the same time as New York.
Of course, don't share your **settings.toml** - keep that out of GitHub, Discord or other project-sharing sites.
Warning:
If you connect to the serial console, you should see something like the following:
In order, the example code...
Checks the ESP32's MAC address.
```python
print(f"My MAC address: {[hex(i) for i in wifi.radio.mac_address]}")
```
Performs a scan of all access points and prints out the access point's name (SSID), signal strength (RSSI), and channel.
```python
print("Available WiFi networks:")
for network in wifi.radio.start_scanning_networks():
print("\t%s\t\tRSSI: %d\tChannel: %d" % (str(network.ssid, "utf-8"),
network.rssi, network.channel))
wifi.radio.stop_scanning_networks()
```
Connects to the access point you defined in the **settings.toml** file, and prints out its local IP address.
```python
print(f"Connecting to {os.getenv('WIFI_SSID')}")
wifi.radio.connect(os.getenv("WIFI_SSID"), os.getenv("WIFI_PASSWORD"))
print(f"Connected to {os.getenv('WIFI_SSID')}")
print(f"My IP address: {wifi.radio.ipv4_address}")
```
Attempts to ping a Google DNS server to test connectivity. If a ping fails, it returns `None`. Initial pings can sometimes fail for various reasons. So, if the initial ping is successful (`is not None`), it will print the echo speed in ms. If the initial ping fails, it will try one more time to ping, and then print the returned value. If the second ping fails, it will result in `"Ping google.com: None ms"` being printed to the serial console. Failure to ping does not always indicate a lack of connectivity, so the code will continue to run.
```python
ping_ip = ipaddress.IPv4Address("8.8.8.8")
ping = wifi.radio.ping(ip=ping_ip) * 1000
if ping is not None:
print(f"Ping google.com: {ping} ms")
else:
ping = wifi.radio.ping(ip=ping_ip)
print(f"Ping google.com: {ping} ms")
```
The code creates a socketpool using the wifi radio's available sockets. This is performed so we don't need to re-use sockets. Then, it initializes a a new instance of the [requests](http://docs.python-requests.org/en/master/) interface - which makes getting data from the internet _really really easy._
```python
pool = socketpool.SocketPool(wifi.radio)
requests = adafruit_requests.Session(pool, ssl.create_default_context())
```
To read in plain-text from a web URL, call `requests.get` - you may pass in either a http, or a http **s** url for SSL connectivity.
```python
print(f"Fetching text from {TEXT_URL}")
response = requests.get(TEXT_URL)
print("-" * 40)
print(response.text)
print("-" * 40)
```
Requests can also display a JSON-formatted response from a web URL using a call to `requests.get`.
```python
print(f"Fetching json from {JSON_QUOTES_URL}")
response = requests.get(JSON_QUOTES_URL)
print("-" * 40)
print(response.json())
print("-" * 40)
```
Finally, you can fetch and parse a JSON URL using `requests.get`. This code snippet obtains the `stargazers_count` field from a call to the GitHub API.
```python
print(f"Fetching and parsing json from {JSON_STARS_URL}")
response = requests.get(JSON_STARS_URL)
print("-" * 40)
print(f"CircuitPython GitHub Stars: {response.json()['stargazers_count']}")
print("-" * 40)
```
OK you now have your ESP32 board set up with a proper **settings.toml** file and can connect over the Internet. If not, check that your **settings.toml** file has the right SSID and password and retrace your steps until you get the Internet connectivity working!
## IPv6 Networking
Starting in CircuitPython 9.2, IPv6 networking is available on most Espressif wifi boards. Socket-using libraries like **adafruit\_requests** and **adafruit\_ntp** will need to be updated to use the new APIs and for now can only connect to services on IPv4.
### IPv6 connectivity & privacy
IPv6 addresses are divided into many special kinds, and many of those kinds (like those starting with **FC** , **FD** , **FE** ) are private or local; Addresses starting with other prefixes like **2002:** and **2001:** are globally routable. In 2024, far from all ISPs and home networks support IPv6 internet connectivity. For more info consult resources like [Wikipedia](https://en.wikipedia.org/wiki/IPv6_address#Local_addresses). If you're interested in global IPv6 connectivity you can use services like [Hurricane Electric](https://www.he.net/) to create an "IPv6 tunnel" (free as of 2024, but requires expertise and a compatible router or host computer to set up)
It's also important to be aware that, as currently implemented by Espressif, there are privacy concerns especially when these devices operate on the global IPv6 network: The device's unique identifier (its EUI-64 or MAC address) is used by default as part of its IPv6 address. This means that the device identity can be tracked across multiple networks by any service it connects to.
### Enable IPv6 networking
Due to the privacy consideration, IPv6 networking is not automatically enabled. Instead, it must be explicitly enabled by a call to `start_dhcp_client` with the `ipv6=True` argument specified:
```python
wifi.start_dhcp_client(ipv6=True)
```
### Check IP addresses
The read-only `addresses` property of the `wifi.radio` object holds all addresses, including IPv4 and IPv6 addresses:
```python
>>> wifi.radio.addresses
('FE80::7EDF:A1FF:FE00:518C', 'FD5F:3F5C:FE50:0:7EDF:A1FF:FE00:518C', '10.0.3.96')
```
The `wifi.radio.dns` servers can be IPv4 or IPv6:
```python
>>> wifi.radio.dns
('FD5F:3F5C:FE50::1',)
>>> wifi.radio.dns = ("1.1.1.1",)
>>> wifi.radio.dns
('1.1.1.1',)
```
### Ping v6 networks
`wifi.radio.ping` accepts v6 addresses and names:
```python
>>> wifi.radio.ping("google.com")
0.043
>>> wifi.radio.ping("ipv6.google.com")
0.048
```
### Create & use IPv6 sockets
Use the address family `socket.AF_INET6`. After the socket is created, use methods like `connect`, `send`, `recfrom_into`, etc just like for IPv4 sockets. This code snippet shows communicating with a private-network NTP server; this IPv6 address will not work on your network:
```python
>>> ntp_addr = ("fd5f:3f5c:fe50::20e", 123)
>>> PACKET_SIZE = 48
>>>
>>> buf = bytearray(PACKET_SIZE)
>>> with socket.socket(socket.AF_INET6, socket.SOCK_DGRAM) as s:
... s.settimeout(1)
... buf[0] = 0b0010_0011
... s.sendto(buf, ntp_addr)
... print(s.recvfrom_into(buf))
... print(buf)
...
48
(48, ('fd5f:3f5c:fe50::20e', 123))
bytearray(b'$\x01\x03\xeb\x00\x00\x00\x00\x00\x00\x00GGPS\x00\xeaA0h\x07s;\xc0\x00\x00\x00\x00\x00\x00\x00\x00\xeaA0n\xeb4\x82-\xeaA0n\xebAU\xb1')
```
# Adafruit Metro ESP32-S3
## Adafruit IO Send and Receive Data
Adafruit IO gives you the option to disconnect your microcontroller from your computer and run it off of USB power or a battery, and still be able to see the data. It also allows you to send data to your microcontroller, such as NeoPixel colors. This example shows how to both send data to and receive data from Adafruit IO. It pulls from a "random" number generator and sends the "random" number _to_ Adafruit IO, while simultaneously listening for NeoPixel color data _from_ Adafruit IO.
## NeoPixel Location
The **NeoPixel** **LED** (highlighted in red), labeled Neo on the board silk, is located next to the JTAG connector.
## Adafruit IO Feeds and Dashboard
The first thing you'll need to do, is head over to [Adafruit IO](https://io.adafruit.com/) and make sure your account is set up.
Then, you need to [create two feeds](https://learn.adafruit.com/adafruit-io-basics-feeds/creating-a-feed) called **neopixel** and **random**. These are case sensitive!
Next, you'll [create a dashboard](https://learn.adafruit.com/adafruit-io-basics-dashboards/creating-a-dashboard) for the NeoPixel Color Picker. You can name the dashboard whatever you like.
Once the dashboard is created, you'll want to [add a color picker block](https://learn.adafruit.com/adafruit-io-basics-dashboards/adding-blocks). The color picker block is highlighted by a red arrow in the image below.
Once you choose the color picker block, you'll need to connect a feed to it. Check the box next to **neopixel**.
Finally, a Block Settings page will come up. You can add an optional block title here. Then you press **Create Block**.
The dashboard should look something like the following.
Now that things are set up on the Adafruit IO end, you can continue on to the code on your microcontroller!
## Adafruit IO settings.toml
This example requires you to provide your Wi-Fi credentials, and your Adafruit IO username and key. To do this, you'll want to create a **settings.toml** file on your **CIRCUITPY** drive.
To obtain your Adafruit IO key, follow [the initial steps on this page](https://learn.adafruit.com/adafruit-io-home-security/adafruit-io-setup).
Your **settings.toml** file should be structured in a certain way, and contain all the necessary information. Follow these instructions to [create your settings.toml file](https://learn.adafruit.com/pico-w-wifi-with-circuitpython/create-your-settings-toml-file).
## Adafruit IO Example Code
To run this example, you need to first install the NeoPixel, Adafruit IO, and Adafruit MiniMQTT libraries into the **lib** folder on your **CIRCUITPY** drive. Then you need to update **code.py** with the example script.
Thankfully, we can do this in one go. In the example below, click the **Download Project Bundle** button below to download the necessary libraries and the **code.py** file in a zip file. Extract the contents of the zip file, and copy the **entire** **lib** **folder** and the **code.py** file to your **CIRCUITPY** drive.
https://github.com/adafruit/Adafruit_Learning_System_Guides/blob/main/CircuitPython_Templates/adafruit_io_cpu_temp_neopixel_color/code.py
Your **CIRCUITPY/lib** folder should contain at least the following folders and files:
- **adafruit\_io/**
- **adafrruit\_minimqtt/**
- **neopixel.mpy**
If you like, you can [connect to the serial console](https://learn.adafruit.com/adafruit-esp32-s2-feather/kattni-connecting-to-the-serial-console) to see the connection info and current readings printed out.
## NeoPixel Color Change
To change the color of the NeoPixel, go to the NeoPixel Adafruit IO dashboard you created at the beginning, and click on the colored circle in the ColorPicker block. It will bring up the following.
You can move the dot in the box around, and the slider line across the gradient to choose the perfect color. Choose a new color and click **SAVE**.
The NeoPixel color will update, and you will see the new value printed to the serial console, as shown below.
## Code Walkthrough
This example contains three `try`/`except` blocks. These are included where the code is likely to fail due to WiFi or Adafruit IO connection failures. WiFi can be finicky, and without these code blocks, if the connection was lost, the code would crash. Instead, it is designed to reset the board and start the code over again to reestablish the connection, regardless of the cause. This ensures your code will continue running. The details of these blocks are explained below.
First you import all of the necessary modules and libraries.
```python
import time
import ssl
import os
from random import randint
import socketpool
import wifi
import board
import neopixel
import adafruit_minimqtt.adafruit_minimqtt as MQTT
from adafruit_io.adafruit_io import IO_MQTT
```
Info:
The WiFi attempts to connect, and prints the status to the serial console. If it connects successfully, the code continues onto the NeoPixel set up.
```python
try:
print("Connecting to %s" % os.getenv("CIRCUITPY_WIFI_SSID"))
wifi.radio.connect(os.getenv("CIRCUITPY_WIFI_SSID"), os.getenv("CIRCUITPY_WIFI_PASSWORD"))
print("Connected to %s!" % os.getenv("CIRCUITPY_WIFI_SSID"))
```
If the WiFi connection is not successful, the error will be printed to the serial console, and the board will hard reset after 30 seconds.
```python
except Exception as e: # pylint: disable=broad-except
print("Failed to connect to WiFi. Error:", e, "\nBoard will hard reset in 30 seconds.")
time.sleep(30)
microcontroller.reset()
```
Once the WiFi successfully connects, the NeoPixel object is initiated.
```python
pixel = neopixel.NeoPixel(board.NEOPIXEL, 1, brightness=0.3)
```
Following that are two callback methods. For more details, check out [this guide](https://learn.adafruit.com/mqtt-in-circuitpython/code-walkthrough#minimqtt-callback-methods-3034067-9). The `connected` method subscribes to the neopixel feed on Adafruit IO. The `message` callback checks for updates to the neopixel feed, and turns the pixel the color from the feed.
```python
def connected(client):
print("Connected to Adafruit IO! Listening for NeoPixel changes...")
# Subscribe to Adafruit IO feed called "neopixel"
client.subscribe("neopixel")
# pylint: disable=unused-argument
def message(client, feed_id, payload):
print("Feed {0} received new value: {1}".format(feed_id, payload))
if feed_id == "neopixel":
pixel.fill(int(payload[1:], 16))
```
You create a socket pool, use that to initialise the new MQTT Client object, and use that to initialise the Adafruit IO MQTT "helper".
```python
pool = socketpool.SocketPool(wifi.radio)
mqtt_client = MQTT.MQTT(
broker="io.adafruit.com",
username=os.getenv("ADAFRUIT_AIO_USERNAME"),
password=os.getenv("ADAFRUIT_AIO_KEY"),
socket_pool=pool,
ssl_context=ssl.create_default_context(),
)
io = IO_MQTT(mqtt_client)
```
You set up the callback methods mentioned above.
```python
io.on_connect = connected
io.on_message = message
```
Next, you attempt to connect the client to the MQTT broker. If connection is successful, the code continues on to the `timestamp`.
```python
try:
io.connect()
```
If the MQTT broker connection is not successful, the error is printed to the serial console, and the board will hard reset after 30 seconds.
```python
except Exception as e:
print("Failed to connect to Adafruit IO. Error:", e, "\nBoard will hard reset in 30 seconds.")
time.sleep(30)
microcontroller.reset()
```
Once the broker is connected, you set the `timestamp` to `0` immediately before the loop.
```python
timestamp = 0
```
Inside the loop, you attempt to do two things. You first explicitly poll the message loop. Check out [this guide](https://learn.adafruit.com/mqtt-in-circuitpython/advanced-minimqtt-usage#minimqtt-loop-3034264-1) for more details on that.
```python
while True:
try:
io.loop()
```
Second, you have a block of code that runs every 10 seconds. Inside, you obtain a "random" value between 0-255 inclusive, print it to the serial console, and publish it to an Adafruit IO feed. Finally, you reset timestamp so the block of code knows when another 10 seconds has passed, and runs again.
```python
[...]
if (time.monotonic() - timestamp) >= 10:
random_number = "{}".format(randint(0, 255))
print("Current 'random' number: {}".format(random_number))
io.publish("random", random_number)
timestamp = time.monotonic()
```
If at any time WiFi or Adafruit IO disconnects, the code will print the error to the serial console, and the board will hard reset after 30 seconds.
```python
[...]
except Exception as e:
print("Failed to get or send data, or connect. Error:", e,
"\nBoard will hard reset in 30 seconds.")
time.sleep(30)
microcontroller.reset()
```
That's all there is to using CircuitPython and Adafruit IO to send data to Adafruit IO, and receive data from it!
# Adafruit Metro ESP32-S3
## Digital Input
The CircuitPython `digitalio` module has many applications. The basic Blink program sets up the LED as a digital output. You can just as easily set up a **digital input** such as a button to control the LED. This example builds on the basic Blink example, but now includes setup for a button switch. Instead of using the `time` module to blink the LED, it uses the status of the button switch to control whether the LED is turned on or off.
## LED and Button
**Built-in LED:**
- The **built-in red LED** (indicated by the magenta box in the image), labeled L on the silk, is located near the digital pin 12 label.
**Button wiring:**
- **One leg of button** to **Metro** **GND**
- **Opposite leg of button** to **Metro A0**
## Controlling the LED with a Button
https://github.com/adafruit/Adafruit_Learning_System_Guides/blob/main/Adafruit_Metro_ESP32-S3/Digital_Input/code.py
Now, press the button. The LED lights up! Let go of the button and the LED turns off.
Note that the code is a little less "Pythonic" than it could be. It could also be written as `led.value = not button.value`. That way is more difficult to understand if you're new to programming, so the example is a bit longer than it needed to be to make it easier to read.
First you `import` two modules: `board` and `digitalio`. This makes these modules available for use in your code. Both are built-in to CircuitPython, so you don't need to download anything to get started.
Next, you set up the LED. To interact with hardware in CircuitPython, your code must let the board know where to look for the hardware and what to do with it. So, you create a `digitalio.DigitalInOut()` object, provide it the LED pin using the `board` module, and save it to the variable `led`. Then, you tell the pin to act as an `OUTPUT`.
You include setup for the button as well. It is similar to the LED setup, except the button is an `INPUT`, and requires a pull up.
Inside the loop, you check to see if the button is pressed, and if so, turn on the LED. Otherwise the LED is off.
That's all there is to controlling an LED with a button switch!
# Adafruit Metro ESP32-S3
## Analog In
Your microcontroller board has both digital and analog signal capabilities. Some pins are analog, some are digital, and some are capable of both. Check the **Pinouts** page in this guide for details about your board.
Analog signals are different from digital signals in that they can be _any_ voltage and can vary continuously and smoothly between voltages. An analog signal is like a dimmer switch on a light, whereas a digital signal is like a simple on/off switch.
Digital signals only can ever have two states, they are either are **on** (high logic level voltage like 3.3V) or **off** (low logic level voltage like 0V / ground).
By contrast, analog signals can be any voltage in-between on and off, such as 1.8V or 0.001V or 2.98V and so on.
Analog signals are continuous values which means they can be an _infinite_ number of different voltages. Think of analog signals like a floating point or fractional number, they can smoothly transiting to _any_ in-between value like 1.8V, 1.81V, 1.801V, 1.8001V, 1.80001V and so forth to infinity.
Many devices use analog signals, in particular sensors typically output an analog signal or voltage that varies based on something being sensed like light, heat, humidity, etc.
## Analog to Digital Converter (ADC)
An analog-to-digital-converter, or ADC, is the key to reading analog signals and voltages with a microcontroller. An ADC is a device that reads the voltage of an analog signal and converts it into a digital, or numeric, value. The microcontroller can’t read analog signals directly, so the analog signal is first converted into a numeric value by the ADC.
The black line below shows a digital signal over time, and the red line shows the converted analog signal over the same amount of time.
Once that analog signal has been converted by the ADC, the microcontroller can use those digital values any way you like!
## Potentiometers
A potentiometer is a small variable resistor that you can twist a knob or shaft to change its resistance. It has three pins. By twisting the knob on the potentiometer you can change the resistance of the middle pin (called the wiper) to be anywhere within the range of resistance of the potentiometer.
By wiring the potentiometer to your board in a special way (called a voltage divider) you can turn the change in resistance into a change in voltage that your board’s analog to digital converter can read.
To wire up a potentiometer as a voltage divider:
- Connect **one outside pin** to **ground**
- Connect **the other outside pin** to **voltage in (e.g. 3.3V)**
- Connect **the middle pin** to **an analog pin (e.g. A0)**
## Hardware
In addition to your microcontroller board, you will need the following hardware to follow along with this example.
**Potentiometer**
### STEMMA Wired Potentiometer Breakout Board - 10K ohm Linear
[STEMMA Wired Potentiometer Breakout Board - 10K ohm Linear](https://www.adafruit.com/product/4493)
For the easiest way possible to measure twists, turn to this STEMMA potentiometer breakout (ha!). This plug-n-play pot comes with a JST-PH 2mm connector and a matching [JST PH 3-Pin to Male Header Cables - 200mm](https://www.adafruit.com/product/3893), so wiring up is a cinch....
Out of Stock
[Buy Now](https://www.adafruit.com/product/4493)
[Related Guides to the Product](https://learn.adafruit.com/products/4493/guides)
## Wire Up the Potentiometer
Connect the potentiometer to your board as follows.
- **Potentiometer left pin (white wire)** to **Metro D3**
- **Potentiometer center pin (red wire)** to **Metro 3.3V**
- **Potentiometer right pin (black wire)** to **Metro GND**
## Reading Analog Pin Values
CircuitPython makes it easy to read analog pin values. Simply import two modules, set up the pin, and then print the value inside a loop.
You'll need to [connect to the serial console](https://learn.adafruit.com/welcome-to-circuitpython/kattni-connecting-to-the-serial-console) to see the values printed out.
In the example below, click the **Download Project Bundle** button below to download the necessary libraries and the **code.py** file in a zip file. Extract the contents of the zip file, open the directory **CircuitPython\_Templates/analog\_pin\_values/** and then click on the directory that matches the version of CircuitPython you're using and copy the contents of that directory to your **CIRCUITPY** drive.
Your **CIRCUITPY** drive should now look similar to the following image:
https://github.com/adafruit/Adafruit_Learning_System_Guides/blob/main/CircuitPython_Templates/analog_pin_values/code.py
Warning:
To update the pin, you will change `A0` to `D3` on the `analog_pin` line. The code should now look like the following.
https://github.com/adafruit/Adafruit_Learning_System_Guides/blob/main/Adafruit_Metro_ESP32-S3/analog_in/analog_value/code.py
Now, rotate the potentiometer to see the values change.
What do these values mean? In CircuitPython ADC values are put into the range of 16-bit unsigned values. This means the possible values you’ll read from the ADC fall within the range of 0 to 65535 (or 2^16 - 1). When you twist the potentiometer knob to be near ground, or as far to the left as possible, you see a value close to zero.
When you twist it as far to the right as possible, near 3.3 volts, you see a value close to 65535. You’re seeing almost the full range of 16-bit values!
The code is simple. You begin by importing three modules: `time`, `board` and `analogio`. All three modules are built into CircuitPython, so you don't need to download anything to get started.
Then, you set up the analog pin by creating an `analogio.AnalogIn()` object, providing it the desired pin using the `board` module, and saving it to the variable `analog_pin`.
Finally, in the loop, you print out the analog value with `analog_pin.value`, including a `time.sleep()` to slow down the values to a human-readable rate.
## Reading Analog Voltage Values
These values don't necessarily equate to anything obvious. You can get an idea of the rotation of the potentiometer based on where in the range the value falls, but not without doing some math. Remember, you wired up the potentiometer as a voltage divider. By adding a simple function to your code, you can get a more human-readable value from the potentiometer.
You'll need to [connect to the serial console](https://learn.adafruit.com/welcome-to-circuitpython/kattni-connecting-to-the-serial-console) to see the values printed out.
https://github.com/adafruit/Adafruit_Learning_System_Guides/blob/main/Adafruit_Metro_ESP32-S3/analog_in/get_voltage/code.py
Now, rotate the potentiometer to see the values change.
Now the values range from around 0 to 3.3! Note that you may not get all the way to 0 or 3.3. This is normal.
The example code begins with the same imports and pin setup.
This time, you include the `get_voltage` helper. This function requires that you provide an analog pin. It then maps the raw analog values, `0` to `65535`, to the voltage values, `0` to `3.3`. It does the math so you don't have to!
Finally, inside the loop, you provide the function with your `analog_pin`, and print the resulting values.
That's all there is to reading analog voltage values using CircuitPython!
# Adafruit Metro ESP32-S3
## NeoPixel LED
Your board has a built-in RGB NeoPixel status LED. You can use CircuitPython code to control the color and brightness of this LED. It is also used to indicate the bootloader status and errors in your CircuitPython code.
A NeoPixel is what Adafruit calls the WS281x family of addressable RGB LEDs. It contains three LEDs - a red one, a green one and a blue one - along side a driver chip in a tiny package controlled by a single pin. They can be used individually (as in the built-in LED on your board), or chained together in strips or other creative form factors. NeoPixels do not light up on their own; they require a microcontroller. So, it's super convenient that the NeoPixel is built in to your microcontroller board!
This page will cover using CircuitPython to control the status RGB NeoPixel built into your microcontroller. You'll learn how to change the color and brightness, and how to make a rainbow. Time to get started!
## NeoPixel Location
The **NeoPixel** **LED** (highlighted in red), labeled Neo on the board silk, is located next to the JTAG connector.
## NeoPixel Color and Brightness
To use with CircuitPython, you need to first install a few libraries, into the **lib** folder on your **CIRCUITPY** drive. Then you need to update **code.py** with the example script.
Thankfully, we can do this in one go. In the example below, click the **Download Project Bundle** button below to download the necessary libraries and the **code.py** file in a zip file. Extract the contents of the zip file, open the directory **CircuitPython\_Templates/status\_led\_one\_neopixel\_rgb/** and then click on the directory that matches the version of CircuitPython you're using and copy the contents of that directory to your **CIRCUITPY** drive.
Your **CIRCUITPY** drive should now look similar to the following image:
https://github.com/adafruit/Adafruit_Learning_System_Guides/blob/main/CircuitPython_Templates/status_led_one_neopixel_rgb/code.py
The built-in NeoPixel begins blinking red, then green, then blue, and repeats!
First you import two modules, `time` and `board`, and one library, `neopixel`. This makes these modules and libraries available for use in your code. The first two are modules built-in to CircuitPython, so you don't need to download anything to use those. The `neopixel` library is separate, which is why you needed to install it before getting started.
Next, you set up the NeoPixel LED. To interact with hardware in CircuitPython, your code must let the board know where to look for the hardware and what to do with it. So, you create a `neopixel.NeoPixel()` object, provide it the NeoPixel LED pin using the `board` module, and tell it the number of LEDs. You save this object to the variable `pixel`.
Then, you set the NeoPixel brightness using the `brightness` attribute. `brightness` expects float between `0` and `1.0`. A _float_ is essentially a number with a decimal in it. The brightness value represents a percentage of maximum brightness; `0` is 0% and `1.0` is 100%. Therefore, setting `pixel.brightness = 0.3` sets the brightness to 30%. The default brightness, which is to say the brightness if you don't explicitly set it, is `1.0`. The default is really bright! That is why there is an option available to easily change the brightness.
Inside the loop, you turn the NeoPixel red for 0.5 seconds, green for 0.5 seconds, and blue for 0.5 seconds.
To turn the NeoPixel red, you "fill" it with an RGB value. Check out the section below for details on RGB colors. The RGB value for red is `(255, 0, 0)`. Note that the RGB value includes the parentheses. The `fill()` attribute expects the full RGB value including those parentheses. That is why there are two pairs of parentheses in the code.
You can change the RGB values to change the colors that the NeoPixel cycles through. Check out the list below for some examples. You can make any color of the rainbow with the right RGB value combination!
That's all there is to changing the color and setting the brightness of the built-in NeoPixel LED!
## RGB LED Colors
RGB LED colors are set using a combination of **r** ed, **g** reen, and **b** lue, in the form of an ( **R** , **G** , **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 an 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. If you increase all values to the same level, you get white! If you decrease all the values to 0, you turn the LED off.
Common colors include:
- red: `(255, 0, 0)`
- green: `(0, 255, 0)`
- blue: `(0, 0, 255)`
- cyan: `(0, 255, 255)`
- purple: `(255, 0, 255)`
- yellow: `(255, 255, 0)`
- white: `(255, 255, 255)`
- black (off): `(0, 0, 0)`
## NeoPixel Rainbow
You should have already installed the library necessary to use the built-in NeoPixel LED. If not, follow the steps at the beginning of the NeoPixel Color and Brightness section to install it.
In the example below, click the **Download Project Bundle** button below to download the necessary libraries and the **code.py** file in a zip file. Extract the contents of the zip file, open the directory **CircuitPython\_Templates/status\_led\_one\_neopixel\_rainbow/** and then click on the directory that matches the version of CircuitPython you're using and copy the contents of that directory to your **CIRCUITPY** drive.
Your **CIRCUITPY** drive should now look similar to the following image:
https://github.com/adafruit/Adafruit_Learning_System_Guides/blob/main/CircuitPython_Templates/status_led_one_neopixel_rainbow/code.py
The NeoPixel displays a rainbow cycle!
This example builds on the previous example.
First, you import the same three modules and libraries. In addition to those, you import `colorwheel`.
The NeoPixel hardware setup and brightness setting are the same.
Next, you have the `rainbow()` helper function. This helper displays the rainbow cycle. It expects a `delay` in seconds. The higher the number of seconds provided for `delay`, the slower the rainbow will cycle. The helper cycles through the values of the color wheel to create a rainbow of colors.
Inside the loop, you call the rainbow helper with a 0.2 second delay, by including `rainbow(0.2)`.
That's all there is to making rainbows using the built-in NeoPixel LED!
# Adafruit Metro ESP32-S3
## I2C
The **I2C** , or [inter-integrated circuit](https://en.wikipedia.org/wiki/I%C2%B2C), is a 2-wire protocol for communicating with simple sensors and devices, which means it uses two connections, or wires, for transmitting and receiving data. One connection is a clock, called **SCL**. The other is the data line, called **SDA**. Each pair of clock and data pins are referred to as a **bus**.
Typically, there is a device that acts as a **controller** and sends requests to the **target** devices on each bus. In this case, your microcontroller board acts as the controller, and the sensor breakout acts as the target. Historically, the controller is referred to as the master, and the target is referred to as the slave, so you may run into that terminology elsewhere. The official terminology is [controller and target](https://adafruit.com/controller-peripheral).
**Multiple I2C devices can be connected to the same clock and data lines.** Each I2C device has an address, and as long as the addresses are different, you can connect them at the same time. This means you can have many different sensors and devices all connected to the same two pins.
**Both I2C connections require pull-up resistors** , and most Adafruit I2C sensors and breakouts have pull-up resistors built in. If you're using one that does not, you'll need to add your own 2.2-10kΩ pull-up resistors from SCL and SDA to 3.3V.
## I2C and CircuitPython
CircuitPython supports many I2C devices, and makes it super simple to interact with them. There are libraries available for many I2C devices in the [CircuitPython Library Bundle](https://circuitpython.readthedocs.io/projects/bundle/en/latest/#table-of-contents). (If you don't see the sensor you're looking for, keep checking back, more are being written all the time!)
In this section, you'll learn how to scan the I2C bus for all connected devices. Then you'll learn how to interact with an I2C device.
## Necessary Hardware
You'll need the following additional hardware to complete the examples on this page.
### Adafruit MCP9808 High Accuracy I2C Temperature Sensor Breakout
[Adafruit MCP9808 High Accuracy I2C Temperature Sensor Breakout](https://www.adafruit.com/product/5027)
The MCP9808 digital temperature sensor is one of the more accurate/precise we've ever seen, with a typical accuracy of ±0.25°C over the sensor's -40°C to +125°C range and precision of +0.0625°C. They work great with any microcontroller using standard I2C. With...
Out of Stock
[Buy Now](https://www.adafruit.com/product/5027)
[Related Guides to the Product](https://learn.adafruit.com/products/5027/guides)
### STEMMA QT / Qwiic JST SH 4-Pin Cable - 50mm Long
[STEMMA QT / Qwiic JST SH 4-Pin Cable - 50mm Long](https://www.adafruit.com/product/4399)
This 4-wire cable is 50mm / 1.9" long and fitted with JST SH female 4-pin connectors on both ends. Compared with the chunkier JST PH these are 1mm pitch instead of 2mm, but still have a nice latching feel, while being easy to insert and remove.
In Stock
[Buy Now](https://www.adafruit.com/product/4399)
[Related Guides to the Product](https://learn.adafruit.com/products/4399/guides)
While the examples here will be using the [Adafruit MCP9808](https://www.adafruit.com/product/5027), a high accuracy temperature sensor, the overall process is the same for just about any I2C sensor or device.
The first thing you'll want to do is get the sensor connected so your board has I2C to talk to.
## Wiring the MCP9808
The MCP9808 comes with a STEMMA QT connector, which makes wiring it up quite simple and solder-free.
Simply connect the STEMMA QT cable from **the STEMMA QT port on your board** to **the STEMMA QT port on the MCP9808**.
## Find Your Sensor
The first thing you'll want to do after getting the sensor wired up, is make sure it's wired correctly. You're going to do an I2C scan to see if the board is detected, and if it is, print out its I2C address.
Save the following to your **CIRCUITPY** drive as **code.py**.
Click the **Download Project Bundle** button below to download the necessary libraries and the **code.py** file in a zip file. Extract the contents of the zip file, find your CircuitPython version, and copy the matching **code.py** file to your **CIRCUITPY** drive.
Your **CIRCUITPY** drive should now look similar to the following image:
https://github.com/adafruit/Adafruit_Learning_System_Guides/blob/main/CircuitPython_Templates/i2c_scan/code.py
The Metro ESP32-S3 comes with one I2C sensor built in: MAX17048. The I2C scan code will show the addresses from the built in sensor and the MCP9808.
If you run this and it seems to hang, try manually unlocking your I2C bus by running the following two commands from the REPL.
```terminal
import board
board.I2C().unlock()
```
First you create the `i2c` object, using `board.I2C()`. This convenience routine creates and saves a `busio.I2C` object using the default pins `board.SCL` and `board.SDA`. If the object has already been created, then the existing object is returned. No matter how many times you call `board.I2C()`, it will return the same object. This is called a _singleton_.
To be able to scan it, you need to lock the I2C down so the only thing accessing it is the code. So next you include a loop that waits until I2C is locked and then continues on to the scan function.
Last, you have the loop that runs the actual scan, `i2c_scan()`. Because I2C typically refers to addresses in hex form, the example includes 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. You've connected the MCP9808 which has a 7-bit I2C address of 0x18. The result for this sensor is `I2C addresses found: ['0x18']`. 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 you know for certain that your sensor is connected and ready to go. Time to find out how to get the data from the sensor!
Save the following to your **CIRCUITPY** drive as **code.py**.
Click the **Download Project Bundle** button below to download the necessary libraries and the **code.py** file in a zip file. Extract the contents of the zip file, find your CircuitPython version, and copy the matching **entire** **lib** **folder** and **code.py** file to your **CIRCUITPY** drive.
Your **CIRCUITPY** drive should now look similar to the following image:
https://github.com/adafruit/Adafruit_Learning_System_Guides/blob/main/CircuitPython_Templates/i2c_mcp9808/code.py
This code begins the same way as the scan code, except this time, you create your sensor object using the sensor library. You call it `mcp9808` and provide it the `i2c` object.
Then you have a simple loop that prints out the temperature reading using the sensor object you created. Finally, there's a `time.sleep(2)`, so it only prints once every two seconds. Connect to the serial console to see the results. Try touching the MCP9808 with your finger to see the values change!
## Where's my I2C?
On many microcontrollers, you have the flexibility of using a wide range of pins for I2C. On some types of microcontrollers, any pin can be used for I2C! Other chips require using bitbangio, but can also use any pins for I2C. There are further microcontrollers that may have fixed I2C pins.
Given the many different types of microcontroller boards available, it's impossible to guarantee anything other than the labeled 'SDA' and 'SCL' pins. So, if you want some other setup, or multiple I2C interfaces, how will you find those pins? Easy! Below is a handy script.
Save the following to your **CIRCUITPY** drive as **code.py**.
Click the **Download Project Bundle** button below to download the necessary libraries and the **code.py** file in a zip file. Extract the contents of the zip file, find your CircuitPython version, and copy the matching **code.py** file to your **CIRCUITPY** drive.
Your **CIRCUITPY** drive should now look similar to the following image:
https://github.com/adafruit/Adafruit_Learning_System_Guides/blob/main/CircuitPython_Templates/i2c_find_pins/code.py
Now, 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 support I2C.
Primary:
Info:
# Adafruit Metro ESP32-S3
## I2C: Onboard MAX17048
Your microcontroller board comes with an **MAX17048 lithium ion polymer (lipoly) battery monitor** built right onto the board. The MAX17048 is available over I2C.
The MAX17048 comes with its own Adafruit CircuitPython library that makes it simple to write code to read data from it. This example will be using, among other things, the [Adafruit CircuitPython MAX1704x](https://github.com/adafruit/Adafruit_CircuitPython_MAX1704x) library.
The example simply reads data from the battery monitor and prints it to the serial console. It is designed to show you how to get data from the battery monitor.
## MAX17048 Location
The **MAX17048 battery monitor** (highlighted in red) is located next to the 3.7V Lipoly label on the board silk. Its I2C address is **0x36**.
# MAX17048 Simple Data Example
To run this example, you need to first install the MAX1704x library into the **lib** folder on your **CIRCUITPY** drive. Then you need to update **code.py** with the example script.
Thankfully, we can do this in one go. In the example below, click the **Download Project Bundle** button below to download the necessary libraries and the **code.py** file in a zip file. Extract the contents of the zip file, and copy the **entire** **lib** **folder** and the **code.py** file to your **CIRCUITPY** drive.
Your **CIRCUITPY/lib** folder should contain at least the following folder and file:
- **adafruit\_bus\_device/**
- **adafruit\_register/**
- **adafruit\_max1704x.mpy**
https://github.com/adafruit/Adafruit_Learning_System_Guides/blob/main/CircuitPython_Templates/max17048/code.py
Info:
Now, [connect to the serial console](https://learn.adafruit.com/adafruit-esp32-s2-feather/kattni-connecting-to-the-serial-console) to see the battery data printed out!
That's all there is to reading the MAX17048 data using CircuitPython!
For more details, check out the guide for the [MAX17048](https://learn.adafruit.com/adafruit-max17048-lipoly-liion-fuel-gauge-and-battery-monitor/python-circuitpython).
# Adafruit Metro ESP32-S3
## SD Card
Warning:
Warning: As of CircuitPython 9, a mount point (folder) named **/sd** is required on the **CIRCUITPY** drive. Make sure to create that directory after upgrading CircuitPython.
[Follow these steps to create the /sd directory](https://learn.adafruit.com/adafruit-memento-camera-board/circuitpython-memento-starter-projects)
Your board comes with a built in MicroSD card slot! Adding a MicroSD card allows you to include more files, music, images, videos etc. than the flash on the board can hold. You can use a MicroSD card with CircuitPython and the [Adafruit\_CircuitPython\_SD](https://github.com/adafruit/Adafruit_CircuitPython_SD) module. This module allows you to easily write Python code that lets you read and write to an attached MicroSD card.
## MicroSD Card Slot
The **MicroSD card slot** (highlighted in red), labeled MicroSD on the board silk, is located above the analog pins in the lower right corner of the board.
Info:
### 512MB micro SD Memory Card
[512MB micro SD Memory Card](https://www.adafruit.com/product/5252)
Add storage in a jiffy using this **512MB** microSD card. Preformatted to FAT32, so it works out of the packaging with our projects. Works great with any device in the Adafruit shop that uses microSD cards. Ideal for use with Feathers, data loggers, or small Linux SBCs (not good...
In Stock
[Buy Now](https://www.adafruit.com/product/5252)
[Related Guides to the Product](https://learn.adafruit.com/products/5252/guides)
## CircuitPython Usage
To use with CircuitPython, you need to first install the **adafruit\_sdcard** library, and its dependencies, into the **lib** folder on your **CIRCUITPY** drive. Then you need to update **code.py** with the example script.
Thankfully, we can do this in one go. In the example below, click the **Download Project Bundle** button below to download the necessary libraries and the **code.py** file in a zip file. Extract the contents of the zip file, and copy the **entire lib folder** and the **code.py** file to your **CIRCUITPY** drive.
Your **CIRCUITPY/lib** folder should contain the following folders and files:
- **/adafruit\_bus\_device**
- **adafruit\_sdcard.mpy**
## SD Card Read Test
Once everything is saved to the **CIRCUITPY** drive, [connect to the serial console](https://learn.adafruit.com/welcome-to-circuitpython/kattni-connecting-to-the-serial-console) to see the data printed out!
https://github.com/adafruit/Adafruit_Learning_System_Guides/blob/main/Adafruit_Metro_ESP32-S3/SDCard/SD_Read/code.py
In this read test for the SD card, the filesystem on the SD card is mounted and read. Then, the contents of the filesystem are printed to the REPL.
## SD Card Write Test
https://github.com/adafruit/Adafruit_Learning_System_Guides/blob/main/Adafruit_Metro_ESP32-S3/SDCard/SD_Write/code.py
In this example, the code is writing data to the SD card. The microcontroller CPU temperature is printed to the REPL and logged to a text file on the SD card. After running the code, you can read the text file from the SD card. You'll see that the text file matches what was printed to the REPL.
# Adafruit Metro ESP32-S3
## Capacitive Touch
Your microcontroller board has capacitive touch capabilities on multiple pins. The CircuitPython `touchio` module makes it simple to detect when you touch a pin, enabling you to use it as an input.
This section first covers using the `touchio` module to read touches on one pin. You'll learn how to setup the pin in your program, and read the touch status. Then, you'll learn how to read touches on multiple pins in a single example. Time to get started!
# One Capacitive Touch Pin
The first example covered here will show you how to read touches on one pin.
## Pin Wiring
Capacitive touch always benefits from the use of a 1MΩ pulldown resistor. Some microcontrollers have pulldown resistors built in, but using the built-in ones can yield unexpected results. Other microcontrollers to not have built-in pulldowns, and require an external pulldown resistor. Therefore, the best option is to include one regardless.
- **One leg of 1MΩ resistor** to **Metro A0**
- **Opposite leg of 1MΩ resistor** to **Metro GND**
## Reading Touch on the Pin
https://github.com/adafruit/Adafruit_Learning_System_Guides/blob/main/Adafruit_Metro_ESP32-S3/Capacitive_Touch/One_Pin/code.py
Warning:
Now touch the pin indicated in the diagram above. You'll see `Pin touched!` printed to the serial console!
First you `import` three modules: `time`, `board` and `touchio`. This makes these modules available for use in your code. All three are built-in to CircuitPython, so you don't find any library files in the Project Bundle.
Next, you create the `touchio.TouchIn()` object, and provide it the pin name using the `board` module. You save that to the `touch` variable.
Inside the loop, you check to see if the pin is touched. If so, you print to the serial console. Finally, you include a `time.sleep()` to slow it down a bit so the output is readable.
That's all there is to reading touch on a single pin using `touchio` in CircuitPython!
# Multiple Capacitive Touch Pins
The next example shows you how to read touches on multiple pins in a single program.
## Pin Wiring
- **One leg of first 1MΩ resistor** to **Metro A0**
- **Opposite leg of first 1MΩ resistor** to **Metro GND**
- **One leg of second 1MΩ resistor** to **Metro A5**
- **Opposite leg of second 1MΩ resistor** to **Metro GND**
## Reading Touch on the Pins
https://github.com/adafruit/Adafruit_Learning_System_Guides/blob/main/Adafruit_Metro_ESP32-S3/Capacitive_Touch/Two_Pins/code.py
Warning:
Touch the pins to see the messages printed to the serial console!
This example builds on the first. The imports remain the same.
The `touchio.TouchIn()` object is created, but is instead saved to `touch_one`. A second `touchio.TouchIn()` object is also created, the second pin is provided to it using the `board` module, and is saved to `touch_two`.
Inside the loop, we check to see if pin one and pin two are touched, and if so, print to the serial console `Pin one touched!` and `Pin two touched!`, respectively. The same `time.sleep()` is included.
If more touch-capable pins are available on your board, you can easily add them by expanding on this example!
## Where are my Touch-Capable pins?
There are specific pins on a microcontroller that support capacitive touch. How do you know which pins will work? Easy! Run the script below to get a list of all the pins that are available.
Save the following to your **CIRCUITPY** drive as **code.py**.
Click the **Download Project Bundle** button below to download the necessary libraries and the **code.py** file in a zip file. Extract the contents of the zip file, find your CircuitPython version, and copy the matching **code.py** file to your **CIRCUITPY** drive.
Your **CIRCUITPY** drive should now look similar to the following image:
https://github.com/adafruit/Adafruit_Learning_System_Guides/blob/main/CircuitPython_Templates/cap_touch_pin_script/code.py
Now, connect to the serial console and check out the output! The results print out a nice handy list of pins that support capacitive touch.
## Setting Touch Threshold Manually
In some cases, the ESP32-S3 fails to calibrate the touch threshold properly on board startup. In those cases, the board running this code will show the pin as touched (printed in the serial console) when you are not touching it. In this event, you can set the threshold manually. Setting the threshold manually involves two steps: obtaining the current touch `threshold` and `raw_value`, and setting the `threshold` once that information is known.
First, add the following to your code inside the loop (after the `while True:` which is included below for reference). The following code works exactly as-is for the one-pin example. Duplicate these two lines, and update `touch` to `touch_one` and `touch_two` for the two-pin example.
```python
while True:
print(touch.raw_value)
print(touch.threshold)
```
Now, if you haven't already, connect to the serial console. You will see two new lines of information printed out. Make a mental note of what the current threshold is. The more important piece of information is the raw value. Note what the value is when you are not touching the pin. Now, touch the pin, and make a note of that value. The value you choose for updating `threshold` should be higher than when you are not touching the pin, and lower than when you are.
Once you've chosen your value, you can delete the lines you added above. Then, add the following line of code BEFORE the loop, but after the touch object is created. Replace `NEW_VALUE` with the value you chose based on the data provided. Again, for use with the two-pin example, duplicate these two lines, and update `touch` to `touch_one` and `touch_two`.
```python
touch.threshold = NEW_VALUE
```
Now, your board should automatically reload, and you should see nothing printed to the serial console. Try touching the pin. `Pin touched!`
If you're still seeing it printing to the serial console when not touched, try changing the `threshold` value to something higher than you currently have.
That's all there is to manually setting the threshold for a touch pin!
# Adafruit Metro ESP32-S3
## Storage
CircuitPython-compatible microcontrollers show up as a **CIRCUITPY** drive when plugged into your computer, allowing you to edit code directly on the board. Perhaps you've wondered whether or not you can write data _from CircuitPython_ directly to the board to act as a data logger. The answer is **yes**!
The `storage` module in CircuitPython enables you to write code that allows CircuitPython to write data to the **CIRCUITPY** drive. This process requires you to include a **boot.py** file on your **CIRCUITPY** drive, along side your **code.py** file.
The **boot.py** file is special - the code within it is executed when CircuitPython starts up, either from a hard reset or powering up the board. It is not run on soft reset, for example, if you reload the board from the serial console or the REPL. This is in contrast to the code within **code.py** , which is executed after CircuitPython is already running.
The **CIRCUITPY** drive is typically writable by your computer; this is what allows you to edit your code directly on the board. The reason you need a **boot.py** file is that you have to set the filesystem to be read-only by your computer to allow it to be writable by CircuitPython. This is because CircuitPython cannot write to the filesystem at the same time as your computer. Doing so can lead to filesystem corruption and loss of all content on the drive, so CircuitPython is designed to only allow one at at time.
Danger:
## The boot.py File
Info:
https://github.com/adafruit/Adafruit_Learning_System_Guides/blob/main/Adafruit_Metro_ESP32-S3/Storage/boot.py
The `storage.remount()` command has a `readonly` keyword argument. **This argument refers to the read/write state of CircuitPython.** It does NOT refer to the read/write state of your computer.
When the physical pin is connected to ground, it returns `False`. The `readonly` argument in boot.py is set to the `value` of the pin. When the `value=True`, the CIRCUITPY drive is read-only to CircuitPython (and writable by your computer). **When the `value=False`, the CIRCUITPY drive is writable by CircuitPython** (an read-only by your computer).
## The code.py File
Save the following as **code.py** on your **CIRCUITPY** drive.
https://github.com/adafruit/Adafruit_Learning_System_Guides/blob/main/Adafruit_Metro_ESP32-S3/Storage/code.py
First you import the necessary modules to make them available to your code, and you set up the LED.
Next you have a `try`/`except` block, which is used to handle the three potential states of the board: read/write, read-only, or filesystem full. The code in the `try` block will run if the filesystem is writable by CircuitPython. The code in the `except` block will run if the filesystem is read-only to CircuitPython OR if the filesystem is full.
Under the `try`, you open a **temperature.txt ** log file. If it is the first time, it will create the file. For all subsequent times, it opens the file and appends data. Inside the loop, you get the microcontroller temperature value and assign it to a `temperature` variable. Then, you write the temperature value to the log file, followed by clearing the buffer for the next time through the loop. The temperature data is limited to two decimal points to save space for more data. Finally, you turn the LED on for one second, and then turn it off for the next nine seconds. Essentially, you blink the LED for one second every time the temperature is logged to the file which happens every ten seconds.
Next you `except` an `OSError`. An `OSError` number 30 is raised when trying to create, open or write to a file on a filesystem that is read-only to CircuitPython. If any `OSError` other than 28 is raised (e.g. 30), the `delay` is set to 0.5 seconds. If the filesystem fills up, CircuitPython raises `OSError` number 28. If `OSError` number 28 is raised, the `delay` is set to 0.15 seconds. Inside the loop, the LED is turned on for the duration of the `delay`, and turned off for the duration of the `delay`, effectively blinking the LED at the speed of the `delay`.
## Logging the Temperature
At the moment, the LED on your board should be blinking once every half second. This indicates that the board is currently read-only to CircuitPython, and writable to your computer, allowing you to update the files on your **CIRCUITPY** drive as needed.
The way the code in **boot.py** works is, it checks to see if the pin is connected to ground when the board is powered on. To begin logging the temperature, you must connect the pin to ground.
- Connect **GND** to **A0**.
Once the pin is connected to ground, you need to either hard reset the board by pressing the reset button, or by unplugging the USB cable and plugging it back in. This will run the code within **boot.py** and set your board to writable by CircuitPython, and therefore, read-only by the computer.
The blinking will slow down to one second long, every 10 seconds. This indicates that the board is currently logging the temperature, once every 10 seconds.
As long as the pin is connected to ground, you can plug the board in anywhere you have USB power, and log the temperature in that location! The temperature is not the ambient temperature; it is the temperature inside the microcontroller, which will typically be higher than ambient temperature. However, running only this code, once the microcontroller temperature stabilises, it should at least be consistent, and therefore usable for tracking _changes_ in ambient temperature.
If the LED starts blinking really quickly, it means the filesystem is full! You'll need to get your temperature data and delete the temperature log file to begin again.
That's all there is to logging the temperature using CircuitPython!
## Recovering a Read-Only Filesystem
In the event that you make your **CIRCUITPY** drive read-only to your computer, and for some reason, it doesn't easily switch back to writable, there are a couple of things you can do to recover the filesystem.
Even when the **CIRCUITPY** drive is read-only to your computer, you can still access the serial console and REPL. If you connect to the serial console and enter the REPL, you can run **either** of the following two sets of commands at the `>>>` prompt. You do not need to run both.
First, you can rename your **boot.py** file to something other than **boot.py**.
```python
import os
os.rename("boot.py", "something_else.py")
```
Alternatively, you can remove the **boot.py** file altogether.
```python
import os
os.remove("boot.py")
```
Then, restart the board by either hitting the reset button or unplugging USB and plugging it back in. **CIRCUITPY** should show up on your computer as usual, but now it should be writable by your computer.
# Adafruit Metro ESP32-S3
## I2S
Danger:
**I2S** , or Inter-IC Sound, is a standard for transmitting digital audio data. It requires at least three connections. The first connection is a clock, called **bit clock** ( **BCLK** , or sometimes written as serial clock or SCK) **.** The second connection, which determines the channel (left or right) being sent, is called **word select** ( **WS** ). When stereo data is sent, WS is toggled so that the left and right channels are sent alternately, one data word at a time. The third connection, which transmits the data, is called **serial data** ( **SD** ).
Typically, there is a **transmitter** device which generates the bit clock, word select signal, and the data, and sends them to a **receiver** device. In this case, your microcontroller acts as the transmitter, and an I2S breakout acts as the receiver. The [MAX98357A](https://www.adafruit.com/product/3006) is an example of an I2S class D amplifier that allows you to connect directly to a speaker such as [this one](https://www.adafruit.com/product/4445).
## I2S and CircuitPython
CircuitPython supports sending I2S audio signals using the `audiobusio` module, making it simple to use the I2S interface with your microcontroller.
In this section, you'll learn how to use CircuitPython to play different types of audio using I2S, including tones and WAV files.
## Necessary Hardware
You'll need the following additional hardware to complete the examples on this page.
### Adafruit I2S 3W Class D Amplifier Breakout - MAX98357A
[Adafruit I2S 3W Class D Amplifier Breakout - MAX98357A](https://www.adafruit.com/product/3006)
Listen to this good news - we now have an all in one digital audio amp breakout board that works incredibly well with the [Raspberry Pi](https://www.adafruit.com/category/105)! If you're looking for an easy and low cost way to get your digital sound files...
In Stock
[Buy Now](https://www.adafruit.com/product/3006)
[Related Guides to the Product](https://learn.adafruit.com/products/3006/guides)
### Mono Enclosed Speaker with Plain Wires - 3W 4 Ohm
[Mono Enclosed Speaker with Plain Wires - 3W 4 Ohm](https://www.adafruit.com/product/4445)
Listen up! This single 2.8" x 1.2" speaker is the perfect addition to any audio project where you need 4 ohm impedance and 3W or less of power. We particularly like these speakers as they are small and enclosed for good audio volume and quality. This speaker _does..._
In Stock
[Buy Now](https://www.adafruit.com/product/4445)
[Related Guides to the Product](https://learn.adafruit.com/products/4445/guides)
### Premium Male/Male Jumper Wires - 20 x 6" (150mm)
[Premium Male/Male Jumper Wires - 20 x 6" (150mm)](https://www.adafruit.com/product/1957)
These Male/Male Jumper Wires are handy for making wire harnesses or jumpering between headers on PCB's. These premium jumper wires are 6" (150mm) long and come in a 'strip' of 20 (2 pieces of each of ten rainbow colors). They have 0.1" male header contacts on either...
In Stock
[Buy Now](https://www.adafruit.com/product/1957)
[Related Guides to the Product](https://learn.adafruit.com/products/1957/guides)
## Wiring the MAX98357A
Connect the MAX98357A breakout to your microcontroller as follows.
Info:
- **Board 3V** to **breakout VIN**
- **Board GND** to **breakout GND**
- **Board A0** to **breakout BCLK**
- **Board A1** to **breakout LRC**
- **Board A2** to **breakout DIN**
- **Speaker +** to **screw terminal +**
- **Speaker -** to **screw terminal -**
## I2S Tone Playback
The first example generates one period of a sine wave and then loops it to generate a tone. You can change the volume and the frequency (in Hz) of the tone by changing the associated variables. Inside the loop, you play the tone for one second and stop it for one second.
Update your **code.py** to the following.
Click the **Download Project Bundle** button below to download the necessary libraries and the **code.py** file in a zip file. Extract the contents of the zip file, open the folder that matches your CircuitPython version, and copy the **code.py** file to your **CIRCUITPY** drive.
https://github.com/adafruit/Adafruit_Learning_System_Guides/blob/main/Adafruit_Metro_ESP32-S3/I2S/Tone_Playback/code.py
Now you'll hear one second of a 440Hz tone, and one second of silence.
You can try changing the `440` Hz of the tone to produce a tone of a different pitch. Try changing the number of seconds in `time.sleep()` to produce longer or shorter tones.
## I2S WAV File Playback
The second example plays a WAV file. You open the file in a readable format. Then, you play the file and, once finished, print `Done playing!` to the serial console. You can use any [supported wave file](https://learn.adafruit.com/circuitpython-essentials/circuitpython-audio-out#play-a-wave-file).
Update your **code.py** to the following.
Click the **Download Project Bundle** button below to download the necessary libraries and the **code.py** file in a zip file. Extract the contents of the zip file, open the folder that matches your CircuitPython version, and copy the **StreetChicken.wav** file and the **code.py** file to your **CIRCUITPY** drive.
https://github.com/adafruit/Adafruit_Learning_System_Guides/blob/main/Adafruit_Metro_ESP32-S3/I2S/WAV_Playback/code.py
Now you'll hear the wave file play, and on completion, print `Done Playing!` to the serial console.
You can play a different WAV file by updating `"StreetChicken.wav"` to be the name of your CircuitPython-compatible WAV file.
You can do other things while the WAV file plays! There is a `pass` in this example where you can include other code, such as code to blink an LED.
## CircuitPython I2S-Compatible Pin Combinations
I2S audio is supported on specific pins. The good news is, there's a simple way to find out which pins support audio playback.
In the example below, click the **Download Project Bundle** button below to download the necessary libraries and the **code.py** file in a zip file. Extract the contents of the zip file, open the directory **CircuitPython\_Templates/i2s\_find\_pins/** and then click on the directory that matches the version of CircuitPython you're using and copy the contents of that directory to your **CIRCUITPY** drive.
Your **CIRCUITPY** drive should now look similar to the following image:
Then, [connect to the serial console](https://learn.adafruit.com/welcome-to-circuitpython/kattni-connecting-to-the-serial-console) to see a list of pins printed out. This file runs only once, so if you do not see anything in the output, press CTRL+D to reload and run the code again.
https://github.com/adafruit/Adafruit_Learning_System_Guides/blob/main/CircuitPython_Templates/i2s_find_pins/code.py
For details about the I2S API, check out the [CircuitPython docs](https://circuitpython-jake.readthedocs.io/en/latest/shared-bindings/audiobusio/I2SOut.html).
# Adafruit Metro ESP32-S3
## asyncio
CircuitPython uses the **asyncio** library to support [cooperative multitasking](https://learn.adafruit.com/cooperative-multitasking-in-circuitpython-with-asyncio/overview#cooperative-multitasking-3106163-5) in CircuitPython, which includes the `async` and `await` language keywords. _Cooperative multitasking_ is a style of programming in which multiple _tasks_ take turns running. Each task runs until it needs to wait for something, or until it decides it has run for long enough and should let another task run.
In cooperative multitasking, a _scheduler_ manages the tasks. Only one task runs at a time. When a task gives up control and starts waiting, the scheduler starts another task that is ready to run. The scheduler runs an _event loop_ which repeats this process over and over for all the tasks assigned to the event loop.
A task is a kind of [coroutine](https://learn.adafruit.com/cooperative-multitasking-in-circuitpython-with-asyncio/overview#coroutines-3106285-7). A _coroutine_ can stop in the middle of some code. When the coroutine is called again, it starts where it left off. A coroutine is declared with the keyword `async`, and the keyword `await` indicates that the coroutine is giving up control at that point.
This diagram shows the scheduler, running an event loop, with three tasks: Task 1 is running, Task 2 is ready to run, and is waiting for Task 1 to give up control, and Task 3 is waiting for something else, and isn't ready to run yet.
## asyncio Demonstration
The example on this page demonstrates a basic use of asyncio. This uses a microcontroller and a button to control two animations displayed on two different NeoPixel rings. One ring displays a rainbow swirl, and the other displays a blink animation at a 0.5 second interval. Pressing the button reverses the direction of the rainbow swirl, and speeds up the blink animation to a 0.1 second interval. Releasing the button returns both to their initial states.
## Wiring
The first step is wiring up the button and NeoPixel rings to your microcontroller.
**NeoPixel Rings**
- **NeoPixel ring one: data in (DIN)** to **microcontroller A1**
- **NeoPixel ring one: ground** to **microcontroller GND**
- **NeoPixel ring one: V+** to **microcontroller 3V**
- **NeoPixel ring two: data in (DIN)** to **microcontroller A2**
- **NeoPixel ring two: ground** to **microcontroller GND**
- **NeoPixel ring two: V+** to **microcontroller 3V**
**Button**
- **One leg of button** to **microcontroller A0**
- **Opposite leg of button** to **microcontroller GND**
## asyncio Example Code
Once everything is wired up, the next step is to load the example code onto your microcontroller.
To run this example, you'll need to include a few libraries onto your **CIRCUITPY** drive. Then you need to update **code.py** with the example code.
Thankfully, this can be done in one go. In the example below, click the **Download Project Bundle** button below to download the necessary libraries and the **code.py** file in a zip file. Extract the contents of the zip file, and copy the **entire** **lib** **folder** and the **code.py** file to your **CIRCUITPY** drive.
https://github.com/adafruit/Adafruit_Learning_System_Guides/blob/main/Adafruit_Metro_ESP32-S3/asyncio/code.py
Your **CIRCUITPY** drive contents should resemble the image below.
You should have at least the following file in the top level of the **CIRCUITPY** drive:
- **code.py**
Your **CIRCUITPY/lib** folder should contain at least the following folder and files:
- **asyncio/**
- **adafruit\_ticks.mpy**
- **neopixel.mpy**
Ring one will light up in a rainbow swirl. Ring two will begin blinking blue at a 0.5 second interval.
Now, press the button. The rainbow swirl on ring one will reverse direction, and the blinking on ring two will speed up!
Now release the button. The rainbow swirl on ring one returns to its original direction, and the blinking on ring two returns to its original speed!
## Code Walkthrough
First you import the necessary modules and libraries.
```python
import asyncio
import board
import neopixel
import keypad
from rainbowio import colorwheel
```
Then, you specify the button pin, the number of LEDs in each NeoPixel ring, and the LED brightness.
```python
button_pin = board.A0
num_pixels = 16
brightness = 0.2
```
Next you set up the two NeoPixel rings on pins `A1` and `A2`, using the number of pixels and brightness specified above, and setting `auto_write=False`.
```python
ring_one = neopixel.NeoPixel(board.A1, num_pixels, brightness=brightness, auto_write=False)
ring_two = neopixel.NeoPixel(board.A2, num_pixels, brightness=brightness, auto_write=False)
```
Following set up, you create a class called `AnimationControls`. This class provides ways to control the animations with asyncio.
```python
class AnimationControls:
def __init__(self):
self.reverse = False
self.wait = 0.0
self.delay = 0.5
```
Then, you have the rainbow and blink animation code. This is where the asyncio-specific code begins.
In terms of the animation parts of the code, the first function is the rainbow cycle animation code. This is pretty standard except for the second line of code. In this example, the line beginning with `for j in` includes non-standard code for the rainbow cycle in reverse: `range(255, -1, -1) if controls.reverse`, followed by the standard forward rainbow cycle code - `range(0, 256, 1)`.
```python
async def rainbow_cycle(controls):
"""Rainbow cycle animation on ring one."""
while True:
for j in range(255, -1, -1) if controls.reverse else range(0, 256, 1):
for i in range(num_pixels):
rc_index = (i * 256 // num_pixels) + j
ring_one[i] = colorwheel(rc_index & 255)
ring_one.show()
await asyncio.sleep(controls.wait)
```
The second function is the blink animation code. This is typical. You fill all the NeoPixel LEDs blue, delay for a specified amount of time, then turn all of the LEDs off, and delay for the same specified amount of time.
```python
async def blink(controls):
"""Blink animation on ring two."""
while True:
ring_two.fill((0, 0, 255))
ring_two.show()
await asyncio.sleep(controls.delay)
ring_two.fill((0, 0, 0))
ring_two.show()
await asyncio.sleep(controls.delay)
await asyncio.sleep(controls.wait)
```
In both functions, you must call `show()` on the NeoPixel ring object to get the animations to run because you set `auto_write=False` in the NeoPixel ring setup.
Notice that the controls object provides the animation direction (`controls.reverse`), the delay between steps of the animation (`controls.delay`), and the delay between complete animations (`controls.wait`).
In terms of the asyncio-specific parts of this code, you'll notice that both of these functions begin with `async def`. Every function that contains an `await` must be defined as `async def`, to indicate that it's a coroutine.
Both functions contain one or more `await` lines. What does `await` mean? `await` means "I need to wait for something; let other tasks run until I'm ready to resume." Both include `await asyncio.sleep()`. Basically, when when the code goes to "sleep", another task can be run. When the `sleep()` is over, this coroutine will resume.
The `blink()` includes the following line of code twice, which utilizes the `.delay` attribute of the `AnimationsControl` object.
```python
await asyncio.sleep(controls.delay)
```
Both functions end with the following line of code which utilizes the `.wait` attribute of the `AnimationsControl` object.
```python
await asyncio.sleep(controls.wait)
```
The next function is called `main()`.
In `main()`, first create a task. For the `button_task`, instantiate the `monitor_button()` coroutine by calling it with the arguments desired, and then pass that coroutine to `asyncio.create_task()`. `create_task()` wraps the coroutine in a task, and then schedules the task to run "soon". "Soon" means it will get a turn to run as soon other existing tasks have given up control.
Then the program uses `await asyncio.gather()`, which waits for all the tasks it's passed to finish.
```python
async def main():
animation_controls = AnimationControls()
button_task = asyncio.create_task(monitor_button(button_pin, animation_controls))
animation_task = asyncio.create_task(rainbow_cycle(animation_controls))
blink_task = asyncio.create_task(blink(animation_controls))
await asyncio.gather(button_task, animation_task, blink_task)
```
Finally, `run` the `main()` function to execute the code within.
```python
asyncio.run(main())
```
## My program ended? What happened?
`await.gather(...)` runs until all the listed tasks have finished. If `gather` completes, that means all the tasks listed have finished.
The most common causes of a task ending are:
- an exception occurred causing the task to end
- the task function finished
If you want to ensure the task executes forever, have a loop in your task function (e.g. a `while True` loop).
The following example is greatly oversimplified, but demonstrates what including a loop in your task function might look like.
```python
async def never_ending_task():
while True:
print("I'm looping!")
await asyncio.sleep(0)
```
# Adafruit Metro ESP32-S3
## CPU Temperature
There is a temperature sensor built into the CPU on your microcontroller board. It reads the internal CPU temperature, which varies depending on how long the board has been running or how intense your code is.
CircuitPython makes it really simple to read this data from the temperature sensor built into the microcontroller. Using the built-in `microcontroller` module, you can easily read the temperature.
## Microcontroller Location
The **ESP32-S3 microcontroller module** (highlighted in red) is located on the left side of the board.
## Reading the Microcontroller Temperature
The data is read using two lines of code. All necessary modules are built into CircuitPython, so you don't need to download any extra files to get started.
[Connect to the serial console](https://learn.adafruit.com/welcome-to-circuitpython/kattni-connecting-to-the-serial-console), and then update your **code.py** to the following.
In the example below, click the **Download Project Bundle** button below to download the necessary libraries and the **code.py** file in a zip file. Extract the contents of the zip file, open the directory **CircuitPython\_Templates/cpu\_temperature/** and then click on the directory that matches the version of CircuitPython you're using and copy the contents of that directory to your **CIRCUITPY** drive.
Your **CIRCUITPY** drive should now look similar to the following image:
https://github.com/adafruit/Adafruit_Learning_System_Guides/blob/main/CircuitPython_Templates/cpu_temperature/code.py
The CPU temperature in Celsius is printed out to the serial console!
Try putting your finger on the microcontroller to see the temperature change.
The code is simple. First you import two modules: `time` and `microcontroller`. Then, inside the loop, you print the microcontroller CPU temperature, and the `time.sleep()` slows down the print enough to be readable. That's it!
You can easily print out the temperature in Fahrenheit by adding a little math to your code, using this simple formula: Celsius \* (9/5) + 32.
In the example below, click the **Download Project Bundle** button below to download the necessary libraries and the **code.py** file in a zip file. Extract the contents of the zip file, open the directory **CircuitPython\_Templates/cpu\_temperature\_f/** and then click on the directory that matches the version of CircuitPython you're using and copy the contents of that directory to your **CIRCUITPY** drive.
Your **CIRCUITPY** drive should now look similar to the following image:
https://github.com/adafruit/Adafruit_Learning_System_Guides/blob/main/CircuitPython_Templates/cpu_temperature_f/code.py
The CPU temperature in Fahrenheit is printed out to the serial console!
That's all there is to reading the CPU temperature using CircuitPython!
# Adafruit Metro ESP32-S3
## Arduino IDE Setup
Warning:
The first thing you will need to do is to download the latest release of the Arduino IDE. You will need to be using **version 1.8** or higher for this guide
[Arduino IDE Download](http://www.arduino.cc/en/Main/Software)
To use the ESP32-S2/S3 with Arduino, you'll need to follow the steps below for your operating system. You can also [check out the Espressif Arduino repository for the most up to date details on how to install it](https://github.com/espressif/arduino-esp32#using-through-arduino-ide).
After you have downloaded and installed ** the latest version of Arduino IDE** , you will need to start the IDE and navigate to the **Preferences** menu. You can access it from the **File** menu in _Windows_ or _Linux_, or the **Arduino** menu on _OS X_.
A dialog will pop up just like the one shown below.
We will be adding a URL to the new **Additional Boards Manager URLs** option. The list of URLs is comma separated, and _you will only have to add each URL once._ New Adafruit boards and updates to existing boards will automatically be picked up by the Board Manager each time it is opened. The URLs point to index files that the Board Manager uses to build the list of available & installed boards.
To find the most up to date list of URLs you can add, you can visit the list of [third party board URLs on the Arduino IDE wiki](https://github.com/arduino/Arduino/wiki/Unofficial-list-of-3rd-party-boards-support-urls#list-of-3rd-party-boards-support-urls). We will only need to add one URL to the IDE in this example, but _ **you can add multiple URLS by separating them with commas** _. Copy and paste the link below into the **Additional Boards Manager URLs** option in the Arduino IDE preferences.
`https://raw.githubusercontent.com/espressif/arduino-esp32/gh-pages/package_esp32_index.json`
If you're an advanced hacker and want the 'bleeding edge' release that may have fixes (or bugs!) you can check out the dev url instead:
`https://raw.githubusercontent.com/espressif/arduino-esp32/gh-pages/package_esp32_dev_index.json`
If you have multiple boards you want to support, say ESP8266 and Adafruit, have both URLs in the text box separated by a comma (,)
Once done click **OK** to save the new preference settings.
The next step is to actually install the Board Support Package (BSP). Go to the **Tools → Board → Board Manager** submenu. A dialog should come up with various BSPs. Search for **esp32**. Choose the latest version, which may be later than the version shown in the screenshot below.
Click the **Install** button and wait for it to finish. Once it is finished, you can close the dialog.
In the **Tools → Board** submenu you should see **ESP32 Arduino** and in that dropdown it should contain the ESP32 boards along with all the latest ESP32-S2/S3 boards.
Look for the board called Adafruit Metro ESP32-S3.
## Manually Resetting ESP32-S3 Boards
Due to an issue in the Espressif code base, boards with an ESP32-S3 need to be manually reset after uploading code from the Arduino IDE. After your code has been uploaded to the ESP32-S3, press the reset button. After pressing the reset button, your code will begin running.
For additional information, you can track [the issue](https://github.com/espressif/arduino-esp32/issues/6762) on GitHub in the arduino-esp32 repository.
Warning:
# Adafruit Metro ESP32-S3
## Arduino Blink
The first and most basic program you can upload to your Arduino is the classic Blink sketch. This takes something on the board and makes it, well, blink! On and off. It's a great way to make sure everything is working and you're uploading your sketch to the right board and right configuration.
When all else fails, you can always come back to Blink!
# Pre-Flight Check: Get Arduino IDE & Hardware Set Up
This lesson assumes you have Arduino IDE set up. This is a generalized checklist, some elements may not apply to your hardware. If you haven't yet, check the previous steps in the guide to make sure you:
- **Install the very latest Arduino IDE for Desktop** (not all boards are supported by the Web IDE so we don't recommend it).
- **Install any board support packages (BSP) required for your hardware.** Some boards are built in defaults on the IDE, but lots are not! You may need to install plug-in support which is called the BSP.
- **Get a Data/Sync USB cable for connecting your hardware.** A _significant_ amount of problems folks have stem from not having a USB cable with data pins. Yes, these cursed cables roam the land, making your life hard. If you find a USB cable that doesn't work for data/sync, _throw it away immediately_! There is no need to keep it around, cables are very inexpensive these days.
- **Install any drivers required** - If you have a board with a FTDI or CP210x chip, you may need to get separate drivers. If your board has native USB, it probably doesn't need anything. After installing, reboot to make sure the driver sinks in.
- **Connect the board to your computer.** If your board has a power LED, make sure its lit. Is there a power switch? Make sure its turned On!
Make sure the on/off switch is ON! The green ON LED will be lit when the board is on.
# Start up Arduino IDE and Select Board/Port
OK now you are prepared! Open the Arduino IDE on your computer. Now you have to tell the IDE what board you are using, and how you want to connect to it.
In the IDE find the **Tools** menu. You will use this to select the board. If you switch boards, you _must switch the selection!_ So always double-check before you upload code in a new session.
# New Blink Sketch
OK lets make a new blink sketch! From the **File** menu, select **New**
Then in the new window, copy and paste this text:
```auto
int led = LED_BUILTIN;
void setup() {
// Some boards work best if we also make a serial connection
Serial.begin(115200);
// set LED to be an output pin
pinMode(led, OUTPUT);
}
void loop() {
// Say hi!
Serial.println("Hello!");
digitalWrite(led, HIGH); // turn the LED on (HIGH is the voltage level)
delay(500); // wait for a half second
digitalWrite(led, LOW); // turn the LED off by making the voltage LOW
delay(500); // wait for a half second
}
```
Info:
One note you'll see is that we reference the LED with the constant `LED_BUILTIN` rather than a number. That's because, historically, the built in LED was on pin 13 for Arduinos. But in the decades since, boards don't always have a pin 13, or maybe it could not be used for an LED. So the LED could have moved to another pin. It's best to use `LED_BUILTIN` so you don't get the pin number confused!
The LED is on pin 13.
# Verify (Compile) Sketch
OK now you can click the Verify button to convert the sketch into binary data to be uploaded to the board.
Note that Verifying a sketch is the same as Compiling a sketch - so we will use the words interchangeably
During verification/compilation, the computer will do a bunch of work to collect all the libraries and code and the results will appear in the bottom window of the IDE.
If something went wrong with compilation, you will get red warning/error text in the bottom window letting you know what the error was. It will also highlight the line with an error.
For example, here I had the wrong board selected - and the selected board does not have a built in LED!
Here's another common error, in my haste I forgot to add a `;` at the end of a line. The compiler warns me that it's looking for one - note that the error is actually a few lines up!
Info:
On success you will see something like this white text output and the message **Done compiling.** in the message area.
# Upload Sketch
Once the code is verified/compiling cleanly you can upload it to your board. Click the **Upload** button.
Warning:
The IDE will try to compile the sketch again for good measure, then it will try to connect to the board and upload a the file.
**This is actually one of the hardest parts for beginners because it's where a lot of things can go wrong.**
However, lets start with what it looks like on success! Here's what your board upload process looks like when it goes right:
Often times you will get a warning like this, which is kind of vague:
`No device found on COM66` (or whatever port is selected)
`An error occurred while uploading the sketch`
This could be a few things.
**First up, check again that you have the correct board selected!** Many electronics boards have very similar names or look, and often times folks grab a board different from what they thought.
If you're positive the right board is selected, we recommend the next step is to put the board into manual bootloading mode.
## Native USB and manual bootloading
Historically, microcontroller boards contained two chips: the main micro chip (say, ATmega328 or ESP8266 or ESP32) and a separate chip for USB interface that would be used for bootloading (a CH430, FT232, CP210x, etc). With these older designs, the microcontroller is put into a bootloading state for uploading code by the separate chip. It allows for easier uploading but is more expensive as two chips are needed, and also the microcontroller can't act like a keyboard or disk drive.
Modern chips often have 'native' USB - that means that there is no separate chip for USB interface. It's all in one! Great for cost savings, simplicity of design, reduced size and more control. However, it means the chip must be self-aware enough to be able to put _itself_ into bootload/upload mode on its own. That's fine 99% of the time but is very likely you will at some point get the board into an odd state that makes it too confused to bootload.
Warning:
Before continuing we _really, really_ suggest turning on **Verbose Upload** messages, it will help in this process because you will be able to see what the IDE is trying to do. It's a checkbox in the **Preferences** menu.
## Enter Manual Bootload Mode
OK now you know it's probably time to try manual bootloading. No problem! Here is how you do that for this board:
To enter the bootloader:
1. **Press and hold the BOOT/DFU button down.** Don't let go of it yet!
2. **Press and release the Reset button.** You should still have the BOOT/DFU button pressed while you do this.
3. **Now you can release the BOOT/DFU button.**
Once you are in manual bootload mode, go to the Tools menu, and make sure you have selected the bootloader serial port. **It is almost certain that the serial port has changed now that the bootloader is enabled**
Now you can try uploading again!
Info:
This time, you should have success!
After uploading this way, be sure to **click the reset button** - it sort of makes sure that the board got a good reset and will come back to life nicely.
Warning:
It's also a good idea to try to re-upload the sketch again now that you've performed a manual bootload to get the chip into a good state. It should perform an auto-reset the second time, so you don't have to manually bootload again.
# Finally, a Blink!
OK it was a journey but now we're here and you can enjoy your blinking LED. Next up, try to change the delay between blinks and re-upload. It's a good way to make sure your upload process is smooth and practiced.
# Adafruit Metro ESP32-S3
## I2C Scan Test
A lot of sensors, displays, and devices can connect over I2C. I2C is a 2-wire 'bus' that allows multiple devices to all connect on one set of pins so it's very convenient for wiring!
When using your board, you'll probably want to connect up I2C devices, and it can be a little tricky the first time. The best way to debug I2C is go through a checklist and then perform an I2C scan
# Common I2C Connectivity Issues
- **Have you connected four wires (at a minimum) for each I2C device?** Power the device with whatever is the logic level of your microcontroller board (probably 3.3V), then a ground wire, and a SCL clock wire, and and a SDA data wire.
- **If you're using a STEMMA QT board - check if the power LED is lit.** It's usually a green LED to the left side of the board.
- **Does the STEMMA QT/I2C port have switchable power or pullups?** To reduce power, some boards have the ability to cut power to I2C devices or the pullup resistors. Check the documentation if you have to do something special to turn on the power or pullups.
- **If you are using a DIY I2C device, do you have pullup resistors?** Many boards do _not_ have pullup resistors built in and they are _required!_ We suggest any common 2.2K to 10K resistors. You'll need two: one each connects from SDA to positive power, and SCL to positive power. Again, positive power (a.k.a VCC, VDD or V+) is often 3.3V
- **Do you have an address collision?** You can only have _one_ board per address. So you cannot, say, connect two AHT20's to one I2C port because they have the same address and will interfere. Check the sensor or documentation for the address. Sometimes there are ways to adjust the address.
- **Does your board have multiple I2C ports?** Historically, boards only came with one. But nowadays you can have two or even three! This can help solve the "hey, but what if I want two devices with the same address" problem: just put one on each bus.
- **Are you hot-plugging devices?** I2C does _not_ support dynamic re-connection, you cannot connect and disconnect sensors as you please. They should all be connected on boot and not change. ([Only exception is if you're using a hot-plug assistant but that'll cost you](https://www.adafruit.com/product/5159)).
- **Are you keeping the total bus length reasonable?** I2C was designed for maybe 6" max length. We like to push that with plug-n-play cables, but really please keep them as short as possible! ([Only exception is if you're using an active bus extender](https://www.adafruit.com/product/4756)).
# Perform an I2C scan!
### Install TestBed Library
To scan I2C, the Adafruit TestBed library is used. This library and example just makes the scan a little easier to run because it takes care of some of the basics. You will need to add support by installing the library. Good news: it is _very easy_ to do it. Go to the **Arduino Library Manager.**
Search for **TestBed** and install the **Adafruit TestBed** library
Now open up the I2C Scan example
https://github.com/adafruit/Adafruit_Learning_System_Guides/blob/main/I2C_Scanners/arduino/i2c_scanner/i2c_scanner.ino
### Wire up I2C device
While the examples here will be using the [Adafruit MCP9808](https://www.adafruit.com/product/5027), a high accuracy temperature sensor, the overall process is the same for just about any I2C sensor or device.
The first thing you'll want to do is get the sensor connected so your board has I2C to talk to.
### Adafruit MCP9808 High Accuracy I2C Temperature Sensor Breakout
[Adafruit MCP9808 High Accuracy I2C Temperature Sensor Breakout](https://www.adafruit.com/product/5027)
The MCP9808 digital temperature sensor is one of the more accurate/precise we've ever seen, with a typical accuracy of ±0.25°C over the sensor's -40°C to +125°C range and precision of +0.0625°C. They work great with any microcontroller using standard I2C. With...
Out of Stock
[Buy Now](https://www.adafruit.com/product/5027)
[Related Guides to the Product](https://learn.adafruit.com/products/5027/guides)
### STEMMA QT / Qwiic JST SH 4-Pin Cable - 50mm Long
[STEMMA QT / Qwiic JST SH 4-Pin Cable - 50mm Long](https://www.adafruit.com/product/4399)
This 4-wire cable is 50mm / 1.9" long and fitted with JST SH female 4-pin connectors on both ends. Compared with the chunkier JST PH these are 1mm pitch instead of 2mm, but still have a nice latching feel, while being easy to insert and remove.
In Stock
[Buy Now](https://www.adafruit.com/product/4399)
[Related Guides to the Product](https://learn.adafruit.com/products/4399/guides)
## Wiring the MCP9808
The MCP9808 comes with a STEMMA QT connector, which makes wiring it up quite simple and solder-free.
Plug the **MCP9808 STEMMA QT port** into the **Metro ESP32-S3 STEMMA QT port**.
Now upload the scanning sketch to your microcontroller and open the serial port to see the output. You should see something like this:
Warning:
# Adafruit Metro ESP32-S3
## Arduino SD Card Demo
Using the built in MicroSD card slot with Arduino involves installing the [Adafruit Fork of the SdFat library](https://github.com/adafruit/SdFat), and running the provided example code.
## MicroSD Card Slot
The **MicroSD card slot** (highlighted in red), labeled MicroSD on the board silk, is located above the analog pins in the lower right corner of the board.
Warning:
Info:
### 512MB micro SD Memory Card
[512MB micro SD Memory Card](https://www.adafruit.com/product/5252)
Add storage in a jiffy using this **512MB** microSD card. Preformatted to FAT32, so it works out of the packaging with our projects. Works great with any device in the Adafruit shop that uses microSD cards. Ideal for use with Feathers, data loggers, or small Linux SBCs (not good...
In Stock
[Buy Now](https://www.adafruit.com/product/5252)
[Related Guides to the Product](https://learn.adafruit.com/products/5252/guides)
## Library Installation
You can install the **Adafruit Fork of the SDFat**** **library for Arduino using the Library Manager in the Arduino IDE.
Click the **Manage Libraries ...** menu item, search for **Adafruit SDFat** and select the **SDFat - Adafruit Fork** library:
Info:
## Read/Write Example
```cpp
// SPDX-FileCopyrightText: 2023 Liz Clark for Adafruit Industries
//
// SPDX-License-Identifier: MIT
/*
SD card read/write
This example shows how to read and write data to and from an SD card file
The circuit:
* SD card attached to SPI bus as follows:
** MOSI - pin 11
** MISO - pin 12
** CLK - pin 13
created Nov 2010
by David A. Mellis
modified 9 Apr 2012
by Tom Igoe
modified 14 Feb 2023
by Liz Clark
modified 25 Aug 2023
by Kattni Rembor
This example code is in the public domain.
*/
#include <SPI.h>
//#include <SD.h>
#include "SdFat.h"
SdFat SD;
#define SD_FAT_TYPE 3
// default CS pin is SS
#define SD_CS_PIN SS
File myFile;
void setup() {
// Open serial communications and wait for port to open:
Serial.begin(115200);
while (!Serial) {
; // wait for serial port to connect. Needed for native USB port only
}
Serial.print("Initializing SD card...");
if (!SD.begin(SD_CS_PIN)) {
Serial.println("initialization failed!");
return;
}
Serial.println("initialization done.");
// open the file. note that only one file can be open at a time,
// so you have to close this one before opening another.
myFile = SD.open("test.txt", FILE_WRITE);
// if the file opened okay, write to it:
if (myFile) {
Serial.print("Writing to test.txt...");
myFile.println("testing 1, 2, 3.");
myFile.println("hello sd card!");
// close the file:
myFile.close();
Serial.println("done.");
} else {
// if the file didn't open, print an error:
Serial.println("error opening test.txt");
}
// re-open the file for reading:
myFile = SD.open("test.txt");
if (myFile) {
Serial.println("test.txt:");
// read from the file until there's nothing else in it:
while (myFile.available()) {
Serial.write(myFile.read());
}
// close the file:
myFile.close();
} else {
// if the file didn't open, print an error:
Serial.println("error opening test.txt");
}
}
void loop() {
// nothing happens after setup
}
```
Upload the sketch to your board and open up the Serial Monitor ( **Tools -\> Serial Monitor** ) at 115200 baud. A test text file will be created and written to on the SD card. Then, the text file will be read back with its contents printed to the Serial Monitor.
# Adafruit Metro ESP32-S3
## WipperSnapper Setup
Warning:
## What is WipperSnapper
WipperSnapper is a firmware designed to turn any WiFi-capable board into an Internet-of-Things device without programming a single line of code. WipperSnapper connects to [Adafruit IO](https://io.adafruit.com/), a web platform designed ([by Adafruit!](https://www.adafruit.com/about)) to _display_, _respond_, and _interact_ with your project's data.
Simply load the WipperSnapper firmware onto your board, add credentials, and plug it into power. Your board will automatically register itself with your Adafruit IO account.
From there, you can add _components_ to your board such as buttons, switches, potentiometers, sensors, and more! Components are _dynamically _added to hardware, so you can immediately start interacting, logging, and streaming the data your projects produce without writing code.
## Sign up for Adafruit.io
You will need an Adafruit IO account to use WipperSnapper on your board. If you do not already have one, head over to [io.adafruit.com](https://io.adafruit.com/) to create a _free_ account.
## Add a New Device to Adafruit IO
Log into your [Adafruit IO](https://io.adafruit.com/) account. Click the _New Device_ button at the top of the page.
After clicking New Device, you should be on the _board selector_ page. This page displays every board that is compatible with the WipperSnapper firmware.
In the board selector page's search bar, search for the **Metro ESP32-S3** _. _Once you've located the board you'd like to install WipperSnapper on,_ _click the _Choose Board_ button to bring you to the self-guided installation wizard.
Follow the step-by-step instructions on the page to install Wippersnapper on your device and connect it to Adafruit IO.
If the installation was successful, a popover should appear displaying that your board has successfully been detected by Adafruit IO.
Give your board a name and click "Continue to Device Page".
You should be brought to your board's device page.
## Feedback
Adafruit.io WipperSnapper is in **beta** and you can help improve it!
If you have suggestions or general feedback about the installation process - visit [https://io.adafruit.com/support](https://io.adafruit.com/support), click _"Contact Adafruit IO Support"_ and select _"I have feedback or suggestions for the WipperSnapper Beta"._
## Troubleshooting
If you encountered an issue during installation, please try the steps below first.
If you're still unable to resolve the issue, or if your issue is not listed below, get in touch with us directly at [https://io.adafruit.com/support](https://io.adafruit.com/support "https://io.adafruit.com/support"). Make sure to click _"Contact Adafruit IO Support"_ and select "_There is an issue with WipperSnapper. Something is broken!"_
###
First, make sure that you selected the correct board on the board selector.
Next, please make sure that you entered your WiFi credentials properly, there are no spaces/special characters in either your network name (SSID) or password, and that you are connected to a 2.4GHz wireless network.
If you're still unable to connect your board to WiFi, please [make a new post on the WipperSnapper technical support forum with the error you're experiencing, the LED colors which are blinking, and the board you're using.](https://forums.adafruit.com/viewforum.php?f=66)
###
Try hard-resetting your board by unplugging it from USB power and plugging it back in.
If the error is still occurring, please [make a new post on the WipperSnapper technical support forum with information about what you're experiencing, the LED colors which are blinking (if applicable), and the board you're using.](https://forums.adafruit.com/viewforum.php?f=66)
## "Uninstalling" WipperSnapper
WipperSnapper firmware is an application that is loaded onto your board. There is nothing to "uninstall". However, you may want to "move" your board from running WipperSnapper to running Arduino or CircuitPython. You also may need to restore your board to the state it was shipped to you from the Adafruit factory.
### Moving from WipperSnapper to CircuitPython
Follow the steps on the [Installing CircuitPython page](https://learn.adafruit.com/welcome-to-circuitpython/installing-circuitpython) to install CircuitPython on your board running WipperSnapper.
- If you are unable to double-tap the RST button to enter the UF2 bootloader, follow the _"Factory Resetting a WipperSnapper Board"_ instructions below.
Uploading this sketch will overwrite WipperSnapper. If you want to re-install WipperSnapper, follow the instructions at the top of this page.
### Moving from WipperSnapper to Arduino
If you want to use your board with Arduino, you will use the Arduino IDE to load _any_ sketch onto your board.
First, follow the page below to set up your Arduino IDE environment for use with your board.
[Setup Arduino IDE](https://learn.adafruit.com/adafruit-metro-esp32-s3/arduino-ide-setup)
Then, follow the page below to upload the "Arduino Blink" sketch to your board.
[Upload Arduino Blink Sketch](https://learn.adafruit.com/adafruit-metro-esp32-s3/arduino-blink)
Uploading this sketch will overwrite WipperSnapper. If you want to re-install WipperSnapper, follow the instructions at the top of this page.
### Factory Resetting a WipperSnapper Board
Sometimes, hardware gets into a state that requires it to be "restored" to the original state it shipped in. If you'd like to get your board back to its original factory state, follow the guide below.
[Factory Reset Guide](https://learn.adafruit.com/adafruit-metro-esp32-s3/factory-reset)
# Adafruit Metro ESP32-S3
## WipperSnapper Essentials
You've installed WipperSnapper firmware on your board and connected it to Adafruit IO. Next, let's learn how to use Adafruit IO!
The Adafruit IO supports a large number of _components. Components_ are physical parts such as buttons, switches, sensors, servos, LEDs, RGB LEDs, and more.
The following pages will get you up and running with WipperSnapper as you interact with your board's LED, read the value of a push button, send the value of an I2C sensor to the internet, and wirelessly control colorful LEDs.
### Parts
The following parts are **required** to complete the WipperSnapper essentials pages for this board:
- An I2C sensor like the MCP9808 temperature sensor.
### Adafruit MCP9808 High Accuracy I2C Temperature Sensor Breakout
[Adafruit MCP9808 High Accuracy I2C Temperature Sensor Breakout](https://www.adafruit.com/product/5027)
The MCP9808 digital temperature sensor is one of the more accurate/precise we've ever seen, with a typical accuracy of ±0.25°C over the sensor's -40°C to +125°C range and precision of +0.0625°C. They work great with any microcontroller using standard I2C. With...
Out of Stock
[Buy Now](https://www.adafruit.com/product/5027)
[Related Guides to the Product](https://learn.adafruit.com/products/5027/guides)
Info: You can substitute your sensor for the suggested MCP9808 used in this guide, see your product's learn guide for WipperSnapper instructions tailored specifically to that sensor / component.
If you don't have one then you can test I2C functionality using the onboard I2C battery monitor.
- Cable or set of wires to connect your I2C component (like our handy StemmaQT cables for I2C)
### STEMMA QT / Qwiic JST SH 4-Pin Cable - 50mm Long
[STEMMA QT / Qwiic JST SH 4-Pin Cable - 50mm Long](https://www.adafruit.com/product/4399)
This 4-wire cable is 50mm / 1.9" long and fitted with JST SH female 4-pin connectors on both ends. Compared with the chunkier JST PH these are 1mm pitch instead of 2mm, but still have a nice latching feel, while being easy to insert and remove.
In Stock
[Buy Now](https://www.adafruit.com/product/4399)
[Related Guides to the Product](https://learn.adafruit.com/products/4399/guides)
- A variable resistance component, like a rotary potentiometer or light-dependent resistor
### STEMMA Wired Potentiometer Breakout Board - 10K ohm Linear
[STEMMA Wired Potentiometer Breakout Board - 10K ohm Linear](https://www.adafruit.com/product/4493)
For the easiest way possible to measure twists, turn to this STEMMA potentiometer breakout (ha!). This plug-n-play pot comes with a JST-PH 2mm connector and a matching [JST PH 3-Pin to Male Header Cables - 200mm](https://www.adafruit.com/product/3893), so wiring up is a cinch....
Out of Stock
[Buy Now](https://www.adafruit.com/product/4493)
[Related Guides to the Product](https://learn.adafruit.com/products/4493/guides)
# Adafruit Metro ESP32-S3
## LED Blink
Info: This demo shows controlling an LED from Adafruit IO. The same kind of control can be used for relays, lights, motors, or solenoids.
One of the first programs you typically write to get used to embedded programming is a sketch that repeatably blinks an LED. IoT projects are _wireless,_ so after completing this section, you'll be able to turn on (or off) the LED built into your board from anywhere in the world.
## Where is the LED on my board?
The **red LED ** (highlighted in red), labeled L on the board silk, is located towards the middle-top of the board.
## Create a LED Component on Adafruit IO
On the device page, click the New Component (or "+") button to open the component picker.
Search for the component name by entering `LED` into the text box on the component picker, the list of components should update as soon as you stop typing.
### Filtering and searching for components
Since WipperSnapper supports such a large number of components, there is keyword filtering. Try searching for various keywords, like:
- component names: `aht20`, `servo`, `buzzer`, `button`, `led`, etc
- sensor types: `light`, `temperature`, `pressure`, `humidity`, etc
- interface: `i2c`, `uart`, `ds18x20`, `pin`, etc (also I2C addresses e.g. `0x44`)
- vendor: `Adafruit`, `ASAIR`, `Infineon`, `Bosch`, `Honeywell`, `Sensirion`, etc
There are also product and documentation links to every component. Follow the links beneath the component descriptions to be taken to the appropriate product page or Learn Guide
Select the **LED** from the list of components.
On the Create LED Component form, the board's LED pin is pre-selected.
Click Create Component.
Behind the scenes, Adafruit IO sends send a command to your board running WipperSnapper telling it to configure "LED Pin" as a digital output.
Your board's page on Adafruit IO shows a new LED component.
## Usage
On the board page, toggle the LED component by clicking the toggle switch. This should turn your board's built-in LED on or off.
# Adafruit Metro ESP32-S3
## Read a Push-button
Info: This demo shows reading the state of a push-button from WipperSnapper. But the same kind of control can be used for reading switches, break beam sensors, and other digital sensors.
You can configure a board running WipperSnapper to read data from standard input buttons, switches, or digital sensors, and send the value to Adafruit IO.
From Adafruit IO, you will configure one of the pushbuttons on your board as a push button component. Then, when the button is pressed (or released), a value will be published to Adafruit IO.
## Button Location
This example uses the board's built-in push-button and internal pull-up resistor instead of wiring a push-button up.
The Adafruit Metro ESP32-S3 boot button is labeled **Boot** on the silkscreen, and is positioned in the middle of the board.
## Create a Push-button Component on Adafruit IO
On the device page, click the New Component (or "+") button to open the component picker.
Search for the component name by entering `push` into the text box on the component picker, the list of components should update as soon as you stop typing.
### Filtering and searching for components
Since WipperSnapper supports such a large number of components, you can use filtering. Try searching for various keywords, like:
- component names:` aht20`, `servo`, `buzzer`, `button`, `potentiometer`, etc
- sensor types: `light`, `temperature`, `pressure`, `humidity`, etc
- interface: `i2c`, `uart`, `ds18x20`, `pin`, etc (also I2C addresses e.g. `0x44`)
- vendor: `Adafruit`, `ASAIR`, `Infineon`, `Bosch`, `Honeywell`, `Sensirion`, etc
There are also added product and documentation links for every component. Follow the links beneath the component descriptions to be taken to the appropriate product page or Learn Guide.
Select the **Push Button** from the list of results to go to the component configuration page.
There will be a back button if you select the wrong component, and you can use the Edit component icon (⚙️) on the device page to update the component configuration in the future.
The "Create Push Button Component" form presents you with options for configuring the push button.
Start by selecting the board's pin connected to the push button.
If you're lucky then the form will automatically select the pin for built-in components (button/LED/NeoPixel).
The _Return Interval_ dictates how frequently the value of the push-button will be sent from the board to Adafruit IO.
For this example, you will configure the push button's value to be only sent when the value changes (i.e. when it's either pressed or depressed).
Finally, check the **Specify Pin Pull Direction ** checkbox and select the pull direction.
Make sure the form's settings look like the following screenshot. Then, click **Create Component**.
Adafruit IO sends a command to your WipperSnapper board, telling it to configure the GPIO pin you selected to behave as a digital input pin and to enable it to pull up the internal resistor.
Your board's page should also show the new push-button component.
Push the button on your board to change the value of the push-button component on Adafruit IO.
# Adafruit Metro ESP32-S3
## NeoPixel LED
Your board has a WS281x RGB LED (NeoPixel, in Adafruit jargon) built in. Boards running the WipperSnapper firmware can be wirelessly controlled by Adafruit IO to interact with NeoPixels.
On this page, you'll learn how to change the color and brightness of the NeoPixel built into your board from Adafruit IO.
## Where is the NeoPixel on my board?
The **NeoPixel** **LED** (highlighted in red), labeled Neo on the board silk, is located next to the JTAG connector.
## Create the NeoPixel Component
Primary: If you used the Magic Config button to automatically configure the components on your board, then the NeoPixel component will already be configured. Skip ahead to the **Usage** section.
Don't know about Magic Config? Click the Auto-Config button on the device page for further details!
On the device page, click the New Component (or "+") button to open the component picker.
Search for the component name by entering `neopixel` into the text box on the component picker, the list of components should update as soon as you stop typing
### Filtering and searching for components
Since WipperSnapper supports such a large number of components, you can use keyword filtering. Try searching for various keywords, like:
- component names: `aht20`, `servo`, `buzzer`, `button`, `neopixel`, etc
- sensor types: `light`, `temperature`, `pressure`, `humidity`, etc
- interface: `i2c`, `uart`, `ds18x20`, `pin`, etc (also I2C addresses e.g. `0x44`)
- vendor: `Adafruit`, `ASAIR`, `Infineon`, `Bosch`, `Honeywell`, `Sensirion`, etc
There is also added product and documentation links for every component, follow the links beneath the component descriptions to be taken to the appropriate product page or Learn Guide
Select the **NeoPixel** from the list of results to go to the component configuration page.
There will be a back button if you select the wrong component, and you can use the Edit component icon (⚙️) on the device page to update the component configuration in the future.
The board NeoPixel pin is automatically found and selected.
Click **Create Component**
Behind the scenes, Adafruit IO sends a command to your board running WipperSnapper firmware telling it to configure the pin as a NeoPixel component with the settings from the form.
The Device page shows the NeoPixel component.
## Set the NeoPixel's RGB Color
Since no colors have been set yet, the color picker's default value is `#000000` (black in hex color code) and appears "off". You can change that to make the NeoPixel shine brightly!
On the NeoPixel component, click the color dropper at the end of the color swatch list.
A color picker pops open! Next: learning how Adafruit IO uses hex color codes to represent the colors on your NeoPixel.
### Hex Colors 101
The color picker on Adafruit IO uses hex color codes to represent Red, Green, and Blue values. For example, `#FF0000` is the hex color code for the color red. The colors (`#FF0000`) red component is `FF` (255 translated to decimal), the green component is `00` and the blue component is `00`. Translated to RGB format, the color is `RGB (255, 0, 0)`.
Using the color picker, or by manually entering a hex color code, select a color.
When you're ready to set the color of your device's NeoPixel, click **FILL WITH COLOR**. The NeoPixel will immediately glow!
## Set NeoPixel Brightness
If the NeoPixel is too bright (or too dim), you can change the overall brightness. Click the gear/cog icon on the NeoPixel component to open its settings.
On the NeoPixel component form, set Brightness to a value between 0 (fully off) and 255 (full brightness).
Click the **Update Component ** button to send the updated configuration to your device.
# Adafruit Metro ESP32-S3
## Analog Input
Your microcontroller board has both digital and analog signal capabilities. Some pins are analog, some are digital, and some are capable of both. Check the **Pinouts** page in this guide for details about your board.
Analog signals are different from digital signals in that they can be _any_ voltage and can vary continuously and smoothly between voltages. An analog signal is like a dimmer switch on a light, whereas a digital signal is like a simple on/off switch.
Digital signals only can ever have two states, they are either are **on** (high logic level voltage like 3.3V) or **off** (low logic level voltage like 0V / ground).
By contrast, analog signals can be any voltage in-between on and off, such as 1.8V or 0.001V or 2.98V and so on.
Analog signals are continuous values which means they can be an _infinite_ number of different voltages. Think of analog signals like a floating point or fractional number, they can smoothly transiting to _any_ in-between value like 1.8V, 1.81V, 1.801V, 1.8001V, 1.80001V and so forth to infinity.
Many devices use analog signals, in particular sensors typically output an analog signal or voltage that varies based on something being sensed like light, heat, humidity, etc.
## Analog to Digital Converter (ADC)
An analog-to-digital-converter, or ADC, is the key to reading analog signals and voltages with a microcontroller. An ADC is a device that reads the voltage of an analog signal and converts it into a digital, or numeric, value. The microcontroller can’t read analog signals directly, so the analog signal is first converted into a numeric value by the ADC.
The black line below shows a digital signal over time, and the red line shows the converted analog signal over the same amount of time.
Once that analog signal has been converted by the ADC, the microcontroller can use those digital values any way you like!
## Potentiometers
A potentiometer is a small variable resistor that you can twist a knob or shaft to change its resistance. It has three pins. By twisting the knob on the potentiometer you can change the resistance of the middle pin (called the wiper) to be anywhere within the range of resistance of the potentiometer.
By wiring the potentiometer to your board in a special way (called a voltage divider) you can turn the change in resistance into a change in voltage that your board’s analog to digital converter can read.
To wire up a potentiometer as a voltage divider:
- Connect **one outside pin** to **ground**
- Connect **the other outside pin** to **voltage in (e.g. 3.3V)**
- Connect **the middle pin** to **an analog pin (e.g. A0)**
## Hardware
In addition to your microcontroller board, you will need the following hardware to follow along with this example.
**Potentiometer**
### STEMMA Wired Potentiometer Breakout Board - 10K ohm Linear
[STEMMA Wired Potentiometer Breakout Board - 10K ohm Linear](https://www.adafruit.com/product/4493)
For the easiest way possible to measure twists, turn to this STEMMA potentiometer breakout (ha!). This plug-n-play pot comes with a JST-PH 2mm connector and a matching [JST PH 3-Pin to Male Header Cables - 200mm](https://www.adafruit.com/product/3893), so wiring up is a cinch....
Out of Stock
[Buy Now](https://www.adafruit.com/product/4493)
[Related Guides to the Product](https://learn.adafruit.com/products/4493/guides)
The **Stemma Wired Potentiometer Breakout Board (10K ohm Linear)** comes with a matching cable. It has a JST-PH 3pin connector on one end and Dupont male jumper connectors on the other end. This works perfectly with the Metro's female headers.
## Wire Up the Potentiometer
Connect the potentiometer to your board as follows.
- **Potentiometer left pin (white wire) **to ** Metro A0**
- **Potentiometer center pin (red wire) **to ** Metro 3.3V**
- **Potentiometer right pin (black wire) **to ** Metro GND**
## Create a Potentiometer Component on Adafruit IO
On the device page, click the New Component (or "+") button to open the component picker.
Search for the component name by entering `potentiometer` into the text box on the component picker, the list of components should update as soon as you stop typing.
### Filtering and searching for components
Since WipperSnapper supports such a large number of components, there is keyword filtering. Try searching for various keywords, like:
- component names: `aht20`, `servo`, `buzzer`, `button`, `potentiometer`, etc
- sensor types: `light`, `temperature`, `pressure`, `humidity`, etc
- interface: `i2c`, `uart`, `ds18x20`, `pin`, etc (also I2C addresses e.g. `0x44`)
- vendor: `Adafruit`, `ASAIR`, `Infineon`, `Bosch`, `Honeywell`, `Sensirion`, etc
There are also added product and documentation links for every component, follow the links beneath the component descriptions to be taken to the appropriate product page or Learn Guide.
Select the **Potentiometer** from the list of results to go to the component configuration page.
There will be a back button if you select the wrong component, and you can use the Edit component icon (⚙️) on the device page to update the component configuration in the future.
On the _Create Potentiometer Component_ form:
- Set **Potentiometer Pin** to **A0**
- Select **"On Change"** as the **Return Interval**
- Select **Raw Analog Value** as the **Return Type**
Then, click Create Component
The potentiometer component appears on your board page! Next, learning to read values from it.
## Read Analog Pin Values
Rotate the potentiometer to see the value change.
_What do these values mean?_
WipperSnapper reports ADC "raw values" as 16-bit unsigned integer values. Your potentiometer will read between 0 (twisting the pot to the leftmost position) and 65535 (twisting the pot to the rightmost position).
## Read Analog Pin Voltage Values
You can update the potentiometer component (or any analog pin component in WipperSnapper) to report values in Volts. To do this, on the right-hand side of the potentiometer component, click the cog button.
Under **Return Type** , click Voltage.
Click Update Component to send the updated component settings to your board running WipperSnapper.
Now, twist the potentiometer to see the value reported to Adafruit IO in Volts!
# Adafruit Metro ESP32-S3
## I2C Sensors
Info:
Inter-Integrated Circuit, aka **I2C** , is a two-wire protocol for connecting sensors and "devices" to a microcontroller. A large number of sensors, including the ones sold by Adafruit, use I2C to communicate.
**Typically, using I2C with a microcontroller involves programming. Adafruit IO and WipperSnapper let you configure a microcontroller to read data from an I2C sensor and publish that data to the internet without writing code.**
The WipperSnapper firmware supports a number of I2C sensors, [viewable in list format here](https://github.com/adafruit/Wippersnapper_Components/tree/main/components/i2c).
- If you do not see the I2C sensor you're attempting to use with WipperSnapper, [Adafruit has a guide on adding a component to Adafruit IO WipperSnapper here](https://learn.adafruit.com/how-to-add-a-new-component-to-adafruit-io-wippersnapper).
On this page, you'll learn how to wire up an I2C sensor to your board. Then, you'll create a new component on Adafruit IO for your I2C sensor and send the sensor values to Adafruit IO. Finally, you'll learn how to locate, interpret, and download the data produced by your sensors.
## Parts
You will need the following parts to complete this page:
### Adafruit MCP9808 High Accuracy I2C Temperature Sensor Breakout
[Adafruit MCP9808 High Accuracy I2C Temperature Sensor Breakout](https://www.adafruit.com/product/5027)
The MCP9808 digital temperature sensor is one of the more accurate/precise we've ever seen, with a typical accuracy of ±0.25°C over the sensor's -40°C to +125°C range and precision of +0.0625°C. They work great with any microcontroller using standard I2C. With...
Out of Stock
[Buy Now](https://www.adafruit.com/product/5027)
[Related Guides to the Product](https://learn.adafruit.com/products/5027/guides)
Also grab a matching STEMMA QT cable for that easy plug and play connection.
We have them from 50mm to 400mm, and I2C has a chain length of under 1meter.
If the linked item is out of stock, or you would prefer another size, simply visit the product link and select a different length:
### STEMMA QT / Qwiic JST SH 4-Pin Cable - 300mm long
[STEMMA QT / Qwiic JST SH 4-Pin Cable - 300mm long](https://www.adafruit.com/product/5384)
This 4-wire cable is a little over 300mm / 11.8" long and fitted with JST-SH female 4-pin connectors on both ends. Compared with the chunkier JST-PH these are 1mm pitch instead of 2mm, but still have a nice latching feel, while being easy to insert and remove.
In Stock
[Buy Now](https://www.adafruit.com/product/5384)
[Related Guides to the Product](https://learn.adafruit.com/products/5384/guides)
## Wiring
If you're using a STEMMA QT to STEMMA QT cable:
- **Board STEMMA QT Port** to **MCP9808's STEMMA QT Port**
If you're using a breadboard:
- **Board power ** to ** MCP9808 VIN**
- **Board ground ** to ** MCP9808 GND**
- **Board SCL ** to ** MCP9808 SCL**
- **Board SDA ** to ** MCP9808 SDA**
## Add an MCP9808 Component
On the device page, click the New Component (or "+") button to open the component picker.
Search for the component name by entering `MCP9808` into the text box on the component picker, the list of components should update as soon as you stop typing.
### Filtering and searching for components
Since WipperSnapper supports such a large number of components, there is keyword filtering. Try searching for various keywords, like:
- component names: `aht20`, `servo`, `buzzer`, `button`, `potentiometer`, etc
- sensor types: `light`, `temperature`, `pressure`, `humidity`, etc
- interface: `i2c`, `uart`, `ds18x20`, `pin`, etc (also I2C addresses e.g. `0x44`)
- vendor: `Adafruit`, `ASAIR`, `Infineon`, `Bosch`, `Honeywell`, `Sensirion`, etc
There are added product and documentation links for every component, follow the links beneath the component descriptions to be taken to the appropriate product page or Learn Guide.
Select the **MCP9808** from the list of results to go to the component configuration page.
There will be a back button if you select the wrong component, and you can use the Edit component icon (⚙️) on the device page to update the component configuration in the future.
On the component configuration page, the MCP9808's I2C sensor address should be listed along with the sensor's settings.
The MCP9808 sensor can measure ambient temperature. This page has individual options for reading the ambient temperature, in either Celsius or Fahrenheit. You may select the readings which are appropriate to your application and region.
The **Send Every** option is specific to each sensor measurement. This option will tell the board how often it should read from the sensor and send the data to Adafruit IO. Measurements can range from every 30 seconds to every 24 hours.
For this example, set the **Send Every ** interval for both seconds to **Every 30 seconds. ** Click **Create Component**.
The board page should now show the MCP9808 component you created. After the interval you configured elapses, the WipperSnapper firmware running on your board automatically reads values from the sensor and sends them to Adafruit IO.
## Read I2C Sensor Values
Now to look behind the scenes at a powerful element of using Adafruit IO and WipperSnapper. When a new component is created on Adafruit IO, an [Adafruit IO Feed](https://learn.adafruit.com/adafruit-io-basics-feeds) is also created. This Feed holds your sensor component values for long-term storage (30 days of storage for Adafruit IO Free and 60 days for Adafruit IO Plus plans).
Aside from holding the **values** read by a sensor, the component's feed also holds **metadata** about the data pushed to Adafruit IO. This includes settings for whether the data is public or private, what license the stored sensor data falls under, and a general description of the data.
Next, to look at the sensor temperature feed. To navigate to a component's feed, click on the chart icon in the upper-right-hand corner of the component.
On the component's feed page, you'll each data point read by your sensor and when they were reported to Adafruit IO.
### Doing more with your sensor's Adafruit IO Feed
This only scratches the surface of what Adafruit IO Feeds can accomplish for your IoT projects. For a complete overview of Adafruit IO Feeds, including tasks like downloading feed data, sharing a feed, removing erroneous data points from a feed, and more, [head over to the "Adafruit IO Basics: Feed" learning guide](https://learn.adafruit.com/adafruit-io-basics-feeds).
# Adafruit Metro ESP32-S3
## Battery Monitor (MAX17048)
There are three ways to power your Metro:
1) Power with a USB Cable connected to a power source.
2) Use the DC Jack connected to a power source up to 12volts.
3) Connect a 4.2/3.7V Lithium Polymer (LiPo/LiPoly) or Lithium Ion (LiIon) battery to the JST jack. This lets you run the Metro without wires, untethered.
If you're running off of a battery, chances are you want to know what the voltage is. That way you can tell when the battery needs recharging.
**In this section, you'll connect a battery to your Metro, and configure a battery monitor component from Adafruit IO to report the board's battery voltage and charge percentage. **
## Where is the Battery Monitor on my Metro?
The **MAX17048 battery monitor** (highlighted in red) is located next to the 3.7V Lipoly label on the board silk.
## Powering the Metro with a Battery
Warning: Adafruit highly advises using Adafruit batteries. They have the correct wiring and built in short circuit protection. Batteries from other sources may have incorrect wiring and/or no short protection.
You can plug any 250mAh or larger 3.7/4.2V Lipoly battery into the JST 2-PH port (identified on the pinouts page and shown in the image above) to power your Metro and charge the battery. The battery will charge when either USB power or the DC power socket is used. If the battery is plugged in _and an external power source is plugged in_, the Metro will power itself from USB or the DC socket _and_ charge the battery up. It uses the highest external power source.
For more information about powering your Metro, visit the [Power Management Page in this guide](https://learn.adafruit.com/adafruit-metro-esp32-s3/power-management).
Primary: If you used the Magic Config button to automatically configure the components on your board, then the Battery Monitor component will already be configured. Skip ahead to the **Usage** section.
Don't know about Magic Config? Click the Auto-Config button on the device page for further details!
## Add Battery Monitor Component to Adafruit IO
From your device page, click the New Component (or +) button.
Search for the component name by entering `MAX17048` into the text box on the component picker, the list of components should update as soon as you stop typing.
### Filtering and searching for components
Since WipperSnapper supports such a large number of components, there is keyword filtering. Try searching for various keywords, like:
- component names: `aht20`, `servo`, `buzzer`, `button`, `max17048`, etc
- sensor types: `light`, `temperature`, `pressure`, `humidity`, etc
- interface: `i2c`, `uart`, `ds18x20`, `pin`, etc (also I2C addresses e.g. `0x44`)
- vendor: `Adafruit`, `ASAIR`, `Infineon`, `Bosch`, `Honeywell`, `Sensirion`, etc
There are added product and documentation links for every component, follow the links beneath the component descriptions to be taken to the appropriate product page or Learn Guide.
Select the **MAX17048** from the list of results to go to the component configuration page.
There will be a back button if you select the wrong component, and you can use the Edit component icon (⚙️) on the device page to update the component configuration in the future.
The Create Component form should load, used for component configuration, with the MAX17048's I2C sensor address listed along with the sensor's settings.
On the _Create MAX17048 Component_ form, there are two options:
1. Enable the battery cell voltage reading. This will cause the Metro to report the status of its battery expressed in Volts.
2. Enable the battery cell percent reading. This will cause the Metro to report the status of its battery expressed as a percent.
Then, the battery measurement will be read and sent to Adafruit IO every "Send Every" period.
In the screenshot below, the battery monitor is configured to report its battery cell voltage _and_ battery cell percentage back to Adafruit IO every 30 seconds.
After configuring the MAX17048 component, click _Create Component._
Every 30 seconds, the Metro uses the MAX17048 component to measure its battery cell percent and voltage, and report it back to Adafruit IO.
## Going Further
Now that you have a battery monitor component set up on Adafruit IO, you may [follow this guide to configure an Adafruit IO Action for receiving an SMS text message when your Metro's battery level is below a threshold](https://learn.adafruit.com/no-code-battery-monitoring-with-wippersnapper/battery-level-sms-alert-with-adafruit-io-actions).
# Adafruit Metro ESP32-S3
## Factory Reset
The Metro ESP32-S3 microcontroller ships running a multipurpose demo. The easily visible part is the NeoPixel rainbow swirl, and little red LED blinking. If you open the serial monitor, you'll find it running an I2C scan, and periodically checking for an SD card and reporting the total PSRAM. It's lovely, but you probably had other plans for the board. As you start working with your board, you may want to return to the original code to begin again, or you may find your board gets into a bad state. Either way, this page has you covered.
You're probably used to seeing the **METROS3BOOT** drive when loading CircuitPython or Arduino. The **METROS3BOOT** drive is part of the UF2 bootloader, and allows you to drag and drop files, such as CircuitPython. However, on the ESP32-S2/S3 the UF2 bootloader can become damaged.
**As of Nov 8, 2023** - We've fixed this hardware to be revision B which has changed the NeoPixel pin and the SPI/SD card pins to no longer use the same pins as the octal PSRAM. This means that the hardware now works correctly when PSRAM is activated! If you have a rev A hardware board, contact support to get a replacement rev B.
Warning:
# Install the Factory Reset Firmware UF2
If you have a bootloader still installed - which means you can double-click to get the **METROS3BOOT** drive to appear, then you can simply drag this UF2 file over to the **BOOT** drive.
To enter UF2 bootloader mode, plug in the board into a USB cable with data/sync capability. Press the reset button once, wait till the RGB LED turns purple, then quickly press the reset button again. (You are doing a "slow double-click"). Then drag this file over:
[Click to download metro-esp32-s3-factory-reset.UF2](https://github.com/adafruit/Adafruit-Metro-ESP32-S3-PCB/raw/main/factory-reset/metro-esp32-s3-factory-reset.UF2)
Your board is now back to its factory-shipped state, running again with the original factory program. You can now begin again with your plans for your board.
Info: Re-loading the factory reset UF2 isn't necessary to start over with the board, but it's a good way to show the board is working.
# UF2 Bootloader Installation and Repair
What if you tried double-tapping the reset button, and you still can't get into the UF2 bootloader? Whether your board shipped without the UF2 bootloader, or something damaged it, this section has you covered.
Warning: There is no protection for the UF2 bootloader. That means it is possible to erase or damage the UF2 bootloader, especially if you upload an Arduino sketch to an ESP32-S2/S3 board that doesn't "know" there's a bootloader it should not overwrite!
It turns out, however, the ESP32-S2/S3 comes with a second, built-in, bootloader, the ROM bootloader, which cannot be erased or damaged. You can always reload the UF2 bootloader using the ROM bootloader.
There are three ways to do a factory reset and bootloader repair. The first and easiest is to [use the **OPEN INSTALLER** button](https://learn.adafruit.com/using-open-installer-on-circuitpython-org) on the page for your board on [circuitpython.org](https://circuitpython.org). This method requires no manual downloads and guides you through the steps interactively. **We highly recommend this method as your first choice.**
The second method is to use the browser-based **Adafruit WebSerial ESPTool** , and the third is to use `esptool.py` via the command line.
For both OPEN INSTALLER and the Adafruit WebSerial tool, you must use a Chromium-based browser such as Chrome, Edge, Opera, or Chromium.
Danger: Installing the UF2 bootloader will erase everything on your board, including CircuitPython, any Arduino program, and any files stored in flash! Be sure to back up your data first.
## OPEN INSTALLER Method for UF2 Bootloader Installation
The OPEN INSTALLER button on [circuitpython.org](https://circuitpython.org/) is the easiest way to install or update the UF2 bootloader. See the Learn Guide [Using the OPEN INSTALLER Button on circuitpython.org](https://learn.adafruit.com/using-open-installer-on-circuitpython-org) for all the details.
## Adafruit WebSerial ESPTool and `esptool.py` Methods for UF2 Bootloader Installation
The other methods for bootloader installation require you to download the bootloader yourself. The next section walks you through the prerequisite steps needed for both of these methods.
## Step 1. Download the UF2 Bootloader **.bin** File for your board
Clik on the green button below to download the **.bin** file you need (there may be more than one listed), and save wherever is convenient for you. You will need to be able to access the file from the Adafruit WebSerial ESPTool or another upload method.
Primary: Note that this file is approximately 3MB. This is not because the bootloader is that large, but because the bootloader needs to write data at both the beginning and end of flash. Most of the file is empty.
[Adafruit Metro ESP32-S3 bootloader 0.33.0 combined.bin](https://adafruit-circuit-python.s3.amazonaws.com/bootloaders/esp32/adafruit_metro_esp32s3/tinyuf2-adafruit_metro_esp32s3-0.33.0-combined.bin)
## Step 2. Enter ROM bootloader mode
Entering the ROM bootloader is easy. Complete the following steps.
**Before you start, make sure your ESP32-S2/S3 is plugged into USB port to your computer using a data/sync cable.** Charge-only cables will not work!
**Turn on the On/Off switch** - check that you see the OK light on so you know the board is powered, a prerequisite!
To enter the bootloader:
1. **Press and hold the BOOT/DFU button down.** Don't let go of it yet!
2. **Press and release the Reset button.** You should still have the BOOT/DFU button pressed while you do this.
3. **Now you can release the BOOT/DFU button.**
No USB drive will appear when you've entered the ROM bootloader. This is normal!
Now that you've downloaded the **.bin** file and entered the ROM bootloader, you're ready to continue installing the UF2 bootloader. The next two sections walk you through using the Adafruit WebSerial ESPTool (Alternative A) or `esptool.py` (Alternative B).
(There is also an Alternative C below, using the Arduino IDE, but it is less desirable, because it does not allow you to choose the bootloader that will be used.)
## Step 3: Alternative A. The Adafruit WebSerial ESPTool Method
Primary: We highly recommend using the Adafruit WebSerial ESPTool method to perform a factory reset and bootloader repair. However, if you'd rather use **esptool.py** via the command line, you can skip this section and use Alternative B instead.
This method uses the Adafruit WebSerial ESPTool through Chrome or a Chromium-based browser (including Opera and Edge). Adafruit WebSerial ESPTool is a web-based option for programming ESP32-S2/S3 boards. It allows you to erase the the microcontroller flash and program up to four files at different offsets.
You have to use a Chromium-based browser (Chrome, Opera, Edge, etc.) for this to work. Safari and Firefox are _not_ supported because they don't have adequate support for Web Serial functionality.
Follow the steps below to flash the UF2 bootloader.
Warning:
## Connect
You should have plugged in **only the ESP32-S2/S3 that you intend to flash**. That way there's no confusion in picking the proper port when it's time!
In the **Chrome browser** visit [https://adafruit.github.io/Adafruit\_WebSerial\_ESPTool/](https://adafruit.github.io/Adafruit_WebSerial_ESPTool/). You should see something like the image shown.
Leave the **No reset for Passthrough updates** toggle **off**.
Press the **Connect** button in the top right of the web browser. You will get a pop up asking you to select the COM or Serial port.
**Remember, you should remove all other USB devices so** **_only_ the ESP32-S2/S3 board is attached, that way there's no confusion over multiple ports!**
On some systems, such as MacOS, there may be additional system ports that appear in the list.
The JavaScript code will now try to connect to the ROM bootloader. It may timeout for a bit until it succeeds. On success, you will see that it is **Connected** and will print out a unique **MAC address** identifying the board along with other information that was detected.
Once you have successfully connected, the command toolbar will appear.
## Erase the Contents of Flash
Warning:
To erase the contents, click the Erase button. You will be prompted whether you want to continue. Click OK to continue or if you changed your mind, just click cancel.
You'll see "Erasing flash memory. Please wait..." This will eventually be followed by "Finished." and the amount of time it took to erase.
**Do not disconnect!** Immediately continue on to programming the ESP32-S2/S3.
Danger:
## Flash the Bootloader **.bin** File
Programming the ESP32-S2/S3 can be done with up to four files at different locations, but with the board-specific bootloader **.bin** file, which you should have downloaded under **Step 1** on this page, you only need to use one file.
Click on the first **Choose a file...**. (The tool will only attempt to program buttons with a file and a unique location.) Then, select the bootloader **.bin** file you downloaded in Step 1 that matches your board.
Verify that the **Offset** box next to the file location you used is (0x) **0**.
Once you choose a file, the button text will change to match your filename. You can then select the **Program** button to begin flashing.
A progress bar will appear and after a minute or two, you will have written the firmware.
Once completed, you can skip down to the section titled Reset the Board.
## Step 3: Alternative B. The `esptool.py` Method (for advanced users)
Danger: If you used Adafruit WebSerial ESPTool, you do not need to complete the steps in this section!
Once you have entered ROM bootloader mode, you can then [use Espressif's esptool program](https://github.com/espressif/esptool) to communicate with the chip! `esptool` is the 'official' programming tool and is the most common/complete way to program an ESP chip.
## Install `esptool.py`
You will need to use the command line or Terminal to install and run `esptool`.
You will also need to have pip and Python installed (any version!).
Install the latest version using pip (you may be able to run `pip` without the `3` depending on your setup):
`pip3 install --upgrade esptool`
Then, you can run:
`esptool.py`
Info:
## Test the Installation
Run `esptool.py` in a new terminal/command line and verify you get something like the below:
## Find the Serial Port
First, you need to determine the name of the serial port you board has when it's plugged in and ROM bootloader mode.
- For Windows, it will be a COM port, such as `COM5`. Look in Device Manager -\> Ports.
- For macOS, you can do `ls /dev/tty.*` in a Terminal to find the names of the serial ports.
- For Linux, you can do ls `/dev/tty*` in a terminal window. The name is often /dev/ttyACM0 or similar.
If you are not sure you've found the right port, unplug the board, and see if the port disappears.
For more information on determining serial ports, follow these links for help on [Windows](https://learn.adafruit.com/welcome-to-circuitpython/advanced-serial-console-on-windows#whats-the-com-2977217), [macOS](https://learn.adafruit.com/welcome-to-circuitpython/advanced-serial-console-on-mac-and-linux#whats-the-port-2977243), or [Linux](https://learn.adafruit.com/welcome-to-circuitpython/advanced-serial-console-on-linux#whats-the-port-3104855).
## Connect
Run the following command, replacing the identifier after `--port` with the `COMxx`, `/dev/cu.usbmodemxx` or `/dev/ttySxx` you found above.
For example, if you're using Windows, and you think the board is on COM88, type this following:
`esptool.py --port COM88 chip_id`
You should get a notice that it connected over that port and found an ESP32-S2/S3.
## Erase the Flash
Before programming the board, it is a good idea to erase the flash. Run the following command.
`esptool.py --port COM88 erase_flash`
You must be connected (by running the command in the previous section) for this command to work as shown.
## Flash the UF2 Bootloader
Run this command and replace the serial port name with your matching port and the file you just downloaded
`esptool.py --port COM88 write_flash 0x0 tinyuf2-some-board-0.32.0-combined.bin`
Don't forget to change the `--port` name to match.
Info: Adjust the bootloader filename accordingly if it differs from `tinyuf2-some-board-0.32.0-combined.bin`.
There might be a bit of a 'wait' when programming, where it doesn't seem like it's working. Give it a minute, it has to erase the old flash code which can cause it to seem like it's not running.
You'll finally get an output like this:
Once completed, you can continue to the next section.
## Step 4. Reset the board
The board should restart automatically, and start up the UF2 bootloader. If not, press the reset button to start the bootloader.
The easily visible part is the NeoPixel rainbow swirl, and little red LED blinking. If you open the serial monitor, you'll find it running an I2C scan, and periodically checking for an SD card and reporting the total PSRAM.
You've successfully returned installed the UF2 bootloader on your board. If you now want to return the board to a factory reset state, follow the instructions at the top of the page to **Install the Factory Reset Firmware UF2**.
## Older Versions of Chrome
Primary:
We suggest updating to Chrome 89 or newer, as Web Serial is enabled by default.
If you must continue using an older version of Chrome, follow these steps to enable Web Serial.
If you receive an error like the one shown when you visit the Adafruit WebSerial ESPTool site, you're likely running an older version of Chrome.
**You must be using Chrome 78 or later to use Web Serial.**
To enable Web Serial in Chrome versions 78 through 88:
- Visit **chrome://flags** from within Chrome.
- Find and enable the **Experimental Web Platform features**
- **Restart Chrome**
# Step 3: Alternative C. The Flash an Arduino Sketch Method
This section outlines flashing an Arduino sketch onto your ESP32-S2/S3 board, which automatically installs the UF2 bootloader as well. However, it does not allow you to choose which UF2 bootloader to install, so Alternative A or B above are preferred.
## Arduino IDE Setup
If you don't already have the Arduino IDE installed, the first thing you will need to do is to download the latest release of the Arduino IDE. ESP32-S2/S3 requires **version 1.8** or higher. Click the link to download the latest.
[Arduino IDE Download](https://www.arduino.cc/en/software)
After you have downloaded and installed ** ** the latest version of Arduino IDE, you will need to start the IDE and navigate to the **Preferences** menu. You can access it from the **File \> Preferences** menu in Windows or Linux, or the **Arduino \> Preferences** menu on OS X.
The **Preferences** window will open.
In the **Additional Boards Manager URLs** field, you'll want to add a new URL. The list of URLs is comma separated, and _you will only have to add each URL once._ The URLs point to index files that the Board Manager uses to build the list of available & installed boards.
Copy the following URL.
`https://raw.githubusercontent.com/espressif/arduino-esp32/gh-pages/package_esp32_dev_index.json`
Add the URL to the the **Additional Boards Manager URLs** field (highlighted in red below).
Click **OK** to save and close **Preferences**.
In the **Tools \> Boards** menu you should see the **ESP32 Arduino** menu. In the expanded menu, it should contain the ESP32 boards along with all the latest ESP32-S2 boards.
Now that your IDE is setup, you can continue on to loading the sketch.
## Load the Blink Sketch
Open the Blink sketch by clicking through **File \> Examples \> 01.Basics \> Blink**.
For the Arduino IDE to upload TinyUF2 you must select a TinyUF2 partition layout, under the **Tools \> Partition Scheme** menu.
If you have a 4MB board, won't be doing Over-The-Air firmware updates (OTA), or are unsure, then choose the 'No OTA' TinyUF2 entry.
Finally, click Upload from the sketch window.
Once successfully uploaded, the little red LED will begin blinking once every second. At that point, you can now enter the bootloader.
# Adafruit Metro ESP32-S3
## Install UF2 Bootloader
Warning: If your board already has the UF2 bootloader, installed you do not need to follow the steps on this page. Try to enter the UF2 bootloader before continuing! Double-tap the reset button to do so.
The Metro ESP32-S3 ships with a UF2 bootloader which allows the board to show up as **METROS3BOOT** when you double-tap the reset button, and enables you to drag and drop UF2 files to update the firmware.
On ESP32-S2 and ESP32-S3, there is no bootloader protection for the UF2 bootloader. That means it is possible to erase or damage the UF2 bootloader, especially if you upload an Arduino sketch to an ESP32-S2/S3 board that doesn't "know" there's a bootloader it should not overwrite!
It turns out, however, the ESP32-S2/S3 comes with a second bootloader: the ROM bootloader. Thanks to the ROM bootloader, you don't have to worry about damaging the UF2 bootloader. The ROM bootloader can never be disabled or erased, so its always there if you need it! You can simply re-load the UF2 bootloader from the ROM bootloader.
If your UF2 bootloader ends up damaged or overwritten, you can follow the steps found in the [Factory Reset and Bootloader Repair](https://learn.adafruit.com/adafruit-metro-esp32-s3/factory-reset#factory-reset-and-bootloader-repair-3107941) section of the Factory Reset page in this guide.
Once completed, you'll return to where the board was when you opened the package. Then you'll be back in business, and able to continue with your existing plans!
# Adafruit Metro ESP32-S3
## Downloads
## Files
- [ESP32-S3 product page with resources](https://www.espressif.com/en/products/socs/esp32-s3)
- [ESP32-S3 datasheet](https://cdn-learn.adafruit.com/assets/assets/000/119/042/original/esp32-s3_datasheet_en.pdf?1677679796)
- [ESP32-S3 Technical Reference](https://cdn-learn.adafruit.com/assets/assets/000/119/043/original/esp32-s3_technical_reference_manual_en.pdf?1677679919)
- [EagleCAD PCB files on GitHub](https://github.com/adafruit/Adafruit-Metro-ESP32-S3-PCB)
- [Fritzing object in the Adafruit Fritzing Library](https://github.com/adafruit/Fritzing-Library/blob/master/parts/Adafruit%20Metro%20ESP32-S3.fzpz)
- [PrettyPins PDF on GitHub](https://github.com/adafruit/Adafruit-Metro-ESP32-S3-PCB/blob/main/Adafruit%20Metro%20ESP32-S3%20Pinout.pdf)
- [PrettyPins SVG](https://cdn-learn.adafruit.com/assets/assets/000/126/036/original/adafruitMetroEsp32S3prettyPins.svg?1699631146)
## Schematic and Fab Print
### Rev B
### Rev A
## Primary Products
### Adafruit Metro ESP32-S3 with 16 MB Flash 8 MB PSRAM
[Adafruit Metro ESP32-S3 with 16 MB Flash 8 MB PSRAM](https://www.adafruit.com/product/5500)
What's Metro-shaped and has an ESP32-S3 WiFi module? What has a STEMMA QT connector for I2C devices and a Lipoly charger circuit? What has your favorite Espressif WiFi microcontroller and lots of memory for your next IoT project?
That's right - it's the new...
In Stock
[Buy Now](https://www.adafruit.com/product/5500)
[Related Guides to the Product](https://learn.adafruit.com/products/5500/guides)
## Featured Products
### USB Type A to Type C Cable - approx 1 meter / 3 ft long
[USB Type A to Type C Cable - approx 1 meter / 3 ft long](https://www.adafruit.com/product/4474)
As technology changes and adapts, so does Adafruit. This **USB Type A to Type C** cable will help you with the transition to USB C, even if you're still totin' around a USB Type A hub, computer or laptop.
USB C is the latest industry-standard connector for...
In Stock
[Buy Now](https://www.adafruit.com/product/4474)
[Related Guides to the Product](https://learn.adafruit.com/products/4474/guides)
## Related Guides
- [MP3 Playback with CircuitPython](https://learn.adafruit.com/mp3-playback-with-circuitpython.md)
- [Networking in CircuitPython](https://learn.adafruit.com/networking-in-circuitpython.md)
- [ESP-NOW in CircuitPython](https://learn.adafruit.com/esp-now-in-circuitpython.md)
- [Plotting Offline Data - JSONL to CSV files, filters and graphs](https://learn.adafruit.com/plotting-offline-data-jsonl-to-csv-files-filters-and-graphs.md)
- [Use Docker to Compile Linux for ESP32-S3](https://learn.adafruit.com/docker-esp32-s3-linux.md)
- [Adafruit Sensirion SHTC3 - Temperature & Humidity Sensor Breakout](https://learn.adafruit.com/adafruit-sensirion-shtc3-temperature-humidity-sensor.md)
- [Adafruit QT Py RP2040](https://learn.adafruit.com/adafruit-qt-py-2040.md)
- [Adafruit EyeLights LED Glasses and Driver](https://learn.adafruit.com/adafruit-eyelights-led-glasses-and-driver.md)
- [Color Sensing Music Player](https://learn.adafruit.com/color-sensing-music-player.md)
- [Multi-tasking with CircuitPython](https://learn.adafruit.com/multi-tasking-with-circuitpython.md)
- [QT Py RP2040 USB to Serial MIDI Friends](https://learn.adafruit.com/qt-py-rp2040-usb-to-serial-midi-friends.md)
- [Talking D20 with RP2040 PropMaker Feather](https://learn.adafruit.com/talking-d20-rp2040.md)
- [MagTag Literary Quote Clock](https://learn.adafruit.com/magtag-literary-quote-clock.md)
- [Haunted Air Blaster](https://learn.adafruit.com/automated-air-blaster.md)
- [Adafruit Metro M7 1011 with AirLift](https://learn.adafruit.com/adafruit-metro-m7-with-airlift.md)