RIOT-OS/RIOT
RIOT-OS/RIOT
1
0
Fork 0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2024-12-29 04:50:03 +01:00
Code Releases Activity

Merge pull request #10961 from MrKevinWeiss/pr/addshellcommands

Browse Source 
sys/app_metadata: Add a shell command to print application metadata
This commit is contained in:
MichelRottleuthner 2019-03-06 13:36:14 +01:00 committed by GitHub
commit 3427dcd168
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
10 changed files with 145 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
Makefile.include
View File

@ -312,6 +312,7 @@ endif
BOARDDEF := $(shell echo $(BOARD) | tr 'a-z' 'A-Z' | tr '-' '_')
CPUDEF := $(shell echo $(CPU) | tr 'a-z' 'A-Z' | tr '-' '_')
MCUDEF := $(shell echo $(MCU) | tr 'a-z' 'A-Z' | tr '-' '_')
CFLAGS += -DRIOT_APPLICATION=\"$(APPLICATION)\"
CFLAGS += -DBOARD_$(BOARDDEF)=\"$(BOARD)\" -DRIOT_BOARD=BOARD_$(BOARDDEF)
CFLAGS += -DCPU_$(CPUDEF)=\"$(CPU)\" -DRIOT_CPU=CPU_$(CPUDEF)
CFLAGS += -DMCU_$(MCUDEF)=\"$(MCU)\" -DRIOT_MCU=MCU_$(MCUDEF)

10
sys/Makefile.include
View File

@ -31,6 +31,16 @@ ifneq (,$(filter oneway_malloc,$(USEMODULE)))
USEMODULE_INCLUDES += $(RIOTBASE)/sys/oneway-malloc/include
endif
ifneq (,$(filter app_metadata,$(USEMODULE)))
# Overwrite the application shell formats.
# This is an optional macro that can be used to coordinate
# standardized shell formats, as an example it can point to an RDM
# that specifies semantics.
ifdef APP_SHELL_FMT
CFLAGS += -DAPP_SHELL_FMT=\"$(APP_SHELL_FMT)\"
endif
endif
ifneq (,$(filter vfs,$(USEMODULE)))
USEMODULE_INCLUDES += $(RIOTBASE)/sys/posix/include
endif

1
sys/app_metadata/Makefile Normal file
View File

@ -0,0 +1 @@
include $(RIOTBASE)/Makefile.base

31
sys/app_metadata/app_metadata.c Normal file
View File

@ -0,0 +1,31 @@
/**
Copyright (C) 2019, HAW Hamburg.
*
* This file is subject to the terms and conditions of the GNU Lesser
* General Public License v2.1. See the file LICENSE in the top level
* directory for more details.
*
* @ingroup sys_app_metadata
* @{
* @file
* @brief Prints application metadata such as BOARD, CPU, OS_VERSION.
* @author Kevin Weiss <kevin.weiss@haw-hamburg.de>
* @}
*/
#include <stdio.h>
void app_metadata_print_json(void)
{
puts("{\"cmd\": \"app_metadata_print_json()\"}");
printf("{\"data\": {\"APP_NAME\": \"%s\"}}\n", RIOT_APPLICATION);
printf("{\"data\": {\"BOARD\": \"%s\"}}\n", RIOT_BOARD);
printf("{\"data\": {\"CPU\": \"%s\"}}\n", RIOT_CPU);
#ifdef APP_SHELL_FMT
printf("{\"data\": {\"APP_SHELL_FMT\": \"%s\"}}\n", APP_SHELL_FMT);
#endif
printf("{\"data\": {\"MCU\": \"%s\"}}\n", RIOT_MCU);
printf("{\"data\": {\"OS_VERSION\": \"%s\"}}\n", RIOT_VERSION);
printf("{\"result\": \"SUCCESS\"}\n");
}

55
sys/include/app_metadata.h Normal file
View File

