Predefined text blocks and handling utilities are provided for system and application software. Whenever possible constant strings ar held in program (flash) memory only.
See also the common types and helpers
Defines | |
#define | comAutomationNum |
command: [-stop | -start] PLC cycles (flash text) | |
#define | comBootNum |
command: boot -load | -reset (flash text) | |
#define | comDateNum |
command: show / set (local) date | |
#define | comDHCPNum |
command: show / restart DHCP | |
#define | comDirlistNum |
command: dirList [-option] [dirPath] memory card directory | |
#define | comDNSNum |
command: resolve a name by DNS | |
#define | comENCNum |
command: ENC28J60 network interface (same as NICont) | |
#define | comEthAddrNum |
command: show address (ARP) info (flash text) | |
#define | comHelpNum |
command: show help (flash text) | |
#define | comIPconfigNum |
command: show IP configuration info (flash text) | |
#define | comIPdefAdNum |
command: show / set IP address (flash text) | |
#define | comMacAddrNum |
command: show / set MAC address (flash text) | |
#define | comModbusNum |
command: modbus [-stop -off -reset | ... | |
#define | comNICNum |
command: NICont [-off | -on | -reset | -restart] | |
#define | comNTPNum |
command: show / set NTP state and configuration | |
#define | comPLContrlNum |
command: [-stop | -start] PLC cycles (flash text) | |
#define | comRunInfoNum |
command: show run time info (flash text) | |
#define | comSMCNum |
command: SMCard [ -on | -start | reset | -rest... | |
#define | comTelnetNum |
command: telnet [-stop] | |
#define | comTimeNum |
command: show / set (local) time | |
#define | comTypeFileNum |
command: typeFile filename display a file | |
#define | comUARTNum |
command: show / set UART flow control (flash text) | |
#define | comVersionNum |
command: show version info (flash text) | |
#define | comWatchDNum |
command: watchdog [abort | sharp | lenient | normal] | |
#define | comWDogNum |
command: wdog 60 ms | 120 ms | 250 ms | |
#define | comZoneNum |
command: show / set time zone and DST state | |
#define | optAbortNum |
options: abort a hard reset | |
#define | optAlternNum |
options: use or restart with alternative | |
#define | optAmbigousNum |
options: option given ambiguously | |
#define | optApplicNum |
options: application related | |
#define | optDebugNum |
options: debug lengthy output for trouble shooting | |
#define | optFastNum |
options: fast fast(er) speed | |
#define | optFlowCnNum |
options: ask or set flow control behaviour | |
#define | optHelpNum |
options: help command specific help | |
#define | optInfoNum |
options: inform normal / informing output | |
#define | optLenientNum |
options: lenient more forgiving | |
#define | optLoadNum |
options: perform load operation or set load mode | |
#define | optLogHereNum |
options: use this device as log output | |
#define | optNoLogsNum |
options: do not use this device as log output | |
#define | optNormalNum |
options: normal standard behaviour / speed | |
#define | optNotGivenNum |
options, commands, parameters: no option given / set | |
#define | optOffNum |
options: off turn off / stop | |
#define | optOnNum |
options: on turn on / start | |
#define | optOptionNum |
options: options related | |
#define | optPrimarNum |
options: use or restart with primary resource | |
#define | optQuestNum |
options: ? like -help | |
#define | optQuietNum |
options: quiet like -silent | |
#define | optReadNum |
options: perform read operation or set read mode | |
#define | optResetNum |
options: reset like -stop or -restart (it depends) | |
#define | optRestartNum |
options: restart like -start (in most cases) | |
#define | optSharpNum |
options: sharp more exact / less forgiving | |
#define | optSilentNum |
options: silent no or only urgent output | |
#define | optSlowNum |
options: slow slow(er) speed | |
#define | optStartNum |
options: start like -on (in most cases) | |
#define | optStopNum |
options: stop like -off (in most cases) | |
#define | optSystemNum |
options: system related | |
#define | optVerboseNum |
options: verbose lengthy output | |
#define | optWriteNum |
options: perform write operation or set write mode | |
Functions | |
char * | getSomeCharsP (char *dst, char const *src, uint8_t mxLen) |
Copy some characters from program space to a string. | |
Variables | |
char const | arpEmpty [] |
" no valid entries in ARP table \n\n" flash text building block | |
char const const | arpEntries [] |
" ARP entries " flash text building block | |
char const | comAutomation [] |
command: [-stop | -start] PLC cycles (flash text) | |
char const | comBoot [] |
command: boot -load | -reset (flash text) | |
char const | comDate [] |
command: show / set (local) date | |
char const | comDHCP [] |
command: show / restart DHCP | |
char const | comDirlist [] |
command: dirList [-option] [dirPath] memory card directory | |
char const | comDNS [] |
command: resolve a name by DNS | |
char const | comENC [] |
command: ENC28J60 network interface (same as NICont) | |
char const | comEthAddr [] |
command: show address (ARP) info (flash text) | |
char const | comHelp [] |
command: show help (flash text) | |
char const | comIPconfig [] |
command: show IP configuration info (flash text) | |
char const | comIPdefAd [] |
command: show / set IP address (flash text) | |
char const | comMacAddr [] |
command: show / set MAC address (flash text) | |
char const | commAmbig [] |
command report: ambiguous (flash text) | |
char const | comModbus [] |
command: modbus [-stop -off -reset | ... | |
char const | commWrong [] |
command report: wrong (flash text) | |
char const | comNIC [] |
command: NICont [-off | -on | -reset | -restart] | |
char const | comNTP [] |
command: show / set NTP state and configuration | |
char const | comPLContrl [] |
command: [-stop | -start] PLC cycles (flash text) | |
char const | comRunInfo [] |
command: show run time info (flash text) | |
char const | comSMC [] |
command: SMCard [ -on | -start | reset | -rest... | |
char const | comTelnet [] |
command: telnet [-stop] : Telnet [close] | |
char const | comTime [] |
command: show / set (local) time | |
char const | comTypeFile [] |
command: typeFile filename display a file | |
char const | comUART [] |
command: show / set UART options | |
char const | comVersion [] |
command: show version info (flash text) | |
char const | comWatchD [] |
command: watchdog [abort | sharp | lenient | normal] | |
char const | comWDog [] |
command: wdog 60 ms | 120 ms | 250 ms | |
char const | comZone [] |
command: show / set time zone and DST state | |
char const | encEthSta [] |
" ENC/Eth st. : " flash text building block | |
char const | helpHeader [] |
Headline for system commands overview (help list) | |
char const | helpUserCm [] |
Headline for application commands overview (help list) | |
char const | ip4Add_is [] |
" IP4 address : " flash text building block | |
char const | ipConDefR [] |
" def. router : " flash text building block | |
char const | ipConDefS [] |
" def. set " flash text building block | |
char const | ipConDHCs [] |
" DHCP set " flash text building block | |
char const | ipConDHCu [] |
" use DHCP " flash text building block | |
char const | ipConDNSa [] |
" DNS address : " flash text building block | |
char const | ipConIpAd [] |
" IP4 address : " flash text building block | |
char const | ipConNMsk [] |
" IP4 netmask : " flash text building block | |
char const | ipConNTPa [] |
" NTP address : " flash text building block | |
char const | ipDefault [] |
" IP4 default : " flash text building block | |
char const const | macAdd_is [] |
" MAC address : " flash text building block | |
char const | noUserCLI [] |
report: no user CLI (flash text) | |
char const | optAbort [] |
options: abort a hard reset | |
char const | optAltern [] |
options: use or restart with alternative | |
char const | optAmbig [] |
option report: ambiguous (flash text) | |
char const | optApplic [] |
options: application related | |
char const | optDebug [] |
options: debug lengthy output for trouble shooting | |
char const | optFast [] |
options: fast fast(er) speed "; | |
char const | optFlowCn [] |
options: ask or set flow control behaviour | |
char const | optHelp [] |
options: help command specific help | |
char const | optInfo [] |
options: inform normal / informing output | |
char const | optionHeader [] |
options: * * * Command options | |
char const | optLenient [] |
options: lenient more forgiving | |
char const | optLoad [] |
options: perform load operation or set load mode | |
char const | optLogHere [] |
options: use this device as log output | |
char const | optNoLogs [] |
options: do not use this device as log output | |
char const | optNormal [] |
options: normal standard behaviour / speed | |
char const | optOff [] |
options: off turn off / stop | |
char const | optOn [] |
options: on turn on / start | |
char const | optOption [] |
options: options related | |
char const | optPrimar [] |
options: use or restart with primary resource | |
char const | optQuest [] |
options: ? like -help | |
char const | optQuiet [] |
options: quiet like -silent | |
char const | optRead [] |
options: perform read operation or set read mode | |
char const | optReset [] |
options: reset like -stop or -restart (it depends) | |
char const | optRestart [] |
options: restart like -start (in most cases) | |
char const | optSharp [] |
options: sharp more exact / less forgiving | |
char const | optSilent [] |
options: silent no or only urgent output | |
char const | optSlow [] |
options: slow slow(er) speed "; | |
char const | optStart [] |
options: start like -on (in most cases) | |
char const | optStop [] |
options: stop like -off (in most cases) | |
char const | optSystem [] |
options: system related | |
char const | optVerbose [] |
options: verbose lengthy output | |
char const | optWrite [] |
options: perform write operation or set write mode | |
char const | optWrong [] |
option report: wrong (flash text) | |
char const | sepLoB [] |
Blanks and left opening brace. | |
char const | sepRcB [] |
Right closing brace and blanks. | |
char const | sysRunSectorN [] |
report: LF SMC sector buffered: 0x | |
char const | systAut [] |
The author of weAutSys. | |
char const | systBld [] |
The build date and time. | |
char const | systBye [] |
An farewell (abort) line with three leading feeds and the system name. | |
char const | systCop [] |
weAutSys's copyright notice. | |
char const | systDat [] |
The system's last modification date. | |
char const *const | systemCommands [] |
flash array of the (flash) system command definitions | |
char const *const | systemOptions [] |
List and definitions of command options. | |
char const | systMod [] |
The system's last modifier. | |
char const | systNam [] |
The name of the runtime system weAutSys. | |
char const | systRev [] |
The system's revision. | |
char const | systWlc [] |
A greeting line with three leading feeds and the system name. | |
char const | wdSetLeni [] |
report: watchdog set long / lenient (flash text)r | |
char const | wdSetNormal [] |
report: watchdog set normal (flash text)r | |
char const | wdSetSharp [] |
report: watchdog set sharp (flash text) | |
char const | wdSetShort [] |
report: watchdog set short (flash text) |
char* getSomeCharsP | ( | char * | dst, |
char const * | src, | ||
uint8_t | mxLen | ||
) |
Copy some characters from program space to a string.
This function copies up to mxLen-1
characters from src
to dst
and appends a trailing 0. Returned is the address of the last character in dst
modified (the 0's address).
The operation will stop after mxLen
characters transferred resp. modified or if a terminating 0 if found in src
.
dst | the destination to modify (in RAM, not null!) |
src | the source (string) to copy from (in flash memory, not null!) |
mxLen | the maximum number of characters to modify in dst including the trailing 0 appended. The maximum advance of the return value to parameter dst |
dst
is NULL char const systNam[] |
char const systWlc[] |
char const systBye[] |
char const systRev[] |
The system's revision.
It is the SVN revision of the (this) file system.h. If not treated with beautifying tools like de.frame4j.CVSkeys (.java) prior to make it will be the full SVN tag in Dollars (
).
This is a string in flash memory.
char const systDat[] |
The system's last modification date.
It is in fact the SVN date of the (this) file system.h. If not treated with beautifying tools like de.frame4j.CVSkeys (.java) prior to the make process it will be the full SVN tag in Dollars (
).
Un-beautified — the usual vase — this is a horrible date time zone (text) format; the first token is the date like 2011-03-11 (yyyy-mm-dd). This can be extracted by getFirstSVNtokenP()
This is a string in flash memory.
char const systMod[] |
The system's last modifier.
It is the SVN user name of the person who did the latest modification of the (this) file system.h. If not treated with beautifying tools like
de.frame4j.CVSkeys
(.java, see frame4j.de) prior to make it will be the full SVN tag in Dollars (
).
de.frame4j.CVSkeys can be configured to replace SVN or system account names with the human's name, like e.g.
This is a string in flash memory.
char const systAut[] |
The author of weAutSys.
It is the author's name and his personal domain.
This is a string in flash memory.
char const systCop[] |
weAutSys's copyright notice.
This is a string in flash memory.
char const systBld[] |
The build date and time.
It is the word "build" followed by the date and time where the C-preprocessor rolled over the (this) file system.h. This will be time where the weAutSys runtime was build (if you get the text from a living system.
This is a string in flash memory.
char const sepLoB[] |
Blanks and left opening brace.
It is " (".
This is just a building block for Strings held in flash memory.
char const sepRcB[] |
Right closing brace and blanks.
It is ") ".
This is just a building block for Strings held in flash memory.
char const* const systemOptions[] |
List and definitions of command options.
This is the flash array of the (flash) option definitions. Options are recognised by setCliLine() if prefixed by - (minus) and given as first parameter of a command, like e.g. "help -options". Like with commands, options may be abbreviated if the abbreviation is not ambiguous, as would be -res instead of -reset respectively -restart.
As commands options are not case sensitive.
Unrecognised options may be (silently) or may be not ignored by system and application commands.
char const helpUserCm[] |
Headline for application commands overview (help list)
This flash text must be the first entry in userCommands[] if user software chooses to register application specific commands.
char const helpHeader[] |
Headline for system commands overview (help list)
This flash text is the first entry in systemCommands[].