weAut_01 / weAutSys    R 2.2.1
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Defines
Data Structures | Defines | Functions | Variables
include/we-aut_sys/cli.h File Reference

Overview

weAutSys' command line interpreter (CLI)

This file contains the definitions for weAutSys' system threads and functions for the command line interpretation. Please find detailed description of the variables, functions etc. in the module Command line interpreter and also at system threads.

This is system software and must not be modified for user or application programs.

This file is part of weAutSys   <weinert-automation.de>

  Copyright © 2014 Albrecht Weinert, Bochum

Author:
Albrecht Weinert   <a-weinert.de>
Revision:
2
Date:
2017-01-25 17:49:03 +0100 (Mi, 25 Jan 2017)

Data Structures

struct  appCLIreg_t
 The user / application CLI registration type. More...

Defines

#define YIELD_FOR_BUSY_CLI(appThread)
 Wait (yielding) for command execution to end.

Functions

ptfnct_t appCliThreadF (struct cliThr_data_t *cliThread)
 The user / application specific command line interpreter thread.
void initAsCLIthread (struct thr_data_t *thread, FILE *file)
 Initialise a thread (structure) as command line interpreter (CLI) thread.
void registerAppCli (p2ptFunA threadF, char const *const userCommands[])
 Register a user / application command line interpreter (CLI)
uint8_t setCliLine (struct cliThr_data_t *const cliThread, char *const line, uint16_t length)
 Set a command line in the command line interpreter (CLI) thread data.
ptfnct_t sysCliThreadF (struct cliThr_data_t *cliThread)
 The system command line interpreter thread.
void unimplOptionReport (struct cliThr_data_t *cliThread)
 Report the use of an un-implemented option for a command.

Variables

struct appCLIreg_t appCLIreg
 The user / application command line interpreter (CLI) registration.