Motion Master 6.0.0-alpha.86
Next-generation motion control software
Loading...
Searching...
No Matches
mm::node::MotorPhaseOrderResult Struct Reference

What motor phase order detection (command 4) found. More...

#include <somanet_drive.h>

Public Member Functions

bool inverted () const
 Whether the phases are inverted — the one bit a caller normally branches on.
 
std::string describe () const
 One line describing the finding, ready to put in front of a user.
 

Public Attributes

somanet::MotorPhaseOrder order {somanet::MotorPhaseOrder::kNormal}
 What the drive detected.
 

Detailed Description

What motor phase order detection (command 4) found.

Unlike the other measurements, the drive stores this one: on success the firmware writes the detected order into 0x2003:05 "Motor phases inverted" itself, so a successful run has reconfigured the drive rather than merely reported a number.

Member Function Documentation

◆ describe()

std::string mm::node::MotorPhaseOrderResult::describe ( ) const

One line describing the finding, ready to put in front of a user.

◆ inverted()

bool mm::node::MotorPhaseOrderResult::inverted ( ) const
inline

Whether the phases are inverted — the one bit a caller normally branches on.

Member Data Documentation

◆ order

somanet::MotorPhaseOrder mm::node::MotorPhaseOrderResult::order {somanet::MotorPhaseOrder::kNormal}

What the drive detected.


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