Describes a subsystem client registering with the command module. More...

#include <cmd.h>

Collaboration diagram for CMD_CLIENT_INFO_ts:

Public Attributes
const char *const	name
const uint8_t	num_cmds
const CMD_INFO_ts *const	cmds_ptr
LOG_LEVEL_te *const	log_level_ptr

Detailed Description

Describes a subsystem client registering with the command module.

Passed to cmd_register to associate a subsystem name with its command table and log-level variable. The command module stores a pointer to this structure, so it must remain valid for the lifetime of the registration.

Definition at line 92 of file cmd.h.

Member Data Documentation

◆ name

const char* const CMD_CLIENT_INFO_ts::name

Null-terminated client name used as the first token on the console (e.g. "button").

Definition at line 94 of file cmd.h.

◆ num_cmds

const uint8_t CMD_CLIENT_INFO_ts::num_cmds

Number of entries in cmds_ptr.

Definition at line 97 of file cmd.h.

◆ cmds_ptr

const CMD_INFO_ts* const CMD_CLIENT_INFO_ts::cmds_ptr

Pointer to the array of commands exposed by this client.

Definition at line 100 of file cmd.h.

◆ log_level_ptr

LOG_LEVEL_te* const CMD_CLIENT_INFO_ts::log_level_ptr

Pointer to the client's runtime log-level variable. The command module uses this to implement the built-in per-client and wildcard log-level commands.

Definition at line 107 of file cmd.h.

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

core/inc/cmd.h