MCIF-ASCII command description structure. More...

#include <mcif.h>

Data Fields
const char *	name

void(*	fn )(xQueueHandle txq, void arg1, void arg2)

const char *	help_str

uint8_t	flags

Detailed Description

MCIF-ASCII command description structure.

This structure is used to describe to MCIF-ASCII framework a terminal command. The function called (fn) receives the MCIF-ASCII transmit queue (that can be used to send messages to the terminal, if needed), and pointers to the two parsed arguments. The arguments are already parsed, according to the type defined by the command flags, so all that is needed in the command implementation is to cast them to the proper type (e.g. int v = *(int *)arg1;). It is the responsibility of the user function to make sure it does valid casting of the arguements, and it doesn't attempt to use not defined arguments.

Field Documentation

◆ flags

uint8_t mcif_ascii_parse_element_s::flags

Command flags as defined by the MCIF_ASCII_FLAGS_* macros

◆ fn

void(* mcif_ascii_parse_element_s::fn) (xQueueHandle txq, void *arg1, void *arg2)

Pointer to the command user function

◆ help_str

const char* mcif_ascii_parse_element_s::help_str

The string displayed for command usage

◆ name

const char* mcif_ascii_parse_element_s::name

The command name. This is used to enter the command

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

sdk/middleware/mcif/include/mcif.h