921f397acb
On MacOS and Windows there are a few default serial devices that are
returned by `serial.tools.list_ports.comports()`. For example on MacOS:
```
{'description': 'n/a',
'device': '/dev/cu.Bluetooth-Incoming-Port',
'hwid': 'n/a',
'interface': None,
'location': None,
'manufacturer': None,
'name': 'cu.Bluetooth-Incoming-Port',
'pid': None,
'product': None,
'serial_number': None,
'vid': None}
{'description': 'n/a',
'device': '/dev/cu.wlan-debug',
'hwid': 'n/a',
'interface': None,
'location': None,
'manufacturer': None,
'name': 'cu.wlan-debug',
'pid': None,
'product': None,
'serial_number': None,
'vid': None}
```
Users of mpremote most likely do not want to connect to these ports. It
would be desirable if mpremote did not select this ports when using the
auto connect behavior. These serial ports do not have USB VID or PID
values and serial ports for Micropython boards with FTDI/serial-to-USB
adapter or native USB CDC/ACM support do.
Check for the presence of a USB VID / PID int value when selecting a
serial port to auto connect to. All serial ports will still be listed by
the `list` command and can still be selected by name when connecting.
Signed-off-by: Michael Mogenson <michael.mogenson@gmail.com>
83 lines
3.3 KiB
Markdown
83 lines
3.3 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 a USB serial port 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 mip install <package...> -- Install packages (from micropython-lib or third-party sources)
|
|
options:
|
|
--target <path>
|
|
--index <url>
|
|
--no-mpy
|
|
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/ :
|
|
mpremote mip install aioble
|
|
mpremote mip install github:org/repo@branch
|