Doly C++ SDK v1.00
Loading...
Searching...
No Matches
ArmControl

Doly arm motion control SDK (C++). More...

Files

file  ArmControl.h
 Public API for Doly arm motion control.
file  ArmEvent.h
 Event dispatcher API for the Doly ArmControl subsystem.
file  ArmEventListener.h
 Public event types and listener interface for Doly ArmControl.

Classes

class  ArmEventListener
 Interface for receiving arm events. More...

Enumerations

enum class  ArmErrorType : uint8_t { ArmErrorType::ABORT , ArmErrorType::MOTOR }
 Error categories reported by the arm subsystem. More...
enum class  ArmSide : uint8_t { ArmSide::BOTH , ArmSide::LEFT , ArmSide::RIGHT }
 Which arm side an operation or event relates to. More...
enum class  ArmState : uint8_t { ArmState::RUNNING , ArmState::COMPLETED , ArmState::ERROR }
 High-level state of an arm operation. More...

Detailed Description

Doly arm motion control SDK (C++).

Arm control module.

ArmControl is exposed as a singleton-style API (namespace functions). Events are delivered asynchronously through ArmEvent / ArmEventListener.

Enumeration Type Documentation

◆ ArmErrorType

enum class ArmErrorType : uint8_t
strong

Error categories reported by the arm subsystem.

Enumerator
ABORT 

Operation aborted (user cancel / soft abort).

MOTOR 

Motor or driver related error.

Examples
ArmControl/main.cpp.

◆ ArmSide

enum class ArmSide : uint8_t
strong

Which arm side an operation or event relates to.

Enumerator
BOTH 

Both sides / whole-arm event.

LEFT 

Left arm.

RIGHT 

Right arm.

Examples
ArmControl/main.cpp.

◆ ArmState

enum class ArmState : uint8_t
strong

High-level state of an arm operation.

Enumerator
RUNNING 

Operation is in progress.

COMPLETED 

Operation completed successfully.

ERROR 

Operation terminated due to an error.

Examples
ArmControl/main.cpp.