mm::node::OpenPhaseResult Struct Reference

What open phase detection found. More...

#include <somanet_drive.h>

Public Member Functions
std::string	describe () const
	One line describing the finding, ready to put in front of a user.

Public Attributes
bool	phaseOpened = false
	True when the drive found an open phase.
std::optional< somanet::OpenPhaseFault >	fault
std::optional< uint8_t >	faultCode
	The raw code, present whenever phaseOpened.

Detailed Description

What open phase detection found.

The command's verdict is inverted relative to every other OS command, and that is the firmware's design rather than a quirk to paper over: the drive reports success when no phase is open, and reports a failure whose command-specific error code names which terminal or FET leg is open. So a failed OS command here is a completed measurement with a negative finding, not a malfunction — which is why this is a value and not an error.

Member Function Documentation

describe()

std::string mm::node::OpenPhaseResult::describe

(

)

const

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

Member Data Documentation

fault

std::optional<somanet::OpenPhaseFault> mm::node::OpenPhaseResult::fault

Which fault, when the drive reported a code this build names. Absent for a code it does not, which faultCode still carries — a firmware that grows the table stays reportable.

faultCode

std::optional<uint8_t> mm::node::OpenPhaseResult::faultCode

The raw code, present whenever phaseOpened.

phaseOpened

bool mm::node::OpenPhaseResult::phaseOpened = false

True when the drive found an open phase.

---

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

• libs/node/somanet_drive.h
• libs/node/somanet_drive.cc