Skip to main content

File System Bridge to facilitate working with files on Micropython devices

Project description

📂 MPBridge Python Version PyPI Version GitHub Workflow Status PyPI - Downloads

A file system bridge to synchronise and manage files on a MicroPython running device

Supported platforms

  • Windows
  • MacOS
  • Linux
  • FreeBSD/BSD

Dependencies

Installation

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

Windows

  • Open cmd.exe as administrator and run pip install -U mpbridge

Linux / MacOS

  • Run sudo pip install -U mpbridge

How to use

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

Bridge Mode

  • 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.
  1. Connect your MicroPython device
  2. Run mpbridge bridge <PORT>

Sync Directory

  • 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.
  1. Connect your MicroPython device
  2. Run mpbridge sync <PORT> <DIR_PATH>

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)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mpbridge-0.2.0.tar.gz (7.5 kB view hashes)

Uploaded Source

Built Distribution

mpbridge-0.2.0-py3-none-any.whl (8.7 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page