adafruit-ampy 1.1.0

ampy

MicroPython工具（ampy）- 通过串行连接与CircuitPython或MicroPython板交互的实用工具。

Ampy旨在成为一个简单的命令行工具，用于在CircuitPython或MicroPython板上通过其串行连接操作文件和运行代码。使用ampy，您可以将文件从您的计算机发送到板的文件系统，从板下载文件到您的计算机，甚至可以向板发送Python脚本来执行。

请注意，ampy的设计目的是简单易用，不支持像shell或终端这样的高级交互，用于向板发送输入。有关与板进行更高级交互的其他MicroPython工具，请参阅rshell或mpfshell。

安装

您可以使用Ampy与Python 2.7.x或3.x版本，并可以从Python的包索引中轻松安装。在MacOS或Linux上，在终端运行以下命令（假设使用Python 3）：

pip3 install --user adafruit-ampy

在Windows上，请执行以下操作：

pip install adafruit-ampy

注意：在某些Linux和MacOS X系统上，您可能需要以root权限使用sudo运行。

sudo pip3 install adafruit-ampy

如果您没有Python 3，则尝试使用Python 2版本：

pip install adafruit-ampy

安装完成后，验证您是否可以运行Ampy程序并获取帮助输出。

ampy --help

您应该会看到如下所示的用法信息。

Usage: ampy [OPTIONS] COMMAND [ARGS]...

  ampy - Adafruit MicroPython Tool

  Ampy is a tool to control MicroPython boards over a serial connection.
  Using ampy you can manipulate files on the board's internal filesystem and
  even run scripts.

Options:
  -p, --port PORT  Name of serial port for connected board.  [required]
  -b, --baud BAUD  Baud rate for the serial connection. (default 115200)
  -d, --delay DELAY Delay in seconds before entering RAW MODE (default 0)
  --help           Show this message and exit.

Commands:
  get  Retrieve a file from the board.
  ls   List contents of a directory on the board.
  put  Put a file on the board.
  rm   Remove a file from the board.
  run  Run a script and print its output.

如果您想从GitHub源安装，请使用标准的Python setup.py install（或开发模式）。

python3 setup.py install

注意：要在Python 2上运行单元测试，您必须安装mock库。

pip install mock

用法

Ampy被设计用来通过串行连接与CircuitPython MicroPython板通信。您需要将您的板连接好，并安装任何用于访问其串行端口的驱动程序。例如，要列出板上的文件，可以运行以下命令：

ampy --port /dev/tty.SLAB_USBtoUART ls

您应该在终端中看到板根目录下的文件列表。请注意，您需要将端口号参数更改为MicroPython板连接到的串行端口的名称或路径。

其他命令可用，请运行ampy --help以获取更多信息。

ampy --help

每个子命令都有自己的帮助，例如，要查看ls命令的帮助，请运行（请注意，您不幸地必须连接板并指定串行端口）：

ampy --port /dev/tty.SLAB_USBtoUART ls --help

配置

为了方便，您可以设置一个AMPY_PORT环境变量，如果未指定端口号参数，则会使用此变量。例如，在Linux或OSX上：

export AMPY_PORT=/dev/tty.SLAB_USBtoUART
ampy ls

或者在Windows上（未经测试）尝试SET命令：

set AMPY_PORT=COM4
ampy ls

同样，您可以设置AMPY_BAUD和AMPY_DELAY来控制您的波特率和进入RAW MODE前的延迟。

要将这些变量自动设置，每次运行ampy时，请将它们复制到名为.ampy的文件中。

# Example .ampy file
# Please fill in your own port, baud rate, and delay
AMPY_PORT=/dev/cu.wchusbserial1410
AMPY_BAUD=115200
# Fix for macOS users' "Could not enter raw repl"; try 2.0 and lower from there:
AMPY_DELAY=0.5

您可以将.ampy文件放在您的当前工作目录、其中一个父目录或您的家目录中。