KETCube Terminal

KETCube serial terminal. More...

Modules
	KETCube core CMD
	KETCube core commandline definitions.
	KETCube Terminal Severity print functions
	KETCube Terminal Severity print functions.
	KETCube terminal shared variables
	KETCube terminal shared variables (for local and remote context)
	KETCube terminal shared functions
	KETCube terminal shared functions (for local and remote context)
	KETCube LoRa CMD
	KETCube LoRa module commandline deffinition.

Data Structures
struct	ketCube_terminal_buffer_t
	Terminal user input item. More...

Macros
#define	KETCUBE_TERMINAL_DEBUG   FALSE
#define	KETCUBE_TERMINAL_MODDEBUG   TRUE
#define	KETCUBE_TERMINAL_ECHO   TRUE
#define	KETCUBE_TERMINAL_HISTORY_LEN   3
#define	KETCUBE_TERMINAL_CMD_MAX_LEN   128
#define	KETCUBE_TERMINAL_PRINTF(...)   ketCube_terminal_UsartPrint(__VA_ARGS__)
#define	KETCUBE_TERMINAL_PROMPT()   KETCUBE_TERMINAL_PRINTF(">> ")
#define	KETCUBE_TERMINAL_ENDL()   KETCUBE_TERMINAL_PRINTF("\n\r")
#define	KETCUBE_TERMINAL_CLR_LINE()   ketCube_terminal_ClearCmdLine()

Functions
void	ketCube_terminal_Init (void)
	Init terminal. More...
void	ketCube_terminal_ProcessCMD (void)
	Process user input. More...
void	ketCube_terminal_UpdateCmdLine (void)
	Print current unfinished command. More...
void	ketCube_terminal_ClearCmdLine (void)
	Clear command line. More...
void	ketCube_terminal_cmd_about (void)
void	ketCube_terminal_cmd_help (void)
void	ketCube_terminal_UsartPrint (char *format,...)
void	ketCube_terminal_Print (char *format,...)
	Print format to serial line. More...
void	ketCube_terminal_Println (char *format,...)
	Print line to serial line + newline. More...
void	ketCube_terminal_CoreSeverityPrintln (ketCube_severity_t msgSeverity, char *format,...)
	Print Debug info to serial line + newline. More...
void	ketCube_terminal_DriverSeverityPrintln (const char *drvName, ketCube_severity_t msgSeverity, char *format,...)
	Print Debug info to serial line + newline. More...
void	ketCube_terminal_ModSeverityPrintln (ketCube_severity_t msgSeverity, ketCube_cfg_moduleIDs_t modId, char *format, va_list args)
	Print Debug info to serial line + newline. More...
void	ketCube_terminal_DebugPrint (char *format,...)
	Print Debug info to serial line. More...
void	ketCube_terminal_DebugPrintln (char *format,...)
	Print Debug info to serial line + newline. More...

Detailed Description

KETCube serial terminal.

This KETCube module implements the serial terminal interface

Macro Definition Documentation

KETCUBE_TERMINAL_CLR_LINE

#define KETCUBE_TERMINAL_CLR_LINE

(

)

ketCube_terminal_ClearCmdLine()

Clear ASCI terminal line

KETCUBE_TERMINAL_CMD_MAX_LEN

#define KETCUBE_TERMINAL_CMD_MAX_LEN   128

Max command length

KETCUBE_TERMINAL_DEBUG

#define KETCUBE_TERMINAL_DEBUG   FALSE

Turn ON/OFF low-level debug messages

KETCUBE_TERMINAL_ECHO

#define KETCUBE_TERMINAL_ECHO   TRUE

Turn ON/OFF echo

KETCUBE_TERMINAL_ENDL

#define KETCUBE_TERMINAL_ENDL

(

)

KETCUBE_TERMINAL_PRINTF("\n\r")

Print ASCI terminal ENDL

KETCUBE_TERMINAL_HISTORY_LEN

#define KETCUBE_TERMINAL_HISTORY_LEN   3

Remember last 3 commands

KETCUBE_TERMINAL_MODDEBUG

#define KETCUBE_TERMINAL_MODDEBUG   TRUE

Turn ON/OFF structured debug messages

KETCUBE_TERMINAL_PRINTF

#define KETCUBE_TERMINAL_PRINTF

(

...

)

ketCube_terminal_UsartPrint(__VA_ARGS__)

Printf wrapper

KETCUBE_TERMINAL_PROMPT

#define KETCUBE_TERMINAL_PROMPT

(

)

KETCUBE_TERMINAL_PRINTF(">> ")

Print command line PROMPT

Function Documentation

ketCube_terminal_ClearCmdLine()

void ketCube_terminal_ClearCmdLine

(

void

)

Clear command line.

Use to clear user input and prompt

ketCube_terminal_cmd_about()

void ketCube_terminal_cmd_about

(

void

)

ketCube_terminal_cmd_help()

void ketCube_terminal_cmd_help

(

void

)

ketCube_terminal_CoreSeverityPrintln()

void ketCube_terminal_CoreSeverityPrintln	(	ketCube_severity_t	msgSeverity,
		char *	format,
			...
	)

Print Debug info to serial line + newline.

Parameters

msgSeverity	mesage severity
format	printf-style format string
args

Note

ketCube_terminal_CoreSeverityPrintln() does not introduce any formatting in contrast with ketCube_terminal_ModSeverityPrintln(), where the produced string is prefixed by originator module Name

ketCube_terminal_DebugPrint()

void ketCube_terminal_DebugPrint	(	char *	format,
			...
	)

Print Debug info to serial line.

Note

This function is deprecated and will be removed in the next release(s)

Todo:

This is a deprecated function

ketCube_terminal_DebugPrintln()

void ketCube_terminal_DebugPrintln	(	char *	format,
			...
	)

Print Debug info to serial line + newline.

Note

This function is deprecated and will be removed in the next release(s)

Todo:

This is a deprecated function

ketCube_terminal_DriverSeverityPrintln()

void ketCube_terminal_DriverSeverityPrintln	(	const char *	drvName,
		ketCube_severity_t	msgSeverity,
		char *	format,
			...
	)

Print Debug info to serial line + newline.

Parameters

msgSeverity	mesage severity
format	printf-style format string
args

ketCube_terminal_Init()

void ketCube_terminal_Init

(

void

)

Init terminal.

ketCube_terminal_ModSeverityPrintln()

void ketCube_terminal_ModSeverityPrintln	(	ketCube_severity_t	msgSeverity,
		ketCube_cfg_moduleIDs_t	modId,
		char *	format,
		va_list	args
	)

Print Debug info to serial line + newline.

Parameters

msgSeverity	mesage severity
modID	mesage origin moduleID
format	printf-style format string
args	va_list

ketCube_terminal_Print()

void ketCube_terminal_Print	(	char *	format,
			...
	)

Print format to serial line.

ketCube_terminal_Println()

void ketCube_terminal_Println	(	char *	format,
			...
	)

Print line to serial line + newline.

ketCube_terminal_ProcessCMD()

void ketCube_terminal_ProcessCMD

(

void

)

Process user input.

ketCube_terminal_UpdateCmdLine()

void ketCube_terminal_UpdateCmdLine

(

void

)

Print current unfinished command.

Use when it is necessary to print something and not to disrupt current command

ketCube_terminal_UsartPrint()

void ketCube_terminal_UsartPrint	(	char *	format,
			...
	)