ketCube_terminal.h File Reference

This file contains definitions for the terminal. More...

#include <stdarg.h>
#include <stdlib.h>
#include "ketCube_terminal_common.h"
#include "vcom.h"

Go to the source code of this file.

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...
static void	ketCube_terminal_AlwaysPrintln (ketCube_cfg_moduleIDs_t modId, char *format,...)
static void	ketCube_terminal_NewDebugPrintln (ketCube_cfg_moduleIDs_t modId, char *format,...)
static void	ketCube_terminal_ErrorPrintln (ketCube_cfg_moduleIDs_t modId, char *format,...)
static void	ketCube_terminal_InfoPrintln (ketCube_cfg_moduleIDs_t modId, char *format,...)

Detailed Description

This file contains definitions for the terminal.

Author

Jan Belohoubek

Version

0.1

Date

2018-01-05

Attention

© Copyright (c) 2018 University of West Bohemia in Pilsen All rights reserved.

Developed by: The SmartCampus Team Department of Technologies and Measurement www.smartcampus.cz | www.zcu.cz

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal with the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

• Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimers.
• Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimers in the documentation and/or other materials provided with the distribution.
• Neither the names of The SmartCampus Team, Department of Technologies and Measurement and Faculty of Electrical Engineering University of West Bohemia in Pilsen, nor the names of its contributors may be used to endorse or promote products derived from this Software without specific prior written permission.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE CONTRIBUTORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS WITH THE SOFTWARE.