How kodediy/kode-sim works
kode-sim builds kodeOS or a kode-sdk app, runs the unchanged firmware in esp-emu, and presents a simulated Kode Dot through a browser window. Its runtime combines Rust-modeled board chips with kemu firmware stand-ins for capabilities esp-emu lacks, including the display, microSD, network, USB, and console. Separate commands support building, installing apps into running kodeOS, and headless scenario reviews. The documented workflow and sampled imports support the main command and bridge links; some unsampled subsystem wiring is shown only where the README states it.
Main entry points: bridge.rs Device bridge · run.rs Simulator run · main.rs Command router · kemu_link.h Firmware link
Components 23
Commands and workflows
- Command router
crates/kode-sim/src/main.rs - Project build
crates/kode-sim/src/build.rs - App installation
crates/kode-sim/src/install.rs - Scenario review
crates/kode-sim/src/review.rs - Simulator run
crates/kode-sim/src/run.rs
Emulation runtime
- ESP emulator
crates/kode-sim/src/emu.rs - Device bridge
crates/kode-sim/src/bridge.rs - Co-simulation client
crates/cosim/src/client.rs - Kemu protocol
crates/kode-sim/src/proto.rs - Console serial
crates/kode-sim/src/serial.rs
Device models
- Board chip models
crates/kode-sim/src/chips.rs - I2C chip behavior
crates/kodedot-chips/src/board.rs - Audio I/O
crates/kode-sim/src/audio.rs - USB host computer
crates/kode-sim/src/usbhost.rs - Card image
crates/kode-sim/src/sdcard.rs
Firmware stand-ins
- Firmware link
firmware/kemu/include/kemu_link.h - Display stand-in
firmware/kemu/src/kemu_panel.c - MicroSD stand-in
firmware/kemu/src/kemu_sd.c - USB device model
firmware/kemu/models/usbdcd.c
User interface
- Web server
crates/kode-sim/src/web.rs - Simulator window
crates/kode-sim/src/window.rs - Device controls
web/sim.js
Other components
- Developer
Connections 32
- Developer → Command router: runs commands
crates/kode-sim/src/main.rs - Command router → Project build: dispatches build
crates/kode-sim/src/main.rs - Command router → App installation: dispatches install
crates/kode-sim/src/main.rs - Command router → Scenario review: dispatches review
crates/kode-sim/src/main.rs - Command router → Simulator run: dispatches run
crates/kode-sim/src/main.rs - Simulator run → Project build: builds project
crates/kode-sim/src/run.rs - Simulator run → ESP emulator: boots firmware
crates/kode-sim/src/run.rs - Simulator run → Device bridge: starts device bridge
crates/kode-sim/src/run.rs - Simulator run → Web server: serves device page
crates/kode-sim/src/run.rs - Simulator run → Simulator window: opens window
crates/kode-sim/src/run.rs - App installation → Project build: builds app
README.md - App installation → Device bridge: installs in running OS
crates/kode-sim/src/install.rs - Scenario review → Project build: can build project
README.md - Scenario review → Device bridge: runs headless scenario
crates/kode-sim/src/review.rs - ESP emulator → Co-simulation client: connects chip bus
README.md - ESP emulator → Board chip models: answers virtual parts
crates/kode-sim/src/emu.rs - Board chip models → I2C chip behavior: models board chips
README.md - Device bridge → ESP emulator: starts and controls
crates/kode-sim/src/bridge.rs - Device bridge → Kemu protocol: decodes device frames
crates/kode-sim/src/bridge.rs - Device bridge → Console serial: reads console
crates/kode-sim/src/bridge.rs - Device bridge → USB host computer: starts USB host
crates/kode-sim/src/bridge.rs - Device bridge → Card image: reads card sectors
crates/kode-sim/src/bridge.rs - Device bridge → Audio I/O: handles sound
- Firmware link → Kemu protocol: shares frame format
firmware/kemu/include/kemu_link.h - Firmware link → Display stand-in: carries display frames
firmware/kemu/src/kemu_panel.c - Firmware link → MicroSD stand-in: carries card requests
firmware/kemu/src/kemu_sd.c - Firmware link → USB device model: carries USB traffic
- Web server → Device bridge: routes page messages
crates/kode-sim/src/web.rs - Simulator window → Web server: opens served page
README.md - Device controls → Web server: sends controls
- USB host computer → USB device model: talks to device
crates/kode-sim/src/usbhost.rs - MicroSD stand-in → Card image: uses card image