Motion Master
Loading...
Searching...
No Matches
Public Types | Public Member Functions | List of all members
CoggingTorqueCompensation Class Reference

#include <cogging_torque_compensation.h>

Public Types

enum class  State { kRecordingNoData , kRecordingInProgress , kRecordingSaving , kRecordingDataExists }
 

Public Member Functions

 CoggingTorqueCompensation (Cia402Drive &cia402_drive)
 Initialize cogging torque recording and collect relevant system information. More...
 
MotionMasterError enable (bool enable)
 Enable/disable the cogging torque compensation. More...
 
MotionMasterError record_cogging_torque (bool auto_config)
 Record the cogging torque with or without doing the automatic configuration beforehand. More...
 

Member Enumeration Documentation

◆ State

Enumerator
kRecordingNoData 
kRecordingInProgress 
kRecordingSaving 
kRecordingDataExists 

Constructor & Destructor Documentation

◆ CoggingTorqueCompensation()

CoggingTorqueCompensation::CoggingTorqueCompensation ( Cia402Drive cia402_drive)
explicit

Initialize cogging torque recording and collect relevant system information.

Parameters
cia402_drive
Exceptions
MotionMasterError

Member Function Documentation

◆ enable()

MotionMasterError CoggingTorqueCompensation::enable ( bool  enable)

Enable/disable the cogging torque compensation.

Parameters
enableenable/disable
Returns
error if any
Note
The CTC enable parameter can be dynamically changed from firmwares v4.0.3 and v4.1.0, so there is no need for reloading the configuration for it to take effect

◆ record_cogging_torque()

MotionMasterError CoggingTorqueCompensation::record_cogging_torque ( bool  auto_config)

Record the cogging torque with or without doing the automatic configuration beforehand.

Attention
Automatic configuration also includes the iterative sharpening (auto-tuning)
Parameters
auto_configwhether to do the automatic configuration or not
Returns
error if any

The documentation for this class was generated from the following files: