Getting Started with EmbeddedOS v0.1.0

Choose the path that fits what you have and what you want to do. Each path takes about 10 minutes!

🎯 Choose Your Path

No HardwareSimulator only
Raspberry PiRPi 4 or 5
STM32 BoardDiscovery/Nucleo
I Want AppsBuild eApps
I Want to DesignEoStudio

🎮 No Hardware? No Problem!

EoSim lets you simulate any board on your computer. No soldering, no wires — just code and run!

Prerequisites

Python 3.10+ and pip installed on your computer.

Install EoSim

pip install embeddedos-eosim
eosim --version
# EoSim v0.1.0

List Available Platforms

eosim list
# stm32f4    ARM Cortex-M4 (168 MHz, 1MB Flash, 192KB RAM)
# esp32      Xtensa LX6 (240 MHz, Wi-Fi, BLE)
# raspi4     ARM Cortex-A72 (1.5 GHz, 8GB RAM)
# ... 52 platforms total

Run Your First Simulation

eosim run --platform stm32f4 --gui
# [EoSim] Loading platform: stm32f4
# [EoSim] CPU: Cortex-M4 @ 168 MHz
# [EoSim] GUI launched on :8080

Try a Firmware Image

# Install ebuild to create a project
pip install embeddedos-ebuild
ebuild init my-blink --template rtos --target stm32f4
cd my-blink && ebuild build
eosim run build/firmware.elf --platform stm32f4 --gui

Explore the Dashboard

Open http://localhost:8080 in your browser to see GPIO pins, UART output, memory, and CPU registers all simulated in real time!

What's Next?

Try different platforms: eosim run --platform esp32 --gui or --platform raspi4. See the EoSim docs for all 52 platforms, or browse the App Store.

🍓 I Have a Raspberry Pi

Get EmbeddedOS running on your Pi in 5 steps. You'll blink an LED and see UART output.

You'll Need

Raspberry Pi 4 or 5, microSD card, USB-C power supply, keyboard/mouse, monitor. See full shopping list.

Set Up Your Pi

Flash Raspberry Pi OS (64-bit) using Raspberry Pi Imager. Boot and open a terminal.

Install Build Tools

sudo apt update && sudo apt install -y cmake ninja-build gcc g++ git python3-pip
pip install embeddedos-ebuild embeddedos-eosim

Create a Blink Project

ebuild init my-blink --template rtos --target raspi4
cd my-blink

Build and Run

ebuild build
ebuild run
# [app] EmbeddedOS v0.1.0 starting...
# [app] LED toggled, tick=500

Monitor Output

ebuild monitor --baud 115200
# [app] LED toggled, tick=1000
# [app] LED toggled, tick=1500
Next Steps

Try the full hardware lab guide or add AI features to your project.

⚙️ I Have an STM32 Board

Flash EmbeddedOS onto your STM32 in 5 steps using the built-in ST-Link debugger.

You'll Need

STM32F4 Discovery ($20) or Nucleo board, USB cable. See full shopping list.

Install ARM Toolchain

# Ubuntu: sudo apt install gcc-arm-none-eabi
# macOS: brew install arm-none-eabi-gcc
# Windows: download from developer.arm.com
arm-none-eabi-gcc --version

Install ebuild + Flash Tools

pip install embeddedos-ebuild
sudo apt install openocd stlink-tools

Create and Build

ebuild init my-blink --template rtos --target stm32f4
cd my-blink
ebuild build --jobs 8

Flash

ebuild flash --verify
# [ebuild] Writing firmware.bin (45,232 bytes)... OK
# [ebuild] Flash complete. Resetting device.

Monitor

ebuild monitor --baud 115200
# [app] EmbeddedOS v0.1.0 starting...
# [app] LED toggled, tick=500
Next Steps

See the full STM32 lab guide with GDB debugging, or try ESP32 ($5!).

📱 I Want to Build Apps

Build and run eApps — 38 cross-platform C + LVGL apps including Snake, Calculator, and more.

Prerequisites

Git, CMake 3.20+, C compiler (gcc/clang/MSVC), SDL2 development libraries.

Install SDL2

# Ubuntu: sudo apt install libsdl2-dev
# macOS: brew install sdl2
# Windows: download from libsdl.org

Clone eApps

git clone https://github.com/embeddedos-org/eApps.git
cd eApps

Build for Desktop

cmake -B build -DEAPPS_PORT=sdl2
cmake --build build --parallel

Run Snake!

./build/apps/snake/snake
# A window opens with the Snake game!
# Use arrow keys to play

Try More Apps

./build/apps/ecalc/ecalc    # Calculator
./build/apps/enote/enote    # Text editor
./build/eapps_suite          # All 38 apps
Next Steps

See all 38 apps with CLI vs GUI comparison. Build for Web (Emscripten) or EoS (embedded).

🎨 I Want to Design

EoStudio is an all-in-one design tool with AI tutoring. Create 3D models, games, UIs, and more.

Prerequisites

Python 3.10+, 4GB RAM, OpenGL 3.3+.

Install EoStudio

pip install eostudio
eostudio --version
# EoStudio v0.1.0

Launch

eostudio
# The main window opens with all 10 editors

Create a 3D Model with AI Help

Open the 3D Modeler and click "AI Tutor". Ask: "Help me create a simple robot". The AI guides you step-by-step!

Design a Game

Switch to Game Editor. Create sprites, add physics, and build a playable game — no coding required.

Generate Code

Design a UI in the UI Designer, then click "Export → Flutter" or "Export → React" to get production-ready code!

Next Steps

Explore the EoStudio Learning Hub with 4 learning paths and 50+ project templates.

📚 Full Documentation