76 lines
2.9 KiB
Markdown
76 lines
2.9 KiB
Markdown
# mpremote -- MicroPython remote control
|
|
|
|
This CLI tool provides an integrated set of utilities to remotely interact with
|
|
and automate a MicroPython device over a serial connection.
|
|
|
|
The simplest way to use this tool is:
|
|
|
|
mpremote
|
|
|
|
This will automatically connect to the device and provide an interactive REPL.
|
|
|
|
The full list of supported commands are:
|
|
|
|
mpremote connect <device> -- connect to given device
|
|
device may be: list, auto, id:x, port:x
|
|
or any valid device name/path
|
|
mpremote disconnect -- disconnect current device
|
|
mpremote mount <local-dir> -- mount local directory on device
|
|
mpremote eval <string> -- evaluate and print the string
|
|
mpremote exec <string> -- execute the string
|
|
mpremote run <file> -- run the given local script
|
|
mpremote fs <command> <args...> -- execute filesystem commands on the device
|
|
command may be: cat, ls, cp, rm, mkdir, rmdir
|
|
use ":" as a prefix to specify a file on the device
|
|
mpremote repl -- enter REPL
|
|
options:
|
|
--capture <file>
|
|
--inject-code <string>
|
|
--inject-file <file>
|
|
mpremote help -- print list of commands and exit
|
|
|
|
Multiple commands can be specified and they will be run sequentially. Connection
|
|
and disconnection will be done automatically at the start and end of the execution
|
|
of the tool, if such commands are not explicitly given. Automatic connection will
|
|
search for the first available serial device. If no action is specified then the
|
|
REPL will be entered.
|
|
|
|
Shortcuts can be defined using the macro system. Built-in shortcuts are:
|
|
|
|
- a0, a1, a2, a3: connect to `/dev/ttyACM?`
|
|
- u0, u1, u2, u3: connect to `/dev/ttyUSB?`
|
|
- c0, c1, c2, c3: connect to `COM?`
|
|
- cat, ls, cp, rm, mkdir, rmdir, df: filesystem commands
|
|
- reset: reset the device
|
|
- bootloader: make the device enter its bootloader
|
|
|
|
Any user configuration, including user-defined shortcuts, can be placed in
|
|
.config/mpremote/config.py. For example:
|
|
|
|
# Custom macro commands
|
|
commands = {
|
|
"c33": "connect id:334D335C3138",
|
|
"bl": "bootloader",
|
|
"double x=4": {
|
|
"command": "eval x*2",
|
|
"help": "multiply by two"
|
|
}
|
|
}
|
|
|
|
Examples:
|
|
|
|
mpremote
|
|
mpremote a1
|
|
mpremote connect /dev/ttyUSB0 repl
|
|
mpremote ls
|
|
mpremote a1 ls
|
|
mpremote exec "import micropython; micropython.mem_info()"
|
|
mpremote eval 1/2 eval 3/4
|
|
mpremote mount .
|
|
mpremote mount . exec "import local_script"
|
|
mpremote ls
|
|
mpremote cat boot.py
|
|
mpremote cp :main.py .
|
|
mpremote cp main.py :
|
|
mpremote cp -r dir/ :
|