Core Modules
These core modules are intended on being consistent across ports and boards.
A module may not exist on a port/board if no underlying hardware support is
present or if flash space is limited. For example, a microcontroller without
analog features will not have analogio. See the Module Support Matrix - Which Modules Are Available on Which Boards page for
a list of modules supported on each board.
Modules
Note
Some modules are documented in Standard Libraries, not here:
builtins, heapq, array, binascii, collections, errno, gc,
io, json, re, sys, select.
The documentation for
help()is at the end of this page.
_bleio– Bluetooth Low Energy (BLE) communication_eve– Low-level BridgeTek EVE bindings_pew– LED matrix driver_pixelmap– A fast pixel mapping library_stage– C-level helpers for animation of sprites on a stageadafruit_bus_device– Hardware accelerated external bus accessadafruit_pixelbuf– A fast RGB(W) pixel buffer library for like NeoPixel and DotStaraesio– AES encryption routinesalarm– Alarms and sleepanalogbufio– Analog Buffered IO Hardware Supportanalogio– Analog hardware supportatexit– Atexit Moduleaudiobusio– Support for audio input and output over digital busesaudiocore– Support for audio samplesaudiodelays– Support for audio delay effectsaudiofilters– Support for audio filter effectsaudiofreeverb– Support for audio freeverb effectaudioio– Support for audio outputaudiomixer– Support for audio mixingaudiomp3– Support for MP3-compressed audio filesaudiopwmio– Audio output via digital PWMaurora_epaper– A framebuffer for Pervasive Displays Aurora E-paper displays.bitbangio– Digital protocols implemented by the CPUbitmapfilter– Convolve an image with a kernelbitmaptools– Collection of bitmap manipulation toolsbitops– Routines for low-level manipulation of binary databoard– Board specific pin namesbusdisplaybusio– Hardware accelerated external bus accesscamera– Support for camera inputcanio– CAN bus accesscodeop– Utilities to compile possibly incomplete Python source code.countio– Support for edge countingcyw43– A class that represents a GPIO pin attached to the wifi chip.digitalio– Basic digital pin supportdisplayio– High level, display object compositing systemdotclockframebuffer– Native helpers for driving parallel displaysdualbank– Dualbank Moduleepaperdisplayespcamera– Wrapper for the espcamera libraryespidf– Return the total size of the ESP-IDF, which includes the CircuitPython heap.espnow– ESP-NOW Moduleespulp– ESP Ultra Low Power Processor Modulefloppyio– Read flux transition information into the buffer.fontio– Core font related data structuresfourwire– Connects to a BusDisplay over a four wire busframebufferio– Native framebuffer display drivingfrequencyio– Support for frequency based protocolsgetpass– Getpass Modulegifio– Access GIF-format imagesgnss– Global Navigation Satellite Systemhashlib– Hashing related functionsi2cdisplaybus– Communicates to a display IC over I2Ci2ctarget– Two wire serial protocol targetimagecapture– Support for “Parallel capture” interfacesipaddressis31fl3741– Creates an in-memory framebuffer for a IS31FL3741 device.jpegio– Support for JPEG image decodingkeypad– Support for scanning keys and key matriceskeypad_demux– Support for scanning key matrices that use a demultiplexerlocale– Locale support modulelvfontio– Core font related data structures for LVGLmath– mathematical functionsmax3421e– Provide USB host via a connected MAX3421E chip.mdns– Multicast Domain Name Servicememorymap– Raw memory map accessmemorymonitor– Memory monitoring helpersmicrocontroller– Pin references and cpu functionalitymsgpack– Pack object in msgpack formatneopixel_write– Low-level neopixel implementationnvm– Non-volatile memoryonewireio– Low-level bit primitives for Maxim (formerly Dallas Semi) one-wire protocol.os– functions that an OS normally providesparalleldisplaybus– Native helpers for driving parallel displayspicodvi– Low-level routines for interacting with PicoDVI Outputps2io– Support for PS/2 protocolpulseio– Support for individual pulse based protocolspwmio– Support for PWM based protocolsqrio– Low-level QR code decodingrainbowiorandom– pseudo-random numbers and choicesrgbmatrix– Low-level routines for bitbanged LED matricesrotaryio– Support for reading rotation sensorsrp2pio– Hardware interface to RP2 series’ programmable IO (PIO) peripheral.rtc– Real Time Clocksamd– SAMD implementation settingssdcardio– Interface to an SD card via the SPI bussdioio– Interface to an SD card via the SDIO bussharpdisplay– Support for Sharp Memory Display framebufferssocketpoolspitarget– Serial Peripheral Interface protocol targetsslstorage– Storage managementstruct– Manipulation of c-style datasupervisor– Supervisor settingssynthio– Support for multi-channel audio synthesisterminalio– Displays text in a TileGridtilepalettemapper– Remaps color indices from the source bitmap to alternate indices on a per-tile basis. This allows for altering coloring of tiles based on their tilegrid location. It also allows for using a limited color bitmap with a wider array of colors.time– time and timing related functionstouchio– Touch related IOtraceback– Traceback Moduleuheap– Heap size analysisulab– Manipulate numeric data similar to numpyusb– PyUSB-compatible USB host APIusb_cdc– USB CDC Serial streamsusb_hid– USB Human Interface Deviceusb_host– USB Hostusb_midi– MIDI over USBusb_video– Allows streaming bitmaps to a host computer via USBustack– Stack information and analysisvectorio– Lightweight 2D shapes for displaysvideocore– Low-level routines for interacting with the Broadcom VideoCore GPUwarnings– Warn about potential code issues.watchdog– Watchdog Timerwifizephyr_serial– Zephyr UART driver for fixed busses.zlib– zlib decompression functionalityhelp()– Built-in method to provide helpful information