micropython-lib

这是一个用于编写 MicroPython 应用程序的实用包仓库。

这里的包分为四个顶级目录，对应以下几类：

python-stdlib：与 Python 标准库兼容的模块版本。这些应该是相应 Python 模块的直接替代品，尽管许多模块功能有所减少或缺少某些方法或类（在大多数情况下可能不是问题）。
python-ecosys：与更广泛的 Python 生态系统中的包兼容，但功能减少的版本。例如，可能在 Python 包索引中找到的包。
micropython：特定于 MicroPython 的包，在其他 Python 环境中没有等效物。这包括硬件驱动程序（如传感器、外设或显示器）、用于嵌入式功能的库（如蓝牙），或在 CPython 中没有等效物的 MicroPython 特定包。
unix-ffi：这些包专门用于 MicroPython Unix 端口，通过 FFI 提供对操作系统和第三方库的访问，或提供对非 Unix 端口无用的功能。

使用方法

安装 micropython-lib 包有四种主要方式。更多信息请参阅包管理文档。

在支持网络的设备上

从 MicroPython v1.20（以及 2022 年 10 月以来的每日构建版本）开始，支持 WiFi 和以太网的开发板包含 mip 包管理器。

>>> import mip
>>> mip.install("package-name")

使用电脑上的 `mpremote`

mpremote 是官方支持的用于与 MicroPython 设备交互的工具，从 v0.4.0 版本开始，通过使用 mip 命令提供安装 micropython-lib 包的支持。

$ mpremote connect /dev/ttyUSB0 mip install package-name

请参阅 mpremote 文档。

冻结到固件中

如果你正在构建自己的固件，本仓库中的所有包都包含一个 manifest.py，可以通过 require() 命令将其包含到你的开发板清单中。更多信息请参阅清单文件。

手动复制文件

许多 micropython-lib 包只是单文件模块，你可以通过将相关的 Python 文件复制到设备上快速开始。例如，要添加 base64 库，你可以直接将 python-stdlib/base64/base64.py 复制到设备上的 lib 目录中。

这可以使用 mpremote 完成，例如：

$ mpremote connect /dev/ttyUSB0 cp python-stdlib/base64/base64.py :/lib

对于作为包目录实现的包，你需要复制整个目录。例如，要添加 collections.defaultdict，将 collections/collections/__init__.py 和 collections-defaultdict/collections/defaultdict.py 复制到设备上名为 lib/collections 的目录中。

请注意，与基于 mip 或 manifest.py 的其他三种方法不同，你需要手动解决依赖关系。你可以检查相关的 manifest.py 文件来查看给定包的依赖列表。

从分叉安装包

可以使用 mpremote mip install 或 mip.install() 方法安装从 micropython-lib 分叉构建的包，前提是分叉的所有者已选择加入。

这对于安装待处理的拉取请求中的包很有用。

首先，分叉的所有者必须按照从分叉发布包中描述的方式选择加入。

之后，每次有人向该分叉的分支推送时，GitHub Actions 将自动将包发布到 GitHub Pages 站点。

要安装这些包，使用如下命令：

$ mpremote connect /dev/ttyUSB0 mip install --index https://USERNAME.github.io/micropython-lib/mip/BRANCH_NAME PACKAGE_NAME

或者在支持网络的设备上：

import mip
mip.install(PACKAGE_NAME, index="https://USERNAME.github.io/micropython-lib/mip/BRANCH_NAME")

（其中 USERNAME、BRANCH_NAME 和 PACKAGE_NAME 分别替换为分叉的所有者、构建包的分支和包名。）

贡献

我们使用 GitHub Discussions 作为论坛，Discord 用于聊天。这些是向社区询问问题和寻求建议或讨论基于 MicroPython 的项目的好地方。

MicroPython Wiki 也用于 micropython-lib。

对于错误和功能请求，请提出问题。

我们欢迎提交拉取请求来添加新包、修复错误或添加功能。请务必遵循贡献者指南和代码约定。请注意，MicroPython 是根据 MIT 许可证授权的，所有贡献都应遵循此许可证。

未来计划（和新贡献者想法）

开发一套使用这些包的示例程序。
为常见任务开发更多 MicroPython 包。
扩展单元测试覆盖范围。
添加对引用远程/第三方仓库的支持。

术语说明

"库"、"包"和"模块"这些术语有重叠，可能导致一些混淆。MicroPython 项目使用的解释如下：

"库"是可安装包的集合，例如 Python 标准库或 micropython-lib。

"包"可以指两种东西。第一个含义是"库包"，即可以从库安装的东西，例如通过 mip（或在 CPython/PyPI 中的 pip）。包提供可导入的"模块"。这里的歧义在于，包提供的模块不一定要有相同的名称，例如 pyjwt 包提供 jwt 模块。在 CPython 中，提供 serial 模块的 pyserial 包是另一个常见例子。

"模块"是可以导入的东西。例如，"os 模块"。

模块可以实现为单个文件，通常也称为"模块"或"单文件模块"，或作为"包"（第二个含义），在这种情况下意味着包含多个 .py 文件的目录（通常至少包含 __init__.py）。

在 micropython-lib 中，我们还有"扩展包"的概念，它是通过向同一包目录添加额外文件来扩展另一个包功能的库包。这些包有连字符名称。例如，collections-defaultdict 包扩展了 collections 包，将 defaultdict 类添加到 collections 模块中。