This tool is supports microcontrollers to which MicroPython is ported.
### Help
```sh
upy
```
or
```sh
upy --help
```
### Finding the serial port on a board with MicroPython
- Explore a serially connected MicroPython device.
- The MicroPython version and device type are printed.
- Currently supported devices are Digi XBee3(xbee3) and Raspberry Pi Pico 2 W(pico2).
```sh
upy scan
```
```output
COM3 (v1.12-1556-gcc82fa9 on 2021-06-22; XBee3 Zigbee with EFR32MG)
COM4 (v1.25.0-preview.180.g495ce91ca on 2025-01-06; Raspberry Pi Pico 2 W with RP2350)
```
### Option Rules
- Options and values can have spaces or omit spaces.
- Options and values can be inserted with the = character.
```sh
<option><value>
<option> <value>
<option>=<value>
```
### Environment file
- You can omit this option by saving the environment variables required to run the tool in the current path in a .vscode/.upy file.
- By defining SERIAL_PORT and DEVICE_TYPE in this file, you can omit the --sport and --type options to be included in each command.
```sh
SERIAL_PORT=<your_com_port_name>
DEVICE_TYPE=<your_device_type>
```
Example (.upy)
```sh
SERIAL_PORT=com3
DEVICE_TYPE=xbee3
```
### Initialize Microcontroller file system
- If you created a .vscode/.upy file in the current path, omit the --sport and --type options in all subsequent commands.
```sh
upy init
```
or, You can also use the --sport and --type options explicitly.
```sh
upy --sport <your_com_port_name> --type <your_device_type> init
```
### Check list of Microcontroller file systems
- If path is omitted, the output will be the files or directories contained in the top-level directory.
```sh
upy ls [<path>/][remote_directory]
```
### Put PC file or directroy into Microcontroller
- If path or remote name is omitted, a remote name identical to the local name is created in the top-level directory.
```sh
upy put <local_name> [[path][/remote_name]]
```
### Get Microcontroller file to PC
- Getting the current directory is not supported.
```sh
upy get <remote_file_name> <local_file_name>
```
### Delete Microcontroller file or directory
```sh
upy rm [path/]<remote_name>
```
### Executes the PC's MicroPython script by sequentially passing it to the Microcontroller
- Wait for serial input/output until the script finishes
- To force quit in running state, press Ctrl+c
```sh
upy <micropython_script_file>
```
or
```sh
upy run [-i | -n] <micropython_script_file>
```
**Additional Options**
- -i: Display the pressed key in the terminal window (Echo on)
- -n: Does not wait for serial output, so it appears as if the program has terminated on the PC side.
- Script continues to run on Microcontroller
- Used to check data output serially from Microcontroller with other tools (PuTTY, etc.)
Raw data
{
"_id": null,
"home_page": "https://github.com/planxstudio/upyboard",
"name": "upyboard",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "micropython, pyserial, genlib",
"author": "chanmin.park",
"author_email": "devcamp@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/1e/24/f0de96bf7208e0e8eac0c3f3326d4124c14ef3c0d89a1fa27f17177888ab/upyboard-0.7.0.tar.gz",
"platform": null,
"description": "This tool is supports microcontrollers to which MicroPython is ported.\r\n\r\n### Help\r\n```sh\r\nupy\r\n```\r\nor\r\n```sh\r\nupy --help\r\n```\r\n\r\n### Finding the serial port on a board with MicroPython\r\n- Explore a serially connected MicroPython device.\r\n- The MicroPython version and device type are printed.\r\n- Currently supported devices are Digi XBee3(xbee3) and Raspberry Pi Pico 2 W(pico2).\r\n\r\n```sh\r\nupy scan\r\n```\r\n\r\n```output\r\nCOM3 (v1.12-1556-gcc82fa9 on 2021-06-22; XBee3 Zigbee with EFR32MG)\r\nCOM4 (v1.25.0-preview.180.g495ce91ca on 2025-01-06; Raspberry Pi Pico 2 W with RP2350)\r\n```\r\n\r\n### Option Rules\r\n- Options and values can have spaces or omit spaces.\r\n- Options and values can be inserted with the = character.\r\n\r\n```sh\r\n<option><value> \r\n<option> <value>\r\n<option>=<value> \r\n```\r\n\r\n### Environment file\r\n- You can omit this option by saving the environment variables required to run the tool in the current path in a .vscode/.upy file.\r\n- By defining SERIAL_PORT and DEVICE_TYPE in this file, you can omit the --sport and --type options to be included in each command.\r\n\r\n```sh\r\nSERIAL_PORT=<your_com_port_name>\r\nDEVICE_TYPE=<your_device_type>\r\n```\r\n\r\nExample (.upy)\r\n```sh\r\nSERIAL_PORT=com3\r\nDEVICE_TYPE=xbee3\r\n```\r\n\r\n### Initialize Microcontroller file system\r\n- If you created a .vscode/.upy file in the current path, omit the --sport and --type options in all subsequent commands.\r\n```sh\r\nupy init\r\n```\r\nor, You can also use the --sport and --type options explicitly.\r\n```sh\r\nupy --sport <your_com_port_name> --type <your_device_type> init\r\n```\r\n\r\n### Check list of Microcontroller file systems\r\n- If path is omitted, the output will be the files or directories contained in the top-level directory.\r\n\r\n```sh\r\nupy ls [<path>/][remote_directory]\r\n```\r\n\r\n### Put PC file or directroy into Microcontroller\r\n- If path or remote name is omitted, a remote name identical to the local name is created in the top-level directory.\r\n```sh\r\nupy put <local_name> [[path][/remote_name]]\r\n```\r\n\r\n### Get Microcontroller file to PC\r\n- Getting the current directory is not supported.\r\n```sh\r\nupy get <remote_file_name> <local_file_name>\r\n```\r\n\r\n### Delete Microcontroller file or directory\r\n```sh\r\nupy rm [path/]<remote_name>\r\n```\r\n\r\n### Executes the PC's MicroPython script by sequentially passing it to the Microcontroller\r\n- Wait for serial input/output until the script finishes \r\n- To force quit in running state, press Ctrl+c\r\n\r\n```sh\r\nupy <micropython_script_file>\r\n```\r\nor\r\n```sh\r\nupy run [-i | -n] <micropython_script_file>\r\n```\r\n\r\n**Additional Options**\r\n- -i: Display the pressed key in the terminal window (Echo on)\r\n- -n: Does not wait for serial output, so it appears as if the program has terminated on the PC side.\r\n - Script continues to run on Microcontroller\r\n - Used to check data output serially from Microcontroller with other tools (PuTTY, etc.)\r\n",
"bugtrack_url": null,
"license": null,
"summary": "This is a CLI tool for MicroPython-based embedded systems.",
"version": "0.7.0",
"project_urls": {
"Homepage": "https://github.com/planxstudio/upyboard"
},
"split_keywords": [
"micropython",
" pyserial",
" genlib"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "9bc95b2a88ca91eb5162fc39ffc12c5f1bf01b01c11f08c18349d7f291770628",
"md5": "1b8d08433d176e04767006caba38fbfb",
"sha256": "309a391c0173b3375382f77cc19e977e4dbeb21ec06bffeaed27944767aa0235"
},
"downloads": -1,
"filename": "upyboard-0.7.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1b8d08433d176e04767006caba38fbfb",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 92916,
"upload_time": "2025-03-06T01:13:58",
"upload_time_iso_8601": "2025-03-06T01:13:58.528986Z",
"url": "https://files.pythonhosted.org/packages/9b/c9/5b2a88ca91eb5162fc39ffc12c5f1bf01b01c11f08c18349d7f291770628/upyboard-0.7.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "1e24f0de96bf7208e0e8eac0c3f3326d4124c14ef3c0d89a1fa27f17177888ab",
"md5": "97c65296828b602438de0eae58116e4a",
"sha256": "5df0a2ed3f258b31b1f17bb12646846916af387ddf5f48dbc74d8c8f6f7755d8"
},
"downloads": -1,
"filename": "upyboard-0.7.0.tar.gz",
"has_sig": false,
"md5_digest": "97c65296828b602438de0eae58116e4a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 73339,
"upload_time": "2025-03-06T01:14:00",
"upload_time_iso_8601": "2025-03-06T01:14:00.517172Z",
"url": "https://files.pythonhosted.org/packages/1e/24/f0de96bf7208e0e8eac0c3f3326d4124c14ef3c0d89a1fa27f17177888ab/upyboard-0.7.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-03-06 01:14:00",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "planxstudio",
"github_project": "upyboard",
"github_not_found": true,
"lcname": "upyboard"
}
JSON