@ -0,0 +1,55 @@
/*
* Copyright (C) 2019 HAW Hamburg
*
* This file is subject to the terms and conditions of the GNU Lesser
* General Public License v2.1. See the file LICENSE in the top level
* directory for more details.
*/
/**
* @defgroup sys_app_metadata app_metadata
* @ingroup sys
* @brief Module for the application metadata
* @{
*
* @author Kevin Weiss <kevin.weiss@haw-hamburg.de>
*/
#ifndef APP_METADATA_H
#define APP_METADATA_H
#ifdef __cplusplus
extern "C" {
#endif
#ifdef DOXYGEN
/**
* @brief Application Shell Format is an optional application metadata
* parameter intended to help coordinate any specific formats that
* are being used.
*
* @details An example is if the application is following a specific format,
* say semantics defined in a RDM or schema, that could be specified
* by adding APP_SHELL_FMT="RDM001_v1", that would inform anything
* using the shell that the formatting should follow what is dictated.
* @note This define is only for documentation, to use the APP_SHELL_FMT
* add it to the application makefile with APP_SHELL_FMT=your_value
* or when calling make such as `APP_SHELL_FMT=your_value make flash`
*/
#define APP_SHELL_FMT
#endif
/**
* @brief Prints the application metadata in json.
*
* @details Examples of application metadata are BOARD, OS_VERSION, APP_NAME...
*/
void app_metadata_print_json(void);
#ifdef __cplusplus
}
#endif
#endif /* APP_METADATA_H */
/** @} */

3
sys/shell/commands/Makefile
View File

@ -2,6 +2,9 @@ MODULE = shell_commands
SRC = shell_commands.c sc_sys.c
ifneq (,$(filter app_metadata,$(USEMODULE)))
SRC += sc_app_metadata.c
endif
ifneq (,$(filter mci,$(USEMODULE)))
SRC += sc_disk.c
endif

29
sys/shell/commands/sc_app_metadata.c Normal file
View File

@ -0,0 +1,29 @@
/*
* Copyright (C) 2019 HAW Hamburg
*
* This file is subject to the terms and conditions of the GNU Lesser
* General Public License v2.1. See the file LICENSE in the top level
* directory for more details.
*/
/**
* @ingroup sys_shell_commands
* @{
*
* @file
* @brief Shell command for getting application metadata.
*
* @author Kevin Weiss <kevin.weiss@haw-hamburg.de>
* @}
*/
#include "app_metadata.h"
int _app_metadata_handler(int argc, char **argv)
{
(void) argc;
(void) argv;
app_metadata_print_json();
return 0;
}

7
sys/shell/commands/shell_commands.c
View File

@ -141,6 +141,10 @@ extern int _can_handler(int argc, char **argv);
extern int _cord_ep_handler(int argc, char **argv);
#endif
#ifdef MODULE_APP_METADATA
extern int _app_metadata_handler(int argc, char **argv);
#endif
const shell_command_t _shell_command_list[] = {
{"reboot", "Reboot the node", _reboot_handler},
#ifdef MODULE_CONFIG
@ -230,6 +234,9 @@ const shell_command_t _shell_command_list[] = {
#endif
#ifdef MODULE_CORD_EP
{"cord_ep", "Resource directory endpoint commands", _cord_ep_handler },
#endif
#ifdef MODULE_APP_METADATA
{"app_metadata", "Returns application metadata", _app_metadata_handler },
#endif
{NULL, NULL, NULL}
};

6
tests/shell/Makefile
View File

@ -1,6 +1,7 @@
DEVELHELP=0
include ../Makefile.tests_common
USEMODULE += app_metadata
USEMODULE += shell
USEMODULE += shell_commands
USEMODULE += ps
@ -10,6 +11,11 @@ DISABLE_MODULE += auto_init
# chronos is missing a getchar implementation
BOARD_BLACKLIST += chronos
BOARD_INSUFFICIENT_MEMORY := arduino-duemilanove \
arduino-uno
TEST_ON_CI_WHITELIST += all
APP_SHELL_FMT ?= NONE
include $(RIOTBASE)/Makefile.include

3
tests/shell/tests/01-run.py
View File

@ -17,7 +17,8 @@ EXPECTED_HELP = (
'end_test ends a test',
'echo prints the input command',
'reboot Reboot the node',
'ps Prints information about running threads.'
'ps Prints information about running threads.',
'app_metadata Returns application metadata'
)
EXPECTED_PS = (