DriveControl

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

Files
file	DriveControl.h
	Public API for Doly drive motion control.
file	DriveEvent.h
	Event dispatcher API for the Doly DriveControl subsystem.
file	DriveEventListener.h
	Public API types and listener interface for DriveControl.

Classes
class	DriveEventListener
	Interface for receiving drive events. More...

Enumerations
enum class	DriveErrorType : std::uint8_t { DriveErrorType::ABORT , DriveErrorType::FORCE , DriveErrorType::ROTATE , DriveErrorType::MOTOR }
	Classification of a drive error. More...
enum class	DriveMotorSide : std::uint8_t { DriveMotorSide::BOTH , DriveMotorSide::LEFT , DriveMotorSide::RIGHT }
	Which motor side is associated with an error/event. More...
enum class	DriveState : std::uint8_t { DriveState::RUNNING , DriveState::COMPLETED , DriveState::ERROR }
	High-level state of a drive operation. More...
enum class	DriveType : std::uint8_t { DriveType::FREESTYLE , DriveType::XY , DriveType::DISTANCE , DriveType::ROTATE }
	Type/category of a drive operation. More...

Detailed Description

Doly drive motion control SDK (C++).

Drive motion control module.

DriveControl is exposed as a singleton-style API (namespace functions). Events are delivered asynchronously through DriveEvent / DriveEventListener.

Enumeration Type Documentation

DriveErrorType

enum class DriveErrorType : std::uint8_t

strong

Classification of a drive error.

Enumerator
ABORT	Operation was aborted before completion (manual stop or cancel).
FORCE	Excessive force / resistance detected.
ROTATE	Rotation subsystem error.
MOTOR	Motor fault.

Examples

DriveControl/main.cpp.

DriveMotorSide

enum class DriveMotorSide : std::uint8_t

strong

Which motor side is associated with an error/event.

Enumerator
BOTH	Both sides.
LEFT	Left side.
RIGHT	Right side.

Examples

DriveControl/main.cpp.

DriveState

enum class DriveState : std::uint8_t

strong

High-level state of a drive operation.

Enumerator
RUNNING	Operation is in progress.
COMPLETED	Operation completed successfully.
ERROR	Operation terminated due to an error.

Examples

DriveControl/main.cpp.

DriveType

enum class DriveType : std::uint8_t

strong

Type/category of a drive operation.

Enumerator
FREESTYLE	Freeform/low-level control.
XY	X/Y coordinated motion.
DISTANCE	Distance-based linear motion.
ROTATE	Rotation-only motion.

Examples

DriveControl/main.cpp.