HF-TMC51x0 Driver (TMC5130 & TMC5160) 0.1.0-dev
Hardware Agnostic C++ Driver for the TMC51x0 (TMC5130 & TMC5160)
Loading...
Searching...
No Matches
ParsedCommand Struct Reference

Parsed command structure for UART command processing. More...

Public Attributes

CommandType type
 The type of command that was parsed.
 
std::vector< std::pair< OptionType, std::vector< std::string > > > options
 Parsed options for SET command (option type -> argument values)
 
std::string help_topic
 Help topic string for HELP command.
 

Detailed Description

Parsed command structure for UART command processing.

Contains the result of parsing a UART command line. The structure varies based on the command type:

  • SET commands: contain options vector with parsed option-value pairs
  • HELP commands: contain help_topic string
  • Other commands: only contain the command type

Member Data Documentation

◆ help_topic

std::string ParsedCommand::help_topic

Help topic string for HELP command.

◆ options

std::vector<std::pair<OptionType, std::vector<std::string> > > ParsedCommand::options

Parsed options for SET command (option type -> argument values)

◆ type

CommandType ParsedCommand::type

The type of command that was parsed.


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