Where Is It? — Quick Reference Index¶
Common questions and frequently visited pages, all in one place. Use Ctrl+F to search by keyword instead of digging through nine menu levels.
🚀 Getting Started¶
| Situation | Where to go |
|---|---|
| Just getting started — what do I do first? | docs/getting-started/00-claude-code-quickstart.md (AI-guided) or 01 Hardware Setup |
| What is Claude Code? | 00 Claude Code Quickstart |
| I only have a URL — how do I proceed? | Page 00 — "Download ZIP" checklist |
| I'm stuck on environment setup | 02 Software Setup → troubleshooting.md |
| My first build fails | 03 First Build + troubleshooting.md |
| The LED won't turn on | Ex.00 Quick Start README |
🛠️ Writing Code¶
| Situation | Where to go |
|---|---|
| Where do I write my code? | XM_Apps/Control_Task/control_task.c (relative to the unzipped folder) |
| When does my code get called? | docs/architecture/README.md |
| Function signatures / API reference | docs/api-reference/ |
| Button / LED control | api-reference/03-led-btn-control.md + Ex.01–03 |
| External GPIO / ADC | api-reference/04-external-io.md + Ex.04–06 |
| Sending data to PC over USB serial | api-reference/05-usb-connectivity.md + Ex.07–09 |
| Exporting data over USB (real-time) | api-reference/05-usb-connectivity.md + Ex.09 CDC Stream · xm10 tool (your own structs) · PhAI Studio (Total Data) |
| Sending my own struct to the PC with field names, units and types (Rev 2.0 only) | api-reference/10-struct-logging.md + Ex.44 CDC Struct Logging · xm10 tool |
| Saving data to a USB memory stick (Rev 2.0 only) | getting-started/05-usb-memory-log.en.md + api-reference/06-usb-data-logging.md + Ex.10 · Ex.34 |
| Memory regions (PSRAM, Workspace) | api-reference/07-memory-management.md + Ex.19 |
| Date / time (RTC) | api-reference/08-rtc-clock.md |
| KIT H10 exoskeleton control | api-reference/02-h10-control-n-data.md + Ex.11–13 |
| State machine (TSM) | api-reference/01-task-state-machine.md + Ex.03 |
📚 Examples¶
| Situation | Where to go |
|---|---|
| Full index of all 48 examples | examples/README.md |
| Learning paths by difficulty and track | docs/tutorials/README.md |
| 16-week semester schedule | tutorials/README.md — Semester Schedule section |
| An example (Ex.XX) isn't working | See the "⚠️ Common Mistakes" section in examples/XX_*/README.md |
| First 30 minutes for a first-time user | examples/README.md — Getting Started in 30 Minutes |
| Algorithm examples: PD control / impedance / CPG / etc. | examples/14, 15, 20–30 (see examples/README.md for full mapping) |
🔌 Hardware¶
| Situation | Where to go |
|---|---|
| What's on the board? (LEDs / buttons / CAN / USB / UART counts) | docs/hardware/README.md |
| External GPIO pinmap (Rev 1.1) | hardware/external-gpio-rev1.1.md |
| External GPIO pinmap (Rev 2.0) | hardware/external-gpio-rev2.0.md |
| Is my board Rev 1.1 or Rev 2.0? | hardware/README.md — Board Revision Comparison |
| Which board revision do the 48 examples support? | examples/README.md — Board Revision Compatibility (40 work on both; Ex.10, Ex.34, Ex.36 and Ex.40/41/42/43/44 are Rev 2.0-only) |
📥 Firmware Upload¶
| Situation | Where to go |
|---|---|
| Direct upload via ST-Link SWD | docs/getting-started/03-first-build.md |
| PhAI Studio FTP upload (for distribution) | docs/bootloader/README.md |
| What is the bootloader and why do I need it? | bootloader/README.md — WHY section |
| Updating the KIT H10 exoskeleton firmware | docs/kit-h10-firmware/README.md |
| XM10 ↔ KIT H10 version compatibility | kit-h10-firmware/README.md |
🤖 AI / Data / Advanced Topics¶
| Situation | Where to go |
|---|---|
| Training an AI model with exoskeleton data | docs/advanced/ai-data-pipeline.md |
| Running a Tiny NN inference on-board | Ex.16, Ex.36 + advanced/README.md |
| Get data on your PC / save it / export CSV (Python, exe) | getting-started/04-pc-data-tool.en.md |
| Try the tool first, no board needed | python xm10.py demo — first section of 04-pc-data-tool.en.md |
| Check whether frames are being dropped | python xm10.py soak — 04-pc-data-tool.en.md |
| How to use PhAI Studio | studio.onephai.com + the Ex.09 README (Studio shows Total Data (0x20) — use the xm10 tool for your own structs) |
| Finishing my algorithm within 1 ms | Ex.18 Debug Monitor + Ex.19 Memory Aware Design |
| Self-directed learning paths by interest | advanced/README.md — Recommended Self-Study Paths |
❓ Troubleshooting / Debugging¶
| Situation | Where to go |
|---|---|
| Build / clone / Korean-path errors | docs/troubleshooting.md |
| Serial communication / USB not connecting | troubleshooting.md + the relevant example README |
| The USB memory stick isn't recognized / the PC isn't detected while saving (Rev 2.0 only) | getting-started/05-usb-memory-log.en.md + ⚠️ Common Mistakes in Ex.10 and Ex.34 |
| PhAI Studio won't detect the board (CDC) | ⚠️ Common Mistakes in Ex.07–09 + the PhAI simultaneous-access warning in the .c file header |
| Board stuck in an infinite reboot loop | troubleshooting.md |
| What is Body Data? (gaitCycle, etc.) | api-reference/README.md — Body Data Prerequisites |
| Known issues by version | docs/release-notes/ |
📖 Meta¶
| Situation | Where to go |
|---|---|
| Version / changelog | CHANGELOG.md |
| Release attachments / compatibility matrix | docs/release-notes/ |
| License | LICENSE |
| System architecture overview | docs/architecture/README.md |
| Full documentation index for this repo | docs/README.md |
Claude Code Users¶
You don't need to memorize the tables above. Just ask Claude Code naturally:
"How do I stream data to my PC over USB?"
"I'm getting a build error in Ex.14"
"How do I check my board revision?"
"How do I collect data for AI training?"
The example-helper / student-onboard skills will automatically locate and cite the relevant page.