Installation

Prerequisite

To communicate with microcontrollers via USB, you may need to install additional Silicon Labs CP210x VCP drivers on your system for macOS and Windows. Linux typically does not require VCP drivers, as they are built into the kernel.

As this software is built on Python, please ensure you have Python >= 3.12.x installed.

macOS

Only Python and VCP drivers are required.

Linux

In Linux systems you need to execute the following commands (e.q. as root):

# update system
$ apt update && apt upgrade -y

# install required Python modules
$ apt install -y python3-pip python3-venv python3-tk

# enable dialout permissions
$ usermod -aG dialout <USER>

# verify user group (optional)
$ groups <USER>

Windows

If you use Python virtualenv, you might face issues to start the virtualenv. To temporarily allow the script execution, you can run as user following command:

# Allows all scripts to run, including unsigned or downloaded ones (temporary)
> Set-ExecutionPolicy -Scope Process -ExecutionPolicy RemoteSigned

Very unsecure, but with Administrator rights, you can allow script execution all the time with the following command:

# Allows all scripts to run, including unsigned or downloaded ones (unsecure)
> Set-ExecutionPolicy Unrestricted -Force

Clone repository

If you don't want to use git, you can also download the software as a ZIP file to your system!

# clone repository
$ git clone https://github.com/Lupin3000/MicroPython-Firmware-Studio.git

# change into cloned root directory
$ cd MicroPython-Firmware-Studio/

Create and use Python virtualenv

# create Python virtualenv (optional but recommended)
$ python3 -m venv .venv

# activate Python virtualenv (macOS & Linux)
$ source venv/bin/activate

# activate Python virtualenv (Windows)
$ .\.venv\Scripts\activate

Install Python dependencies

# update pip (optional)
(.venv) $ pip3 install -U pip

# install required dependencies
(.venv) $ pip3 install -r requirements.txt

# show packages (optional)
(.venv) $ pip3 freeze