SSC APIs

SSC APIs. More...

Functions
void	ssc_attach (SscBaudRate bandrate)
	Initial the ssc function. More...
int	ssc_param_len (void)
	Get the length of the simple serial command. More...
char *	ssc_param_str (void)
	Get the simple serial command string. More...
int	ssc_parse_param (char *pLine, char *argv[])
	Parse the simple serial command (ssc). More...
void	ssc_register (ssc_cmd_t *cmdset, uint8 cmdnum, void(*help)(void))
	Register the user-defined simple serial command (ssc) set. More...

Detailed Description

SSC APIs.

SSC means simple serial command. SSC APIs allows users to define their own command, users can refer to spiffs_test/test_main.c.

Function Documentation

void ssc_attach

(

SscBaudRate

bandrate

)

Initial the ssc function.

Parameters

SscBaudRate

bandrate : baud rate

Returns

null

int ssc_param_len

(

void

)

Get the length of the simple serial command.

Parameters

null

Returns

length of the command.

char* ssc_param_str

(

void

)

Get the simple serial command string.

Parameters

null

Returns

the command.

int ssc_parse_param	(	char *	pLine,
		char *	argv[]
	)

Parse the simple serial command (ssc).

Parameters

char	*pLine : [input] the ssc string
char	*argv[] : [output] parameters of the ssc

Returns

the number of parameters.

void ssc_register	(	ssc_cmd_t *	cmdset,
		uint8	cmdnum,
		void(*)(void)	help
	)

Register the user-defined simple serial command (ssc) set.

Parameters

ssc_cmd_t	*cmdset : the ssc set
uint8	cmdnum : number of commands
void	(* help)(void) : callback of user-guide

Returns

null