XRobot / LibXR
A modular framework for robotics development, device interfaces, and engineering automation. XRobot covers package management, project layout, and code generation, while LibXR provides core semantics, driver abstractions, and XRUSB.
Jump straight into the docs from the task at hand
Package management, project management, code generation, and the day-to-day development flow.
CoreCore SemanticsCallbacks, events, messages, time, memory, and the foundational abstractions.
DriversDrivers & XRUSBPeripheral abstractions, platform implementations, and XRUSB as part of the driver layer.
StartEnvironment & Getting StartedPlatform selection, environment setup, and the first demo.
15bff04dcfd9126940dfdEnter by common task
This section answers not "how the docs are divided", but "what problem you are solving right now".
I am new to LibXR / XRobot
Start with the overall concepts, repository structure, and the smallest working path before deciding which layer to dive into.
02I want to port to a new hardware platform
Start from driver abstractions, platform implementation, and basic peripheral capabilities to understand the board-level foundation first.
03I need to work on device-side interfaces and links
Start from device interfaces, protocol stacks, and transport implementations, then look at communication, identification, and update-related content.
04I want to get the project running quickly
First determine whether this is an XRobot workspace or a plain LibXR project. If you want the Agent to identify the entry path first, use the prompt on the homepage.
Recent Development
This section shows directions that have recently started or are actively moving, so you can quickly see which capabilities are being expanded.
Platform drivers already cover MSPM0, HPM, ESP, CH32, and STM32
The current mainline already contains multiple platform-driver directories. Before diving in, identify which implementation line your repository and target chip actually use.
XRUSB already covers CDC, DAP, DFU, GSUSB, HID, and UAC
Device-side support is no longer a single protocol path. Before entering the XRUSB docs, confirm which device class you actually need.
The debug path is centered on SWD, with the implementation already split into clearer layers
In the current docs and code, the most relevant pieces are SWD, GPIO timing implementations, and the CMSIS-DAP device class. Do not assume there is already a complete JTAG workflow.
First decide what kind of problem you are solving
Most problems fall into these three categories: understanding the mechanisms, connecting hardware, or getting the project running.
When you are figuring out how the system works
Start from callbacks, events, messages, and middleware relationships, and understand the internal runtime first.
When you are wiring hardware and doing platform bring-up
Start from drivers, platform implementation, XRUSB, and debug links to understand how boards, peripherals, and interfaces are brought in.
Project Background & Community
This section holds the project background, how to contribute, and community entry points, so you can understand the project itself before going deeper into the technical material.