| Name | mpremote JSON |
| Version |
1.24.0
JSON |
| download |
| home_page | None |
| Summary | Tool for interacting remotely with MicroPython devices |
| upload_time | 2024-10-25 14:48:24 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.4 |
| license | MIT |
| keywords |
hardware
micropython
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# 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, sha256sum
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 sha256sum :main.py
mpremote mip install aioble
mpremote mip install github:org/repo@branch
mpremote mip install gitlab:org/repo@branch
Raw data
{
"_id": null,
"home_page": null,
"name": "mpremote",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.4",
"maintainer_email": null,
"keywords": "hardware, micropython",
"author": null,
"author_email": "Damien George <damien@micropython.org>",
"download_url": "https://files.pythonhosted.org/packages/cc/fb/4b9f6600a31fa72c9a294f2007dedd9583df25fac0483b4594288163a8ac/mpremote-1.24.0.tar.gz",
"platform": null,
"description": "# mpremote -- MicroPython remote control\n\nThis CLI tool provides an integrated set of utilities to remotely interact with\nand automate a MicroPython device over a serial connection.\n\nThe simplest way to use this tool is:\n\n mpremote\n\nThis will automatically connect to a USB serial port and provide an interactive REPL.\n\nThe full list of supported commands are:\n\n mpremote connect <device> -- connect to given device\n device may be: list, auto, id:x, port:x\n or any valid device name/path\n mpremote disconnect -- disconnect current device\n mpremote mount <local-dir> -- mount local directory on device\n mpremote eval <string> -- evaluate and print the string\n mpremote exec <string> -- execute the string\n mpremote run <file> -- run the given local script\n mpremote fs <command> <args...> -- execute filesystem commands on the device\n command may be: cat, ls, cp, rm, mkdir, rmdir, sha256sum\n use \":\" as a prefix to specify a file on the device\n mpremote repl -- enter REPL\n options:\n --capture <file>\n --inject-code <string>\n --inject-file <file>\n mpremote mip install <package...> -- Install packages (from micropython-lib or third-party sources)\n options:\n --target <path>\n --index <url>\n --no-mpy\n mpremote help -- print list of commands and exit\n\nMultiple commands can be specified and they will be run sequentially. Connection\nand disconnection will be done automatically at the start and end of the execution\nof the tool, if such commands are not explicitly given. Automatic connection will\nsearch for the first available serial device. If no action is specified then the\nREPL will be entered.\n\nShortcuts can be defined using the macro system. Built-in shortcuts are:\n\n- a0, a1, a2, a3: connect to `/dev/ttyACM?`\n- u0, u1, u2, u3: connect to `/dev/ttyUSB?`\n- c0, c1, c2, c3: connect to `COM?`\n- cat, ls, cp, rm, mkdir, rmdir, df: filesystem commands\n- reset: reset the device\n- bootloader: make the device enter its bootloader\n\nAny user configuration, including user-defined shortcuts, can be placed in\n.config/mpremote/config.py. For example:\n\n # Custom macro commands\n commands = {\n \"c33\": \"connect id:334D335C3138\",\n \"bl\": \"bootloader\",\n \"double x=4\": {\n \"command\": \"eval x*2\",\n \"help\": \"multiply by two\"\n }\n }\n\nExamples:\n\n mpremote\n mpremote a1\n mpremote connect /dev/ttyUSB0 repl\n mpremote ls\n mpremote a1 ls\n mpremote exec \"import micropython; micropython.mem_info()\"\n mpremote eval 1/2 eval 3/4\n mpremote mount .\n mpremote mount . exec \"import local_script\"\n mpremote ls\n mpremote cat boot.py\n mpremote cp :main.py .\n mpremote cp main.py :\n mpremote cp -r dir/ :\n mpremote sha256sum :main.py\n mpremote mip install aioble\n mpremote mip install github:org/repo@branch\n mpremote mip install gitlab:org/repo@branch\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Tool for interacting remotely with MicroPython devices",
"version": "1.24.0",
"project_urls": {
"Homepage": "https://github.com/micropython/micropython"
},
"split_keywords": [
"hardware",
" micropython"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "58434805fa350c5a05cc4a6b11c11c596910d6e0732ee3a8ff2781d6b69abcbd",
"md5": "e76fd28e0c33f59728b184f8e2157c4f",
"sha256": "c8815edfdcb0bbdf86ff892ec194c66c7069e6a4e676540277beafa8e9ade6a0"
},
"downloads": -1,
"filename": "mpremote-1.24.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e76fd28e0c33f59728b184f8e2157c4f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.4",
"size": 29181,
"upload_time": "2024-10-25T14:48:21",
"upload_time_iso_8601": "2024-10-25T14:48:21.955475Z",
"url": "https://files.pythonhosted.org/packages/58/43/4805fa350c5a05cc4a6b11c11c596910d6e0732ee3a8ff2781d6b69abcbd/mpremote-1.24.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ccfb4b9f6600a31fa72c9a294f2007dedd9583df25fac0483b4594288163a8ac",
"md5": "8b3878b507daaa58beeb42ac7915d27b",
"sha256": "407561833b8d763e9f2f35823ef3d8276fe7b723b9abf7eb0a1461f452ce0911"
},
"downloads": -1,
"filename": "mpremote-1.24.0.tar.gz",
"has_sig": false,
"md5_digest": "8b3878b507daaa58beeb42ac7915d27b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.4",
"size": 25104,
"upload_time": "2024-10-25T14:48:24",
"upload_time_iso_8601": "2024-10-25T14:48:24.692050Z",
"url": "https://files.pythonhosted.org/packages/cc/fb/4b9f6600a31fa72c9a294f2007dedd9583df25fac0483b4594288163a8ac/mpremote-1.24.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-25 14:48:24",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "micropython",
"github_project": "micropython",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "mpremote"
}
