Important changes to repositories hosted on mbed.com
Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.
To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.
It is also possible to export all your personal repositories from the account settings page.
Dependencies: NaturalTinyShell_ice libmDot-12Sept mbed-rtos mbed
Fork of ICE by
Diff: src/CommandParser/cmd.cpp
- Revision:
- 35:6235ef67faa1
- Parent:
- 34:f345fdec711d
- Child:
- 36:f240f5a6d0ed
diff -r f345fdec711d -r 6235ef67faa1 src/CommandParser/cmd.cpp --- a/src/CommandParser/cmd.cpp Thu Sep 08 22:01:00 2016 +0000 +++ b/src/CommandParser/cmd.cpp Fri Sep 09 13:33:54 2016 +0000 @@ -59,11 +59,11 @@ {"ls", "list user files", cmd_ls }, {"modify", "modify a control", cmd_modify }, {"reset", "reset the controller", cmd_reset }, - {"resetStats", "reset current mDot statistics", cmd_resetStats }, + {"reset-stats", "reset current mDot statistics", cmd_resetStats }, {"rm", "remove a user file", cmd_rm }, - {"rssiStats", "get current rssi stats", cmd_rssiStats }, - {"showControls", "display active controls", cmd_ShowControls }, - {"snrStats", "get current SNR stats", cmd_snrStats }, + {"rssi-stats", "get current rssi stats", cmd_rssiStats }, + {"show-controls", "display active controls", cmd_ShowControls }, + {"snr-stats", "get current SNR stats", cmd_snrStats }, {"stack", "get thread stack usage stats", cmd_stack }, {"stats", "get current mDot statistics", cmd_stats }, {NULL, NULL, NULL} @@ -128,6 +128,15 @@ } /************************* callback functions *******************************/ + +/***************************************************************************** + * Function: cmd_help + * Description: displays the list of commands available + * + * @param argc (not used) + * @param argv (not used) + * @return none + *****************************************************************************/ void cmd_help(int argc, char **argv) { UNUSED(argc); @@ -142,8 +151,19 @@ printf("\r\n"); } +/***************************************************************************** + * Function: cmd_ls + * Description: list the user files on flash + * + * @param argc (not used) + * @param argv (not used) + * @return none + *****************************************************************************/ void cmd_ls(int argc, char **argv) { + UNUSED(argc); + UNUSED(argv); + vector<mDot::mdot_file> userFiles; userFiles = GLOBAL_mdot->listUserFiles(); vector<mDot::mdot_file>::iterator pos; @@ -154,7 +174,14 @@ printf("\r\n"); } - +/***************************************************************************** + * Function: cmd_ShowControls + * Description: show active controls + * + * @param argc (not used) + * @param argv (not used) + * @return none + *****************************************************************************/ void cmd_ShowControls(int argc, char **argv) { UNUSED(argc); @@ -164,6 +191,14 @@ } +/***************************************************************************** + * Function: cmd_reset + * Description: reset the cpu + * + * @param argc (not used) + * @param argv (not used) + * @return none + *****************************************************************************/ void cmd_reset(int argc, char **argv) { UNUSED(argc); @@ -171,6 +206,14 @@ GLOBAL_mdot->resetCpu(); } +/***************************************************************************** + * Function: cmd_rm + * Description: removes a user file from flash + * + * @param argc-> number of args + * @param argv-> filename + * @return none + *****************************************************************************/ void cmd_rm(int argc, char **argv) { UNUSED(argc); @@ -184,6 +227,14 @@ GLOBAL_mdot->deleteUserFile(argv[1]); } +/***************************************************************************** + * Function: cmd_create + * Description: create a control + * + * @param argc-> number of args + * @param argv-> control name, control type + * @return none + *****************************************************************************/ void cmd_create(int argc, char **argv) { if ( argc != 3 ) { @@ -206,6 +257,14 @@ return; } +/***************************************************************************** + * Function: cmd_destroy + * Description: reset the cpu + * + * @param argc-> number of arguments + * @param argv-> control name, control type + * @return none + *****************************************************************************/ void cmd_destroy(int argc, char **argv) { if ( argc != 3 ) { @@ -229,6 +288,14 @@ return; } +/***************************************************************************** + * Function: cmd_ccf + * Description: create a control file + * + * @param argc-> number of args + * @param argv-> filename + * @return none + *****************************************************************************/ void cmd_ccf(int argc, char **argv) { if ( argc != 2 ) { @@ -258,12 +325,28 @@ } } +/***************************************************************************** + * Function: cmd_heap + * Description: display heap statistics + * + * @param argc (not used) + * @param argv (not used) + * @return none + *****************************************************************************/ void cmd_heap(int argc, char **argv) { UNUSED(argc), UNUSED(argv); __heapstats((__heapprt)fprintf,stderr); // print initial free heap size } +/***************************************************************************** + * Function: cmd_modify + * Description: modify an active control + * + * @param argc (not used) + * @param argv (not used) + * @return none + *****************************************************************************/ void cmd_modify(int argc, char **argv) { // stubbed @@ -271,8 +354,19 @@ return; } +/***************************************************************************** + * Function: cmd_stats + * Description: display mDot stats + * + * @param argc (not used) + * @param argv (not used) + * @return none + *****************************************************************************/ void cmd_stats(int argc, char **argv) { + UNUSED(argc); + UNUSED(argv); + mDot::mdot_stats stats = GLOBAL_mdot->getStats(); printf("\r Up: %u\n", stats.Up); @@ -285,13 +379,35 @@ printf("\r\n"); } +/***************************************************************************** + * Function: cmd_resetStats + * Description: resets the mDot stats + * + * @param argc (not used) + * @param argv (not used) + * @return none + *****************************************************************************/ void cmd_resetStats(int argc, char **argv) { + UNUSED(argc); + UNUSED(argv); + GLOBAL_mdot->resetStats(); } +/***************************************************************************** + * Function: cmd_rssiStats + * Description: displays mDot RSSI statistics + * + * @param argc (not used) + * @param argv (not used) + * @return none + *****************************************************************************/ void cmd_rssiStats(int argc, char **argv) { + UNUSED(argc); + UNUSED(argv); + mDot::rssi_stats s = GLOBAL_mdot->getRssiStats(); printf("\r Last: %d dB\n", s.last); @@ -302,6 +418,14 @@ printf("\r\n"); } +/***************************************************************************** + * Function: cmd_snrStats + * Description: displays signal-to-noise ratio stats + * + * @param argc (not used) + * @param argv (not used) + * @return none + *****************************************************************************/ void cmd_snrStats(int argc, char **argv) { mDot::snr_stats s = GLOBAL_mdot->getSnrStats(); @@ -314,6 +438,14 @@ printf("\r\n"); } +/***************************************************************************** + * Function: cmd_stack + * Description: display thread stack statisics + * + * @param argc (not used) + * @param argv (not used) + * @return none + *****************************************************************************/ void cmd_stack(int argc, char **argv) { if ( GLOBAL_analyticsLogger_thread ) {