Revo 3 SDK v2.x API navigation
This section helps you find APIs by capability domain and understand key constraints. It does not duplicate complete signatures, parameter tables, or data structures.
Complete API contract
For exact signatures, constraints, return values, enums, error semantics, and Python, C++, and C ABI mappings, use the versioned Revo 3 SDK v2.1.0 complete API manual. The versioned manual is the single authoritative source for the SDK 2.1.0 API contract.
This index targets Revo 3 SDK v2.1.2. The versioned manual above is a 2.1.0 snapshot and does not cover the 2.1.2 additions. See the motion guide and maintenance guide for single-command control and slave-ID changes; use the public examples and matching 2.1.2 headers for these additions. bc-revo3-sdk identifies the installable Python wheel distribution, not a public source repository; public source examples are in brainco-revo3-sdk.
Find the right information
| Question | Documentation |
|---|---|
| Choose a capability domain and understand object relationships or key risks | API navigation |
| Look up exact signatures, fields, enums, or language mappings | Complete API manual |
| Complete a connection, motion, touch, or maintenance workflow | Developer guides |
Core objects
| Object | Responsibility |
|---|---|
Manager | Discovery, connection, and shared-resource shutdown |
Hand | Device identity, layouts, firmware information, and capability domains |
DetectedDevice | Port, protocol, slave ID, model, and serial number |
Hand domains
- Motion: target motion, Servo, teaching, replay, waiting, and cancellation.
- State, Touch, and Health: snapshots, subscriptions, layouts, telemetry, and diagnostics.
- Config, Calibration, and Maintenance: settings, limits, calibration, reboot, reset, and firmware update.
Experimental API: ExperimentalCollision
ExperimentalCollision may change or be removed in a later release and is not covered by backward-compatibility guarantees. It does not replace device-level limits, emergency stops, or other safety controls, and must not be the application's only collision safeguard. Validate it on the target device, firmware, load, and operating scenario before use.
Errors and recovery
Handle SdkError together with operation_effect, recovery_requirement, and OperationState. Indeterminate does not mean “not executed”; read the device state before deciding whether a write is safe to retry.
See types, enums, and errors for the type index.
Language differences
| Semantics | Python | C++ | C ABI |
|---|---|---|---|
| Lifecycle | await close() / async context | RAII / close() | Explicit handle release |
| Waiting | Awaitable | Blocking with std::chrono timeout | Synchronous functions or callbacks |
| Naming | Object methods omit revo3_ | Object methods omit revo3_ | Exported symbols use revo3_ |
| Error | SdkError | revo3::SdkError | Error structure and status code |