|
HF-TMC9660 Driver 0.1.0-dev
Hardware Agnostic C++ Driver for the TMC9660
|
TMCL command interface namespace for TMC9660. More...
Enumerations | |
| enum class | Op : std::uint8_t { X } |
| enum class | CalcOperation : std::uint8_t { X } |
| enum class | JumpCondition : std::uint8_t { X } |
| enum class | WaitCondition : std::uint8_t { X } |
| enum class | ReplyCode : std::uint8_t { X } |
| enum class | RamDebugType : std::uint8_t { X } |
| enum class | RamDebugState : std::uint8_t { X } |
| enum class | GlobalParamBank0 : std::uint16_t { X } |
| enum class | GlobalParamBank2 : std::uint16_t { X } |
| enum class | GlobalParamBank3 : std::uint16_t { X } |
| enum class | GateDriver : uint16_t { X } |
| enum class | PwmOutputPolarity : std::uint8_t { X } |
| enum class | GateCurrentSink : std::uint8_t { X } |
| enum class | GateCurrentSource : std::uint8_t { X } |
| enum class | BootstrapCurrentLimit : std::uint8_t { X } |
| enum class | OvercurrentProtection : uint16_t { X } |
| enum class | OvercurrentEnable : std::uint8_t { X } |
| enum class | OvercurrentThreshold : std::uint8_t { X } |
| enum class | OvercurrentTiming : std::uint8_t { X } |
| enum class | VdsUsage : std::uint8_t { X } |
| enum class | UndervoltageProtection : uint16_t { X } |
| enum class | UndervoltageLevel : std::uint8_t { X } |
| enum class | UndervoltageEnable : std::uint8_t { X } |
| enum class | VgsShortProtection : uint16_t { X } |
| enum class | VgsShortEnable : uint8_t { X } |
| enum class | VgsBlankingTime : uint8_t { X } |
| enum class | VgsDeglitchTime : uint8_t { X } |
| enum class | MotorConfig : uint16_t { X } |
| enum class | MotorType : uint8_t { X } |
| enum class | MotorDirection : uint8_t { X } |
| enum class | PwmSwitchingScheme : uint8_t { X } |
| enum class | CommutationMode : std::uint8_t { X } |
| enum class | AdcConfig : uint16_t { X } |
| enum class | AdcShuntType : uint8_t { X } |
| enum class | CsaGain : uint8_t { X } |
| enum class | CsaFilter : uint8_t { X } |
| enum class | AdcMapping : uint8_t { X } |
| enum class | AdcInversion : uint8_t { X } |
| enum class | PwmFrequency : uint32_t { X } |
| enum class | FeedbackSensorConfig : uint16_t { X } |
| enum class | AbnInitMethod : uint8_t { X } |
| enum class | AbnInitState : uint8_t { X } |
| enum class | AbnNChannelFiltering : uint8_t { X } |
| enum class | HallSectorOffset : uint8_t { X } |
| enum class | SpiEncoderTransfer : uint8_t { X } |
| enum class | SpiInitMethod : uint8_t { X } |
| enum class | EnableDisable : uint8_t { X } |
| enum class | Direction : uint8_t { X } |
| enum class | Parameters : uint16_t { X } |
Trigger Transition Options | |
| enum class | TriggerTransition : uint8_t { X } |
| const char * | to_string (TriggerTransition e) |
Idle Motor PWM Behavior | |
| enum class | IdleMotorPwmBehavior : std::uint8_t { X } |
| const char * | to_string (IdleMotorPwmBehavior behavior) |
Torque and Flux Control Parameters | |
| enum class | TorqueFluxControl : uint16_t { X } |
| const char * | to_string (TorqueFluxControl config) |
Torque/Flux PI Separation | |
| enum class | TorqueFluxPiSeparation : uint8_t { X } |
| const char * | to_string (TorqueFluxPiSeparation separation) |
Current PI Normalization Format | |
| enum class | CurrentPiNormalization : uint8_t { X } |
| const char * | to_string (CurrentPiNormalization norm) |
Velocity Mode Parameters | |
| enum class | VelocityControl : uint16_t { X } |
| const char * | to_string (VelocityControl config) |
Velocity Sensor Selection | |
| enum class | VelocitySensorSelection : uint8_t { X } |
| const char * | to_string (VelocitySensorSelection selection) |
Velocity PI Normalization | |
| enum class | VelocityPiNorm : uint8_t { X } |
| const char * | to_string (VelocityPiNorm norm) |
Velocity Meter Modes | |
| enum class | VelocityMeterMode : std::uint8_t { X } |
| const char * | to_string (VelocityMeterMode mode) |
Acceleration Feedforward Shift | |
| enum class | AccelerationFFShift : uint8_t { X } |
| const char * | to_string (AccelerationFFShift shift) |
Position Mode Parameters | |
| enum class | PositionControl : uint16_t { X } |
| const char * | to_string (PositionControl config) |
Position Sensor Selection | |
| enum class | PositionSensorSelection : uint8_t { X } |
| const char * | to_string (PositionSensorSelection selection) |
Position PI Normalization | |
| enum class | PositionPiNorm : uint8_t { X } |
| const char * | to_string (PositionPiNorm norm) |
Ramper Stop Condition and Reference Switch Parameters | |
| enum class | RamperStopConfig : uint16_t { X } |
| const char * | to_string (RamperStopConfig config) |
Reference Switch Enable | |
| enum class | ReferenceSwitchEnable : uint8_t { X } |
| const char * | to_string (ReferenceSwitchEnable enable) |
Reference Switch Polarity and Swap | |
| enum class | ReferenceSwitchPolaritySwap : uint8_t { X } |
| const char * | to_string (ReferenceSwitchPolaritySwap config) |
Reference Switch Latch Settings | |
| enum class | ReferenceSwitchLatchSettings : uint8_t { X } |
| const char * | to_string (ReferenceSwitchLatchSettings setting) |
Event Stop Settings | |
| enum class | EventStopSettings : uint8_t { X } |
| const char * | to_string (EventStopSettings setting) |
Biquad Filter Parameters | |
| enum class | BiquadFilter : uint16_t { X } |
| const char * | to_string (BiquadFilter e) |
Biquad Filter Enable/Disable | |
| enum class | BiquadFilterEnable : uint8_t { X } |
| const char * | to_string (BiquadFilterEnable enable) |
Fault Handling Parameters | |
| enum class | FaultHandling : uint16_t { X } |
| const char * | to_string (FaultHandling config) |
Gate Driver Retry Behaviour | |
| enum class | GdrvRetryBehaviour : uint8_t { X } |
| const char * | to_string (GdrvRetryBehaviour behaviour) |
Drive Fault Behaviour | |
| enum class | DriveFaultBehaviour : std::uint8_t { X } |
| const char * | to_string (DriveFaultBehaviour behaviour) |
IIT Monitor Parameters | |
| enum class | IitMonitor : uint16_t { X } |
| const char * | to_string (IitMonitor e) |
Temperature Protection Parameters | |
| enum class | TemperatureProtection : uint16_t { X } |
| const char * | to_string (TemperatureProtection e) |
Heartbeat Monitoring Parameters | |
| enum class | HeartbeatMonitoring : uint16_t { X } |
| const char * | to_string (HeartbeatMonitoring e) |
Heartbeat Monitoring Config | |
| enum class | HeartbeatMonitoringConfig : uint8_t { X } |
| const char * | to_string (HeartbeatMonitoringConfig e) |
Brake Chopper Parameters | |
| enum class | BrakeChopper : uint16_t { X } |
| const char * | to_string (BrakeChopper e) |
Mechanical Brake Parameters | |
| enum class | MechanicalBrake : uint16_t { X } |
| const char * | to_string (MechanicalBrake e) |
Reference Search (Automatic Homing) Parameters | |
| enum class | ReferenceSearch : uint16_t { X } |
| const char * | to_string (ReferenceSearch e) |
Reference Search Modes | |
| enum class | ReferenceSwitchSearchMode : uint8_t { X } |
| const char * | to_string (ReferenceSwitchSearchMode e) |
Reference Search TMCL Command Types | |
| enum class | ReferenceSearchCommand : uint8_t { X } |
| const char * | to_string (ReferenceSearchCommand e) |
Reference Search Status Codes | |
| enum class | ReferenceSearchStatus : uint8_t { X } |
| const char * | to_string (ReferenceSearchStatus e) |
Step/Dir Interface Parameters | |
| enum class | StepDir : uint16_t { X } |
| const char * | to_string (StepDir e) |
Step/Dir Microstep Divider Shift | |
| enum class | StepDirStepDividerShift : uint8_t { X } |
| const char * | to_string (StepDirStepDividerShift e) |
Hibernation and Wakeup Parameters | |
| enum class | HibernationWakeup : uint16_t { X } |
| const char * | to_string (HibernationWakeup e) |
Power Down Timeout | |
| enum class | PowerDownTimeout : uint8_t { X } |
| const char * | to_string (PowerDownTimeout e) |
System Supply Parameters | |
@{System Supply Parameters | |
| enum class | SystemStatusSupply : uint16_t { X } |
| const char * | to_string (SystemStatusSupply e) |
Internal Measurement Parameters | |
@{Internal Measurement Parameters | |
| enum class | InternalMeasurement : uint16_t { X } |
| const char * | to_string (InternalMeasurement e) |
Combined Diagnostic Values | |
@{Combined Diagnostic Values | |
| enum class | CombinedDiagnosticValues : uint16_t { X } |
| const char * | to_string (CombinedDiagnosticValues e) |
Temperature and Error Flags Parameters | |
| enum class | ErrorsAndFlags : uint16_t { X } |
| const char * | to_string (ErrorsAndFlags e) |
General Status Flags | |
| enum class | GeneralStatusFlags : uint32_t { X } |
| const char * | to_string (GeneralStatusFlags e) |
General Error Flags | |
| enum class | GeneralErrorFlags : uint32_t { X } |
| const char * | to_string (GeneralErrorFlags e) |
Gate Driver Error Flags | |
| enum class | GateDriverErrorFlags : uint32_t { X } |
| const char * | to_string (GateDriverErrorFlags e) |
ADC Status Flags | |
@{ | |
| enum class | AdcStatusFlags : uint32_t { X } |
| const char * | to_string (AdcStatusFlags e) |
TMCL command interface namespace for TMC9660.
This namespace contains all TMCL (Trinamic Motion Control Language) related definitions for the TMC9660 motor driver. It provides comprehensive command structures, parameter definitions, and reply handling for parameter mode operation of the TMC9660.
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
Convert Parameters enum to string representation.
This function provides human-readable names for parameter IDs by looking up the parameter value using integer comparisons covering all defined parameters.
| param | The parameter ID to convert |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |