ip2k / MatrixOS

Matrix OS is a cross-platform operating system that mainly targets grid keyboard controllers.

Matrix OS

An operating system for human interface devices that is designed to be cross-platform and modular.

Currently, the OS only supports MIDI but more to come in later revisions.

Description

Matrix OS is composited by 4 different layers:

Core Layer

Handles the basics of the chip. Located at core/

Device Layer

Drivers and configurations of the target device. Located at devices/

System Layer

Handles the system and application runtime. Located at os/

Application Layer

Applications that run on Matrix OS. All user interactions are Matrix OS applications. Located at applications/

Supported Devices

Device Name	Type	Chip	Supported	Note	Purchase
Matrix Pro	Grid	ESP32-S3	Yes		203.io
Matrix Founder Edition	Grid	STM32F1	Partially	Not fully stable	203.io

Getting Started

User Interface

TODO

Compile and Upload

Compile and Upload for Matrix Pro:

1. Clone this repo to your local system and run the following while inside the repo directory to clone the library dependencies: git submodule init; git submodule update --recursive
2. Install toolchain for ESP32-S3: Windows or MacOS and Linux
3. Ensure that idf.py --version returns something like ESP-IDF v5.1.1 in the shell session you're going to use for the upcoming build and firmware upload step. If it does not, ensure you've followed Step 4. Set up the environment variables for Windows or MacOS and Linux
4. Set Matrix Pro into bootloader mode (Hold the center FN key while powering up or going though system settings) and the following

make DEVICE=Matrix build uf2-upload

TODO

Make your own Matrix OS applications

TODO

Help

Any advice for common problems or issues, please post it in the GitHub issues.

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Acknowledgments

This project has made possible with the following open source projects:

FreeRTOS - Real Time OS Kernel

TinyUSB - USB Host/Device stack

Printf - Formatted Printing Functions

CB0R - Zero-Footprint CBOR Decoder (Modified by @All-Your-Locks-Are-Belong-To-Us)

Special thanks to LA104 for a lot of inspiration for this OS