Skip to main content
Version: Matrix OS 4.0 🚧

Building on Windows

Install Git​

Git is an essential tool for version control in development. If you haven’t installed it yet, follow these steps:

  1. Check if Git is installed by running

    git --version

    in your terminal.

  2. If Git isn’t installed, follow the official installation guide to set it up for your system.

Install Make​

Make is crucial for building projects, especially when working with embedded systems. Matrix OS uses Make on top of the chip vendor-provided build system to achieve cross-platform compatibility.

  1. Install Chocolatey, which will be used to get the latest version of Make.

  2. Restart your terminal to ensure Chocolatey is ready to use.

  3. Install Make:

    choco install make

  4. Restart your terminal to make sure Make is ready to use.

  5. Confirm the installation by typing:

    make --version

    This command should output the version of Make, confirming it is installed correctly.

Clone Matrix OS Repository​

This step downloads the Matrix OS source tree and prepares its submodules.

  1. Open your Command Prompt or preferred terminal.

  2. Clone the Matrix OS repository with the following command:

    git clone https://github.com/203-Systems/MatrixOS.git

  3. Navigate to the cloned repository:

    cd MatrixOS

  4. Initialize Matrix OS repository:

    git submodule update --init

Install ESP-IDF​

ESP-IDF (Espressif IoT Development Framework) is the vendor-provided toolchain and SDK for the ESP32-S3 SoC used in Mystrix.

  1. Install ESP-IDF 5.3.x by downloading the online installer. The examples below assume v5.3.1.
  2. Include ESP32-S3 tools if the installer asks which target tools to install.
  3. Go to the installer folder and run install.bat to finish the installation. If you didn't change the default install path, it should be at C:\espressif\v5.3.1\install.bat.

Build Matrix OS​

Now that you have completed all the requirements, it's time to build Matrix OS!

Matrix OS 4.0 device targets

Use DEVICE=Mystrix for Mystrix 1 family devices. Use DEVICE=Mystrix2 for Mystrix 2 family devices.

  1. Load ESP-IDF in the current terminal session. You can use the installed ESP-IDF V5.3 CMD shortcut or run C:\espressif\v5.3.1\export.bat in a terminal.

For repeated development, configure your editor terminal or workspace to run the ESP-IDF export script before Matrix OS build commands.

  1. Go to the root folder of Matrix OS if your terminal isn't there already.

  2. Run this command to build Matrix OS:

make DEVICE=Mystrix build

For Mystrix 2:

make DEVICE=Mystrix2 build
  1. Upload MatrixOS to your Mystrix. Make sure your Mystrix is in upload mode.

Run this command to install psutil python package. You only have to do this once:

pip install psutil

Run this command to upload your compiled Matrix OS to your Mystrix:

make DEVICE=Mystrix uf2-upload

For Mystrix 2:

make DEVICE=Mystrix2 uf2-upload
  1. Your Mystrix should start flashing and automatically enter the newly compiled Matrix OS.

For target examples and command chains, see Build Matrix OS. Use build-dev when you need logs; see Debug Your Application (C++).

Comments