CDC Badge OS
Firmware for the CDC Badge v1.0 hardware security key
Loading...
Searching...
No Matches
cdc::serial::Command Struct Reference

#include <ICommandRegistry.h>

Public Attributes

const char * name
 Top-level command (e.g. "TOTP" or "PING").
const char * help
 One-line summary shown in HELP.
CommandHandler handler
 Top-level dispatcher / handler.
const char * moduleName
 Module that registered the command (used for HELP grouping).
bool requiresAuth
 Whether the command needs an authenticated session.
const SubCommand * subCommands = nullptr
 Optional null-terminated sub-command table for HELP.

Detailed Description

Command entry for registration

Definition at line 34 of file ICommandRegistry.h.

Member Data Documentation

◆ handler

CommandHandler cdc::serial::Command::handler

Top-level dispatcher / handler.

Definition at line 37 of file ICommandRegistry.h.

◆ help

const char* cdc::serial::Command::help

One-line summary shown in HELP.

Definition at line 36 of file ICommandRegistry.h.

◆ moduleName

const char* cdc::serial::Command::moduleName

Module that registered the command (used for HELP grouping).

Definition at line 38 of file ICommandRegistry.h.

Referenced by cdc::serial::CommandRegistry::registerCommand().

◆ name

const char* cdc::serial::Command::name

Top-level command (e.g. "TOTP" or "PING").

Definition at line 35 of file ICommandRegistry.h.

Referenced by cdc::serial::CommandRegistry::registerCommand().

◆ requiresAuth

bool cdc::serial::Command::requiresAuth

Whether the command needs an authenticated session.

Definition at line 39 of file ICommandRegistry.h.

◆ subCommands

const SubCommand* cdc::serial::Command::subCommands = nullptr

Optional null-terminated sub-command table for HELP.

Definition at line 40 of file ICommandRegistry.h.

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