MicroFS

A simple command line tool and module for interacting with the limited file system provided by MicroPython on the BBC micro:bit.

Installation

To install simply type:

$ pip install microfs

...and the package will download from PyPI. If you wish to upgrade to the latest version, use the following command:

$ pip install --no-cache --upgrade microfs

Usage

There are two ways to use microfs - as a module in your Python code or as a stand-alone command to use from your shell (ufs).

In Code

In your Python script import the required functions like this:

from microfs import ls, rm, put, get, get_serial

Read the API documentation below to learn how each of the functions works.

Command Line

From the command line (but not the Python shell) use the “ufs” (“u” = micro) command.

To read the built-in help:

$ ufs --help

List the files on the device:

$ ufs ls

Delete a file on the device:

$ ufs rm foo.txt

Copy a file onto the device:

$ ufs put path/to/file.txt

Get a file from the device:

$ ufs get foo.txt

Development

The source code is hosted in GitHub. Please feel free to fork the repository. Assuming you have Git installed you can download the code from the canonical repository with the following command:

$ git clone https://github.com/ntoll/microfs.git

Ensure you have the correct dependencies for development installed by creating a virtualenv and running:

$ pip install -r requirements.txt

To locally install your development version of the module into a virtualenv, run the following command:

$ python setup.py develop

There is a Makefile that helps with most of the common workflows associated with development. Typing “make” on its own will list the options thus:

$make

There is no default Makefile target right now. Try:

make clean - reset the project and remove auto-generated assets.
make pyflakes - run the PyFlakes code checker.
make pep8 - run the PEP8 style checker.
make test - run the test suite.
make coverage - view a report on test coverage.
make check - run all the checkers and tests.
make package - create a deployable package for the project.
make publish - publish the project to PyPI.
make docs - run sphinx to create project documentation.

Contributing to MicroFS

Hey! Many thanks for wanting to improve MicroFS.

Contributions are welcome without prejudice from anyone irrespective of age, gender, religion, race or sexuality. If you’re thinking, “but they don’t mean me”, then we especially mean YOU. Good quality code and engagement with respect, humour and intelligence wins every time.

  • If you’re from a background which isn’t well-represented in most geeky groups, get involved - we want to help you make a difference.
  • If you’re from a background which is well-represented in most geeky groups, get involved - we want your help making a difference.
  • If you’re worried about not being technical enough, get involved - your fresh perspective will be invaluable.
  • If you think you’re an imposter, get involved.
  • If your day job isn’t code, get involved.
  • This isn’t a group of experts, just people. Get involved!
  • We are interested in educational, social and technical problems. If you are too, get involved.
  • This is a new community. No-one knows what they are doing, so, get involved.

We expect contributors to follow the Python Software Foundation’s Code of Conduct: https://www.python.org/psf/codeofconduct/

Feedback may be given for contributions and, where necessary, changes will be politely requested and discussed with the originating author. Respectful yet robust argument is most welcome.

Finally, contributions are subject to the following caveat: the contribution was created by the contributor who, by submitting the contribution, is confirming that they have the authority to submit the contribution and place it under the license as defined in the LICENSE file found within this repository.

Checklist

  • Your code should be commented in plain English (British spelling).
  • If your contribution is for a major block of work and you’ve not done so already, add yourself to the AUTHORS file following the convention found therein.
  • You MUST include tests. We have 100% test coverage.
  • Have fun!

API

This module contains functions for running remote commands on the BBC micro:bit relating to file system based operations.

You may:

  • ls - list files on the device. Based on the equivalent Unix command.
  • rm - remove a named file on the device. Based on the Unix command.
  • put - copy a named local file onto the device a la equivalent FTP command.
  • get - copy a named file from the device to the local file system a la FTP.
microfs.ls(serial=None)[source]

List the files on the micro:bit.

If no serial object is supplied, microfs will attempt to detect the connection itself.

Returns a list of the files on the connected device or raises an IOError if there’s a problem.

microfs.rm(filename, serial=None)[source]

Removes a referenced file on the micro:bit.

If no serial object is supplied, microfs will attempt to detect the connection itself.

Returns True for success or raises an IOError if there’s a problem.

microfs.put(filename, serial=None)[source]

Puts a referenced file on the LOCAL file system onto the file system on the BBC micro:bit.

If no serial object is supplied, microfs will attempt to detect the connection itself.

Returns True for success or raises an IOError if there’s a problem.

microfs.get(filename, target=None, serial=None)[source]

Gets a referenced file on the device’s file system and copies it to the target (or current working directory if unspecified).

If no serial object is supplied, microfs will attempt to detect the connection itself.

Returns True for success or raises an IOError if there’s a problem.

microfs.get_serial()[source]

Detect if a micro:bit is connected and return a serial object to talk to it.

Release History

1.2.0

  • API CHANGE the serial object passed into command functions is optional.
  • API CHANGE call signature changes on command functions.

1.1.2

  • Allow external modules to use built-in device detection and connection.

1.1.1

  • Unlink command logic from device detection and serial connection.

1.1.0

  • Fix broken ‘put’ and ‘get’ commands to work with arbitrary file sizes.
  • Fix error when working with binary data.
  • Update execute function to work with lists of multiple commands.
  • Minor refactor to extract raw mode related code.
  • Updated tests to keep coverage at 100% on both Python 2 and Python 3.

1.0.2

  • Remove spare print call.

1.0.1

  • Fix broken setup.

1.0.0

  • Full implementation of all the expected features.
  • 100% test coverage.
  • Comprehensive documentation.

0.0.1

  • Initial release. Basic functionality.

Copyright (c) 2016 Nicholas H.Tollervey

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.