KryonOS

KryonOS is an open-source, lightweight, high-performance GUI Operating System and JavaScript App Runtime designed specifically for the ESP32 microcontroller. It provides a complete desktop-like experience on embedded devices, featuring an integrated JS engine (Duktape) for executing standalone JavaScript applications, double-buffered graphics for smooth 2D/3D rendering, an App Store, file management, and direct hardware API access.

ESP32 + ILI9341 2.8" (Touch)	Multiple Devices (Lab Overview)	M5Stack Cardputer	CYD (Cheap Yellow Display)	LilyGO T-HMI
Stable 🟢	Experimental 🧪	Experimental 🧪	Experimental 🧪	Experimental 🧪

• JavaScript App Runtime: Execute interactive JS apps natively on the ESP32 using the optimized Duktape engine.
• Rich UI & Graphics: Built-in graphics library with double-buffering support for smooth, tear-free 2D and 3D rendering.
• App Store & Installer: Browse, download, and install JavaScript apps and updates dynamically over Wi-Fi.
• File Management: Fully functional file explorer and text editor utilizing the SD Card for storage.
• Hardware API: Easy-to-use JavaScript APIs for controlling GPIO, reading touch input, accessing the SD card, and reading sensors.
• Multitasking Feel: Launch, suspend, and switch between utility apps, games, and hardware monitors.

Want your board supported in KryonOS? Request board support here.

• ESP32 Development Boards (Supported: ESP32 WROOM-32, ESP32-S2, ESP32-S3, ESP32-C3)
• ILI9341 2.8" TFT Display (SPI interface with XPT2046 Touch Controller)
• MicroSD Card Module (SPI interface)
• Breadboard & Jumper Wires

KryonOS requires an ILI9341 2.8 Inch Touch display with and an SD card module. To achieve the best performance and avoid bus collisions, KryonOS uses split SPI buses.

• VSPI: Used exclusively for the TFT Display and Touch controller.
• HSPI: Used exclusively for the SD Card Module.

If your specific hardware setup uses different pins, you will need to recompile the OS:

1. To change Display/Touch pins: Open platformio.ini and modify the build_flags (e.g., -D TFT_MOSI=23).
2. To change SD Card pins: Open src/FileSystem/FileSystem.cpp and modify the sdSPI.begin() and SD.begin() lines.

You can download the latest precompiled firmware .bin files directly from our Releases Page.

Use an ESP32 flasher tool (like esptool.py or the official ESP Flash Download Tool) to write the binaries to the correct sectors:

esptool.py --chip esp32 --port COM3 --baud 921600 write_flash -z \
  0x1000 bootloader.bin \
  0x8000 partitions.bin \
  0x10000 firmware.bin

To build and flash the firmware from source using PlatformIO:

1. Download the repository as a ZIP or clone it via git.
2. Open the project folder in your terminal or IDE (like VS Code).
3. Build and upload using the PlatformIO command:

pio run -t upload

• App Development Guide - Learn how to build and structure JavaScript applications for KryonOS.
• JavaScript API Guide - Learn how to access system hardware using KryonOS's JS API.
• KryonOS Wiki - Official wiki for detailed guides, tutorials, and system architecture.
• Discussions - Join the community, ask questions, and share your ideas.

• Expanded Board Support: Future updates will bring support for a wider variety of microcontrollers and ESP32 variants.
• More Hardware APIs: Continuous expansion of the JavaScript API to expose more low-level hardware features (e.g., Bluetooth, I2C, SPI sensors, advanced PWM, and deep sleep).

Help the KryonOS team purchase new development boards and hardware for testing, development, and expanding support for more devices.

KryonOS is licensed under the GNU General Public License v3.0.