Enet CLI API

Introduction

Sub Modules
	FreeRTOS Plus CLI Porting Layer

Functions
void	EnetCli_init (Enet_Type enetType, uint32_t instId)
	Initialize variables necessary for CLI. More...
void	EnetCli_registerBuiltInCommands ()
	Registers all built-in commands to command interpreter. More...
bool	EnetCli_processCommand (const char *pCommandInput, char *pWriteBuffer, size_t writeBufferLen)
	Processes the command and runs the associated function. More...
const char *	EnetCli_getParameter (const char *pCommandString, uint32_t wantedParam, uint32_t *paramLen)
	Extracts a specific parameter from the command. More...

Function Documentation

EnetCli_init()

void EnetCli_init	(	Enet_Type	enetType,
		uint32_t	instId
	)

Initialize variables necessary for CLI.

Gets necessary data like enet handle, core ID and number of MAC ports that are required by the built-in commands.

Parameters

enetType	Enet peripheral type
instId	Enet peripheral instance ID

EnetCli_registerBuiltInCommands()

void EnetCli_registerBuiltInCommands

(

)

Registers all built-in commands to command interpreter.

Use this to enable built-in commands in the application. Should be called only after calling EnetCli_init().

EnetCli_processCommand()

bool EnetCli_processCommand	(	const char *	pCommandInput,
		char *	pWriteBuffer,
		size_t	writeBufferLen
	)

Processes the command and runs the associated function.

Processes the command and executes the function that is associated to the command.

Parameters

pCommandInput	The command to be processed
pWriteBuffer	Buffer to store output after command is executed
writeBufferLen	Length of the output buffer

Returns

true if more data needs to be returned. Otherwise false.

EnetCli_getParameter()

const char* EnetCli_getParameter	(	const char *	pCommandString,
		uint32_t	wantedParam,
		uint32_t *	paramLen
	)

Extracts a specific parameter from the command.

Parameters

pCommandString	The command from which the parameter needs to be extracted
wantedParam	The parameter index that needs to be extracted
paramLen	The length of the extracted parameter

Returns

A pointer to the first character of the extracted parameter string.