KETCube
Functions | Variables
ketCube_terminal_common.c File Reference

This file contains the KETCube Terminal shared definitions. More...

#include <string.h>
#include <stdio.h>
#include <stdarg.h>
#include <stdlib.h>
#include "utilities.h"
#include "ketCube_terminal_common.h"
#include "ketCube_modules.h"
#include "ketCube_coreCfg.h"
#include "ketCube_resetMan.h"
#include "../../Projects/src/ketCube_cmdList.c"

Functions

static void ketCube_terminal_cmd_reload (void)
 Perform KETCube reset. More...
 
static void ketCube_terminal_cmd_list (void)
 Show available KETCube modules. More...
 
static void ketCube_terminal_cmd_enable (void)
 Enable given KETCube module. More...
 
static void ketCube_terminal_cmd_disable (void)
 Enable given KETCube module. More...
 
static void ketCube_terminal_getEEPROMCfg (ketCube_terminal_cmd_t *cmdDescrPtr)
 Generic GET EEPROM cfg data. More...
 
static void ketCube_terminal_setEEPROMCfg (ketCube_terminal_cmd_t *cmdDescrPtr)
 Generic SET EEPROM data. More...
 
static void ketCube_terminal_getRAMCfg (ketCube_terminal_cmd_t *cmdDescrPtr)
 Generic GET RAM cfg data. More...
 
static void ketCube_terminal_setRAMCfg (ketCube_terminal_cmd_t *cmdDescrPtr)
 Generic SET RAM data. More...
 
void ketCube_terminal_printCmdList (ketCube_terminal_cmd_t *parent, ketCube_terminal_cmd_t *cmdList, ketCube_terminal_command_flags_t *contextFlags)
 Prints command list at index/level. More...
 
void ketCube_terminal_cmd_help (void)
 
void ketCube_terminal_cmd_about (void)
 
void ketCube_terminal_cmd_enableDisable (bool enable)
 Enable/disable given KETCube module. More...
 
bool ketCube_terminal_checkCmdSubtreeContext (ketCube_terminal_command_flags_t *flags)
 Check if the command definition is valid in given subtree context. More...
 
ketCube_terminal_cmdCheckResult_t ketCube_terminal_checkCmdContext (ketCube_terminal_cmd_t *command, bool local)
 Check if we can run given command in given context. More...
 
void ketCube_terminal_execute (ketCube_terminal_cmd_t *cmd, ketCube_terminal_command_flags_t activeFlags)
 

Variables

ketCube_terminal_paramSet_t commandIOParams
 
ketCube_terminal_command_errorCode_t commandErrorCode
 

Detailed Description

This file contains the KETCube Terminal shared definitions.

Author
Martin Ubl
Version
0.1
Date
2019-03-30
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:

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.

Function Documentation

◆ ketCube_terminal_cmd_disable()

void ketCube_terminal_cmd_disable ( void  )
static

Enable given KETCube module.

◆ ketCube_terminal_cmd_enable()

void ketCube_terminal_cmd_enable ( void  )
static

Enable given KETCube module.

◆ ketCube_terminal_cmd_enableDisable()

void ketCube_terminal_cmd_enableDisable ( bool  enable)

Enable/disable given KETCube module.

Parameters
enableenable given module

◆ ketCube_terminal_cmd_list()

void ketCube_terminal_cmd_list ( void  )
static

Show available KETCube modules.

◆ ketCube_terminal_cmd_reload()

void ketCube_terminal_cmd_reload ( void  )
static

Perform KETCube reset.

◆ ketCube_terminal_getEEPROMCfg()

static void ketCube_terminal_getEEPROMCfg ( ketCube_terminal_cmd_t cmdDescrPtr)
static

Generic GET EEPROM cfg data.

Parameters
cmdDescrPtrpointer to a command descriptor

◆ ketCube_terminal_getRAMCfg()

static void ketCube_terminal_getRAMCfg ( ketCube_terminal_cmd_t cmdDescrPtr)
static

Generic GET RAM cfg data.

Parameters
cmdDescrPtrpointer to a command descriptor

◆ ketCube_terminal_setEEPROMCfg()

static void ketCube_terminal_setEEPROMCfg ( ketCube_terminal_cmd_t cmdDescrPtr)
static

Generic SET EEPROM data.

Parameters
cmdDescrPtrpointer to a command descriptor

◆ ketCube_terminal_setRAMCfg()

static void ketCube_terminal_setRAMCfg ( ketCube_terminal_cmd_t cmdDescrPtr)
static

Generic SET RAM data.

Parameters
cmdDescrPtrpointer to a command descriptor