dist Namespace Reference

The distributor headerfile collects constants as C preprocessor headers. More...

Functions
const char *	ident ()
	Get a short oneline identifier name.
const char *	as_json ()
	Get the program memory database as already-serialized JSON String.
void	write_to_json (JsonObject target)
	Write the distributor database into an existing JSON document.

Detailed Description

The distributor headerfile collects constants as C preprocessor headers.

They are composed at compile-time by a python script.

Note

The implementations for the functions defined in this header file are generated by the PlatformIO build system (a SCons script) at build time. Therefore, the content of the files distributor_generated.cpp (contains functions) and distributor_generated.h (contains define macros) is not present in the generated Doxygen documentation if PlatformIO has not built the code in before.

In the application context, some of these variables are considered secret (such as the default admin password).

Since the preprocessor directives are not namespaced or typed (they are all C strings by definition), some helpers functions are here as functions.

Function Documentation

as_json()

const char * dist::as_json

(

)

Get the program memory database as already-serialized JSON String.

ident()

const char * dist::ident

(

)

Get a short oneline identifier name.

Referenced by setup().

write_to_json()

void dist::write_to_json

(

JsonObject

target

)

Write the distributor database into an existing JSON document.

Referenced by msg::handlers::GetSystemIdent::handle().