Skip to content

API Reference

Use this section when you need table-oriented lookup for public Librux API surfaces.

The Develop API pages explain which API to use and how the flow works. The Reference API pages list the public surface in a denser form.

Reference Scope
Subsystem SDK Reference Python and C++ subsystem-author classes, lifecycle hooks, method groups, and resource helpers
Host Control REST Routes HTTP routes exposed by the control backend
Host Control WebSocket Messages WebSocket endpoints, client message kinds, server responses, and common fields
WebSocket Facade Browser-facing Event observation and Procedure/Operation control boundary
Data Types And Binary Encoding Binary message encoding and typed payload rules

Language-neutral semantic contracts are separate from runtime API methods.

Spec reference Scope
Message Index msg.* message namespaces and message types
API Contract Reference api.* endpoint contracts
Capabilities capability.* app-facing robot capability contracts
Components component contract bundles
Domain Coverage domain-level coverage map

Source Of Truth

The Reference API pages are derived from these implementation surfaces.

Surface Source
REST routes runtime/control/backend/src/http.rs
WebSocket message handling runtime/control/backend/src/ws.rs and control backend state handlers
Python subsystem SDK sdk/python/librux/wrapper/subsystem.py and sdk/python/librux/core/resource.py
C++ subsystem SDK sdk/cpp/include/librux/wrapper/subsystem.hpp, sdk/cpp/include/librux/wrapper/core_client.hpp, and sdk/cpp/include/librux/core/client.hpp

When this reference and source differ, treat the source as authoritative and update the reference before release.