Getting Started with RFrame

This is the entry point for RFrame user documentation. New users should read the getting-started sequence; when integrating a specific application, refer directly to the corresponding interface list.

1. Getting-started sequence

Read in order:

1. RFrame Build Guide: deb installation layout (/usr/local/lib), CMake integration with find_package(r-frame), component/target selection, Python wheels, and environment variables.
2. RFrame Development Guide: AppCore lifecycle, application logging (C++/Python), Channel API, HybridChannel / HybridRpcChannel usage, JSON configuration loading, programmatic configuration, and common questions.
3. RFrame Deployment Guide: package installation, plugin catalog, and global runtime configuration.
4. RFrame CLI User Guide: the rframe CLI (bag / topic / service / discovery) for observation, debugging, recording, and playback.

2. Application interfaces

Each interface includes a directly loadable channels JSON configuration. Copy it as provided; no manual format conversion is needed.

Reference	Contents	Channels
Navigation Interfaces	Navigation topic / service channel configuration	8
State Information Interfaces	State machine, battery status, and fault diagnosis topic / service configuration	4
Sensor Camera Topics	Sensor camera image topic channel configuration	10
Motion and Chassis Interfaces	Motion and chassis topic / service configuration	19

For loading configurations from JSON files, global configuration, or multiple channels in a batch, see §7 of the RFrame Development Guide.

3. Example source code

The channel and logging examples referenced in the guides are delivered as a deb package:

sudo apt install robby-r-frame-example

After installation, examples are located at /opt/robby/RFrameExample/ (src/channel, src/log, python/, and config/). Each module can be built independently; see the RFrame Build Guide.