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

The state of the auto-tuning process, reported by GET /api/auto-tuning. More...

#include <status.h>

Collaboration diagram for mm::auto_tuning::Status:
[legend]

Public Attributes

bool enabled = false
 autoTuning.enabled from the configuration.
 
std::string binaryPath
 The executable Motion Master looked for, resolved to an absolute path.
 
bool installed = false
 Whether a file exists at that path.
 
bool started = false
 Whether the process started and answered its health endpoint.
 
std::string version
 
std::uint16_t port = 0
 The loopback port it was told to serve on.
 
std::string error
 Why it is not running, when it is not. Empty when it is.
 

Detailed Description

The state of the auto-tuning process, reported by GET /api/auto-tuning.

Four states matter to a user interface, and they need different words: auto-tuning was switched off in the configuration, the executable is not on this machine, it is there but would not run, or it is running. A page that can say which one is showing is far more use than a form that fails.

This is a startup snapshot. started says the process answered when Motion Master waited for it, not that it is alive now — nothing polls it, because a request is the honest test and the endpoints make one.

Member Data Documentation

◆ binaryPath

std::string mm::auto_tuning::Status::binaryPath

The executable Motion Master looked for, resolved to an absolute path.

◆ enabled

bool mm::auto_tuning::Status::enabled = false

autoTuning.enabled from the configuration.

◆ error

std::string mm::auto_tuning::Status::error

Why it is not running, when it is not. Empty when it is.

◆ installed

bool mm::auto_tuning::Status::installed = false

Whether a file exists at that path.

◆ port

std::uint16_t mm::auto_tuning::Status::port = 0

The loopback port it was told to serve on.

◆ started

bool mm::auto_tuning::Status::started = false

Whether the process started and answered its health endpoint.

◆ version

std::string mm::auto_tuning::Status::version

The version it reported, empty unless it started. A build older than the version endpoint starts and reports nothing, which is why this is not the test for started.


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