How do I install micropython-lib packages on my MicroPython board?

Use the mip package manager if your board has network connectivity, or mpremote from your PC for serial connections. For example, run 'mip.install("package-name")' on the device or 'mpremote mip install package-name' from the terminal. Freezing into firmware is another option for embedded deployments.

What's the difference between micropython-lib and regular Python libraries from PyPI?

micropython-lib provides ports of Python libraries adapted for MicroPython's resource constraints, often with reduced functionality and missing features. PyPI libraries are designed for CPython and may not run on microcontrollers due to memory or performance issues.

Can I use micropython-lib packages with CPython or other Python versions?

No, micropython-lib packages are specifically optimized for MicroPython and may not be compatible with CPython. They are tailored for embedded environments and might lack features or have different implementations, limiting cross-platform use.

How to freeze micropython-lib packages into my MicroPython firmware?

Include the package's manifest.py in your board manifest using the require() command during firmware build. This embeds the library directly into the binary, reducing RAM usage and startup time for production embedded applications.

Are all Python standard library modules available in micropython-lib?

Not all modules are available, and those that are often have reduced functionality with missing methods or classes. The python-stdlib directory contains compatible versions, but you should check the specific package for limitations, as noted in the README.

micropython-lib vs writing custom drivers: which is better for hardware projects?

micropython-lib offers pre-made drivers for common hardware, saving development time and effort. However, for specialized or proprietary hardware, writing custom drivers might be necessary. Evaluate based on community support, documentation, and your project's specific needs.

Open-Awesome

Official nRF24L01

NOASSERTIONPython

A collection of Python libraries ported and adapted for MicroPython, enabling standard and ecosystem packages on microcontrollers.

GitHub

2.9k stars1.1k forks0 contributors

What is Official nRF24L01?

micropython-lib is a collection of Python libraries ported and adapted for MicroPython, the lightweight Python implementation for microcontrollers. It provides compatible versions of standard library modules, popular PyPI packages, and MicroPython-specific hardware drivers, enabling developers to use familiar Python libraries on resource-constrained embedded devices.

Target Audience

MicroPython developers working on embedded systems, IoT devices, and microcontroller projects who need access to Python libraries in constrained environments.

Value Proposition

It solves the problem of library availability in MicroPython by providing carefully adapted packages that balance functionality with resource constraints, allowing developers to leverage existing Python knowledge and code on microcontrollers.

Overview

Core Python libraries ported to MicroPython

Use Cases

Best For

Adding standard Python functionality like base64 or collections to MicroPython projects
Using popular PyPI packages on microcontrollers with limited resources
Developing hardware drivers for sensors and peripherals in MicroPython
Building IoT applications with Bluetooth or network capabilities
Extending MicroPython's Unix port with operating-system libraries via FFI
Creating firmware with frozen libraries for embedded deployments

Not Ideal For

Projects requiring full-featured Python standard library modules without any reduced functionality
Teams needing the latest versions or complete implementations of PyPI packages for desktop or server applications
Developers working exclusively with CPython or other Python implementations outside of embedded systems

Pros & Cons

Pros

Standard Library Ports

Provides drop-in replacements for CPython standard library modules, enabling familiar Python code on MicroPython with minimal changes, as described in the python-stdlib category.

Ecosystem Package Adaptations

Offers compatible, reduced-functionality versions of popular PyPI packages for MicroPython, allowing use of community libraries in resource-constrained environments, evidenced by the python-ecosys directory.

MicroPython-Specific Hardware Libraries

Includes drivers for sensors, Bluetooth, and other embedded functionality not available in standard Python, as highlighted in the micropython directory for hardware-specific tasks.

Flexible Installation Methods

Supports installation via mip package manager, mpremote tool, freezing into firmware, or manual copying, providing versatility for different development workflows, as detailed in the Usage section.

Cons

Reduced Functionality

Many modules have missing methods or classes compared to CPython counterparts, limiting advanced usage, as admitted in the README for python-stdlib packages.

Manual Dependency Management

When installing via manual file copying, developers must resolve dependencies manually by inspecting manifest.py files, adding complexity and potential for errors, as noted in the README.

Limited Package Ecosystem

Focused on MicroPython and embedded systems, it lacks the breadth and depth of PyPI for general-purpose Python development, with fewer packages available.

Frequently Asked Questions

Related Projects

micropython_remote

Capture and replay 433MHz remote control codes. Control remote switched power adaptors.

Stars84

Forks15

Last commit4 years ago

micropython-radio

Simple way to use an nRF24L01 radio to exchange arbitrary Python objects between two Pyboards

Stars60

Forks12

Last commit3 years ago

micropython-TEA5767

MicroPython driver for TEA5767 FM radio module on ESP8266/ESP32/Pico

Stars52

Forks9

Last commit2 years ago

micropython-rfsocket

Micropython implementation of popular 433MHzn based RFSockets (i.e. Anslut/Proove/Nexa)

Stars34

Forks0

Last commit7 years ago

Community-curated · Updated weekly · 100% open source

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.

Submit a project Star on GitHub