ampy
A command-line tool for file manipulation and code execution on MicroPython/CircuitPython boards over serial connection.
What is ampy?
ampy is a command-line utility that enables developers to interact with MicroPython and CircuitPython boards over a serial connection. It solves the problem of managing files and executing code on embedded devices by providing simple commands to transfer files, run scripts, and perform basic filesystem operations directly from a terminal.
Embedded developers and hobbyists working with MicroPython or CircuitPython boards who need a straightforward tool for file management and code execution without complex setup.
Developers choose ampy for its simplicity and focus on essential operations, avoiding the overhead of more advanced interactive shells while providing reliable serial communication and easy configuration through environment variables.
Overview
MicroPython Tool - Utility to interact with a MicroPython board over a serial connection.
Use Cases
Best For
- Transferring Python scripts to MicroPython boards for execution
- Managing files on CircuitPython devices without a full terminal
- Automating file uploads and downloads to embedded systems
- Running one-off scripts on MicroPython boards from a computer
- Basic filesystem operations on resource-constrained IoT devices
- Quick prototyping with MicroPython using simple command-line tools
Not Ideal For
- Developers needing an interactive shell or terminal for real-time debugging and input on MicroPython boards
- Projects requiring coding and file transfer over WiFi without a physical serial connection
- Teams looking for advanced features like file synchronization, GUI interfaces, or plugin-based extensibility
Pros & Cons
Pros
Can be installed via pip for both Python 2.7.x and 3.x with clear commands for different OSes, as shown in the installation section.
Supports environment variables and a .ampy config file to set serial port, baud rate, and delay, reducing repetitive command-line arguments.
Provides essential commands like get, put, ls, and rm for managing files on the board, making basic tasks straightforward.
Allows running Python scripts on the board from the command line with the 'run' command, enabling quick testing and deployment.
Cons
Lacks support for terminal interactions, limiting debugging and real-time input, as explicitly stated in the README when comparing to tools like rshell.
Relies solely on serial cables for connectivity, with no current support for wireless methods like WiFi, unlike the upcoming ampy-2 version mentioned in the README.
The current version is being replaced by ampy-2, which may lead to reduced maintenance and potential breaking changes for users.
Frequently Asked Questions
Found a gem we're missing?
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.