Instantly share code, notes, and snippets.

# hardye/mpfshell-windows.md Last active Jun 27, 2018

Installing and using mpfshell on Windows 10

# Installation and usage of the mpfshell utility on Windows

mpfshell is a command line tool for managing files on ESP8266-based microcontrollers. The project's README file contains installation and usage instructions but these don't necessarily work on Windows.

The following steps show you how to make mpfshell work on Windows 10:

1. Determine the COM port of your device in Windows Device Manager (COM3 in this example).

2. Install Python 3 from the Python website. Important: the first page of the installation wizard has a checkbox that allows you to add Python to the system's PATH. Make sure you select this checkbox.

3. Install mpfshell dependencies using pip, Python's package manager:

 pip3 install pyserial
pip3 install colorama
pip3 install websocket_client

4. Clone the mpfshell repository to a directory on your hard drive:

 git clone https://github.com/wendlers/mpfshell.git
cd mpfshell

5. Install mpfshell:

 python3 setup.py install


After you completed the steps above you will likely notice that calling mpfshell from a command prompt or from Powershell will yield an error. On Windows (10) it is required to directly run the mpfshell.py module using its full path. Thus:

1. Using Windows Explorer find the installation location of mfpshell.py.

2. From the command prompt always invoke mpfshell as follows:

 python3 <full\path\to\>mpfshell.py


From there, everything should be working as described in the mpfshell README.

When inside mpfshell, remember to use the COM-port for your device when connecting: use open COM3 instead of open /dev/ttyUSBx.

Tip: to make things easier, you can alias mpfshell to the above command in your shell.