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

What one raw OS command run produced — the step's value. More...

#include <somanet_procedures.h>

Collaboration diagram for mm::node::OsCommandResult:
[legend]

Public Attributes

uint8_t status = 0
 Terminal status byte (0x1023:03 byte 0).
 
std::vector< uint8_t > data
 Service response payload, if the drive sent one.
 
std::optional< uint8_t > errorCode
 
std::vector< uint8_t > fsBuffer
 

Detailed Description

What one raw OS command run produced — the step's value.

A procedure-specific value type with its own to_json, which is how a body records something richer than a number without ProgressStep needing to know about it (see ProgressStep).

Member Data Documentation

◆ data

std::vector<uint8_t> mm::node::OsCommandResult::data

Service response payload, if the drive sent one.

◆ errorCode

std::optional<uint8_t> mm::node::OsCommandResult::errorCode

OS error code, present only when the drive reported one.

◆ fsBuffer

std::vector<uint8_t> mm::node::OsCommandResult::fsBuffer

What the fs-buffer transfer read, when one was asked for. Serialised the same way as data, as an array of byte values, so one result reads consistently.

◆ status

uint8_t mm::node::OsCommandResult::status = 0

Terminal status byte (0x1023:03 byte 0).


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