# CYD Studio documentation

CYD Studio is a small operating system for single-board micro PCs (the ESP32 "CYD", the NodeMCU ESP8266, an ESP32 with an OLED): you write `.py` in the browser, press **Run**, and the project runs on the board. Logs, run modes, a watchdog, per-project web pages and a per-board feature map are all built in. **No C++ builds**: the firmware is compiled by the developer, the user only writes Python.

Every number in these docs was **measured** on the boards, not estimated. If you change something, measure again.

## Where to start

- [Getting started](/en/docs/getting-started/): PC tools, WiFi settings, flash and deploy, first project.
- [Writing projects](/en/docs/writing-projects/): the `cyd` module, the stop contract, don'ts.
- [Run modes and memory](/en/docs/run-modes/): the N / T / S chip, heap vs internal DRAM, measured limits.
- [Boards and firmware](/en/docs/boards/): how the three boards differ, the custom images, adding a board.
- [HTTP API](/en/docs/api/): every endpoint of the on-board panel.
- [Workshop and Store](/en/docs/workshop/): sharing projects, the panel's Store tab, the public search API.
- [Known traps](/en/docs/known-traps/): MISO, the SD slot, mpremote, BOM, CH340.
- A step-by-step tutorial for beginners: [Workshop Notebook](/defter/#en).

## The system at a glance

| Layer | Where | What it does |
|---|---|---|
| Core (`device/`) | Frozen into the firmware (CYD, NodeMCU) or on the filesystem (OLED) | `runtime`, `jobs`, `server`, `store`, `netmgr`, `sysinfo`, `settings`, `logstore` |
| Board layer (`boards/<name>/cyd.py`) | In the firmware | Hardware and the `OZELLIKLER` feature map; projects write `import cyd` |
| Panel (`index.html`) | On the board's filesystem | Single file, no dependencies, TR/EN |
| Projects | `/projects` (`/sd/projects` when an SD card is present) | Your `.py` files |
| PC tools (`tools/`) | On your computer | deploy, flash, boot log, USB bridge, tests |

## Source and license

The code is on [GitHub](https://github.com/tarikgkhsn/CYD-Studio) under the MIT license. Issues and contributions are welcome. This site and the docs are hosted by [Nuvaka](https://nuvaka.com).