Getting Started
Quickstart & Flashing
Step-by-step guide to installing and flashing KryonOS on your ESP32 board.
Get started with KryonOS by flashing the pre-built firmware binary bundle or compiling directly from source using Arduino IDE or PlatformIO.
Hardware Requirements
Before flashing, ensure you have:
- Target Board: Standard ESP32 Dev Module, ESP32-S3, CYD (ESP32-2432S028R), or M5Stack Cardputer.
- Display: 2.8" ILI9341 SPI TFT (240x320) with XPT2046 resistive touch controller (if using standard DevKit).
- USB Cable: High-quality USB-C or Micro-USB data cable (verify it provides data sync, not power-only).
- Operating System: Linux, macOS, or Windows 10/11 with CP210x or CH340 USB-UART drivers installed.
Binary Memory Layout
When flashing pre-compiled firmware binaries via esptool.py or the Web Flasher, the flash memory is organized as follows:
| Offset Address | Binary File | Description |
|---|---|---|
0x1000 | bootloader.bin | 2nd-stage ESP32 Bootloader |
0x8000 | partitions.bin | Huge APP Partition Table (3MB App / 1MB SPIFFS) |
0xe000 | boot_app0.bin | OTA Data Initialization Slot |
0x10000 | kryonos_firmware.bin | KryonOS Core Firmware & Duktape Runtime |
0x310000 | spiffs.bin | Default User Scripts & System UI Assets |
Flashing Instructions
Initial Wi-Fi & Cloud Pairing
Once flashing finishes and the device reboots:
- Boot Splash: The screen displays the KryonOS logo, RAM allocation, and Duktape engine version.
- Access Point Mode: If no Wi-Fi credentials are saved in NVS, the board creates an open AP:
KryonOS-Setup-XXXX. - Captive Portal: Connect from your smartphone or laptop, open
http://192.168.4.1, and select your Wi-Fi SSID. - Pairing Code: The display renders an 8-character pairing code (e.g.
7K4P-92QX). - Dashboard Registration: Go to Devices Dashboard on the web, click Pair Device, and input your code.