adafruit/circuitpythonFork
Circuitpython
CircuitPython is a specialized derivative of the MicroPython runtime designed as an embedded Python interpreter for microcontrollers. It provides a high-level language environment that allows for direct hardware access through a dedicated hardware abstraction layer and a Python microcontroller runtime.
The project is distinguished by firmware that exposes the microcontroller as a native USB mass storage device. This allows users to edit code directly on the device as if it were a removable drive, eliminating the need for specialized flashing tools and enabling filesystem-triggered code reloading.
The system covers a broad range of capabilities including unified hardware API access for controlling electronic components across different boards, serial-based communication via REPL and WebUSB, and a port-based system for board-specific firmware compilation. It also includes developer tooling such as type stub generation for static analysis and a crash recovery mode to maintain device accessibility during troubleshooting.
Features
- Mass Storage Deployment - Exposes the device internal filesystem as a native USB mass storage device for direct code editing without flashing tools.
- Microcontroller Programming - Enables controlling microcontroller pins and hardware using Python instead of low-level C or assembly firmware.
- Hardware-Specific Firmware Images - Builds executable firmware tailored for specific microcontroller boards using a port-based system and configurable flags.
- MicroPython Runtimes - Provides a specialized Python runtime optimized for ease of use on small hardware devices.
- USB Configuration Drives - Exposes the device as a native USB drive to allow direct file editing without specialized flashing tools.
- File-Change-Triggered Restarts - Automatically restarts the main program when changes to files on the internal storage are detected.
- Hardware Abstraction Layers - Provides a unified interface layer to standardize hardware access across different microcontroller architectures and pin configurations.
- Microcontroller Firmware Frameworks - Provides a complete framework for building and configuring custom firmware for various microcontroller boards.
- Removable Storage Emulation - Allows mounting the onboard filesystem as a removable drive for direct file transfers and code updates.
- Unified Hardware Interfaces - Provides a consistent set of software interfaces to control diverse microcontroller boards and sensors.
- Source-to-Bytecode Compilers - Transforms high-level Python source code into compact bytecode for efficient execution on constrained microcontroller hardware.
- Embedded Python Interpreters - Implements a compact software layer that executes Python code directly on microcontroller hardware.
- Runtime Bytecode Compilation - Transforms source files into compact bytecode for efficient execution on target microcontroller runtimes.
- Microcontroller Runtimes - Implements a Python runtime specifically optimized for resource-constrained microcontroller environments.
- Firmware Crash Recovery - Prevents user code from running after a hard crash to ensure the device remains accessible for troubleshooting.
- Firmware Debugging - Provides specialized tools for inspecting memory and execution flow on microcontroller hardware using debug probes.
- Hot Code Reloading - Implements a mechanism to automatically restart the main program when changes to the internal filesystem are detected.
- Firmware Build Configuration - Manages firmware compilation through a nested system of configuration files tailored to specific boards and hardware ports.
- Boot Sequence Automation - Automatically executes specific scripts during system boot, recovery states, or following filesystem changes.
- Embedded Systems Debugging - Supports monitoring real-time device logs and inspecting firmware state through serial consoles and debugging probes.
- Hardware Prototyping Frameworks - Provides a high-level environment for rapidly iterating on hardware projects by editing code directly on the device.
- Interactive REPL Interfaces - Provides a bidirectional communication channel over USB or WebUSB for real-time command execution and system logging.
- File System Mounts - Provides a dedicated storage module to control how various storage media are mounted and accessed.
- High-Level Hardware Programming - Allows operating low-cost hardware using a simplified high-level language environment instead of low-level code.
- Hierarchical Configuration Systems - Allows modifying board or port behavior using a hierarchical system of makefiles and compile-time options.
- Embedded Log Capture - Retrieves real-time execution logs and stack traces from embedded target devices via stable serial identifiers.
- Serial Communication - Supports establishing a serial console interface to send and receive data via WebUSB without specialized drivers.
- Core Frameworks - The primary source code repository for the firmware.
Star history
How this analysis was created: This summary and feature list were written by an AI model that read the project's README and public documentation pages. Each feature links to the documentation it came from; stars, license and language come straight from the GitHub API. The model does not read the source code, and the analysis is refreshed when the project is re-analysed. Learn more on our About page.
