app_metadata

Module for the application metadata. More...

Detailed Description

Module for the application metadata.

Author

Kevin Weiss kevin.nosp@m..wei.nosp@m.ss@ha.nosp@m.w-ha.nosp@m.mburg.nosp@m..de

Macros
#define	APP_SHELL_FMT
	Application Shell Format is an optional application metadata parameter intended to help coordinate any specific formats that are being used.

Functions
void	app_metadata_print_json (void)
	Prints the application metadata in json.

Macro Definition Documentation

APP_SHELL_FMT

#define APP_SHELL_FMT

Application Shell Format is an optional application metadata parameter intended to help coordinate any specific formats that are being used.

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

Definition at line 39 of file app_metadata.h.

Function Documentation

app_metadata_print_json()

void app_metadata_print_json

(

void

)

Prints the application metadata in json.

Examples of application metadata are BOARD, OS_VERSION, APP_NAME...