mpbridge

KO | EN

gitlite — search

#hacktoberfest #react #typescript #llm #golang #deep-learning #java #windows #cli #vue #awesome-list #ios #mcp #openai

(★ 54)

CLI tool to synchronise and manage files on MicroPython running devices

mpbridge 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# 📂 MPBridge ![Python Version](https://img.shields.io/badge/Python-3.8%20or%20later-blue?style=flat-square) ![PyPI Version](https://img.shields.io/pypi/v/mpbridge?label=PyPI%20Version&style=flat-square) ![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/AmirHmZz/mpbridge/python-publish.yml?label=Builds&style=flat-square)

CLI tool to synchronise and manage files on a [MicroPython](https://github.com/micropython/micropython)
running device.

## 📥 Installation

`mpbridge` must be installed with `sudo` or `administrator` level of permission in order to be accessible from terminal:

* **Windows :** Open `cmd.exe` or `powershell.exe` as administrator and run `pip install -U mpbridge`.
* **Linux / MacOS :** Run `sudo pip install -U mpbridge`.

## 🔎 How to use

You can use `mpbridge` in several ways based on your needs:

#### ⚜️ Bridge Mode

* Run `mpbridge bridge [PORT]`.
* This mode copies all files and folders from your `MicroPython` board into a temporary directory on your local device
  and listens for any filesystem events on local directory to apply them on your board. It keeps raw repl open, so you
  cannot use serial port in other applications simultaneously.

#### ⚜️ Sync Directory

![](https://raw.githubusercontent.com/AmirHmZz/mpbridge/main/flowchart_sync.svg)

![](https://raw.githubusercontent.com/AmirHmZz/mpbridge/main/flowchart_sync_files.svg)

* Run `mpbridge sync [PORT] [DIR_PARH]`.
* This command syncs a specified local directory with a `MicroPython` board. The sync process will push
  all modified files and folders into board and also pull changes from board and exits.
* If a conflict occurs, `mpbridge` will choose the **local version** of file automatically and
  overwrites it on connected board.
* You can speed up syncing with `--use-hashtable` which allows mpbridge to cache calculated hashes
  on remote device. By using hashtable you won't be able to track files which are modified by remote
  device because hash is calculated at uploading stage.

#### ⚜️ Development Mode

![](https://raw.githubusercontent.com/AmirHmZz/mpbridge/main/flowchart_dev.svg)

* Run `mpbridge dev [PORT] [DIR_PARH]`.
* This mode repeats a loop of tasks in specified directory on `MicroPython` device as below:
    * _Sync_ → _Prompt to enter REPL_ → _Clean Sync_ → _Start MicroPython REPL_
* You can also disable prompt with `--no-prompt` option to speed things:
    * _Clean Sync_ → _Start MicroPython REPL_
* This mode is useful when you keep switching between different tools to flash and run new codes repeatedly.
  You can specify your project directory as `DIR_PATH` and `mpbridge` will take care of changes when you are developing
  your project in your desired IDE. You can switch to `MicroPython REPL` anytime you wish to run the updated code on
  your board.
* Default to current path of terminal if not set the `DIR_PATH`.
* Automatic reset before entering MicroPython REPL can be enabled with `--auto-reset` option which can be set to
  `soft` (soft reset) or `hard` (hard reset).
* You can also boost sync speed with `--use-hashtable` But you won't be able to track files which are modified 
  by remote device itself. Use this option if only host is modifying files.
* In order to compile source files before uploading to remote device, you should set `mpy-cross` executable path using 
`--mpy-cross-path` flag. Visit [Micropython](https://github.com/micropython/micropython/tree/master/mpy-cross) 
repository to build `mpy-cross` compiler for your platform.

#### ⚜️ Delete all files

* Run `mpbridge clear [PORT]`.
* This command deletes all files and directories from `MicroPython` board and exits.

#### ⚜️ List all connected devices

* Run `mpbridge list`.
* This command lists all connected devices.

**Note** : `[PORT]` can be the **full port path** or one of the **short forms** below :

* `c[n]` for `COM[n]` (`c3` is equal to `COM3`).
* `u[n]` for `/dev/ttyUSB[n]` (`u3` is equal to `/dev/ttyUSB3`).
* `a[n]` for `/dev/ttyACM[n]` (`a3` is equal to `/dev/ttyACM3`).

## 👀 Ignore files

You can inform `mpbridge` to ignore syncing specific files or directories. This is useful when you don't want to sync
some directories like `.git/` or `venv/` with your board. To use this feature create a file named `mpbridge.ignore` in
your project directory and specify list of files and directories:

```
.git/
venv/
tests/test_1.py
tests/test_2.py
```

* `mpbridge.ignore` syntax is not as same as `.gitignore` files.
* At this time `mpbridge.ignore` only supports specifying file and directory paths directly.
* You should add a **slash** at the end of directory names: `dir1/`.
* Performing `sync` with `--dry-run` flag can be helpful for debugging your ignore files.

## ✅ Supported platforms

- Windows
- MacOS
- Linux
- FreeBSD/BSD

## 📦 Dependencies

- Python 3.8 or above.
- [mpremote](https://pypi.org/project/mpremote/) >= 0.4.0
- [watchdog](https://pypi.org/project/watchdog/) >= 2.2.0
- [click](https://pypi.org/project/click/) >= 7.0
- [colorama](https://pypi.org/project/colorama/) >= 4.0

mpbridge

mpbridge 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

mpbridge

mpbridge 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README