shadow_config_defaults.h File Reference

This represents the default values for the configuration macros for the Shadow library. More...

Go to the source code of this file.

Macros
#define	SHADOW_DO_NOT_USE_CUSTOM_CONFIG
	Define this macro to build the Shadow library without the custom config file shadow_config.h. More...
#define	LogError(message)
	Macro that is called in the Shadow library for logging "Error" level messages. More...
#define	LogWarn(message)
	Macro that is called in the Shadow library for logging "Warning" level messages. More...
#define	LogInfo(message)
	Macro that is called in the Shadow library for logging "Info" level messages. More...
#define	LogDebug(message)
	Macro that is called in the Shadow library for logging "Debug" level messages. More...

Detailed Description

This represents the default values for the configuration macros for the Shadow library.

Note

This file SHOULD NOT be modified. If custom values are needed for any configuration macro, a shadow_config.h file should be provided to the Shadow library to override the default values defined in this file. To use the custom config file, the SHADOW_DO_NOT_USE_CUSTOM_CONFIG preprocessor macro SHOULD NOT be set.

Macro Definition Documentation

SHADOW_DO_NOT_USE_CUSTOM_CONFIG

#define SHADOW_DO_NOT_USE_CUSTOM_CONFIG

Define this macro to build the Shadow library without the custom config file shadow_config.h.

Without the custom config, the Shadow library builds with default values of config macros defined in shadow_config_defaults.h file.

If a custom config is provided, then SHADOW_DO_NOT_USE_CUSTOM_CONFIG should not be defined.

LogError

#define LogError

(

message

)

Macro that is called in the Shadow library for logging "Error" level messages.

To enable error level logging in the Shadow library, this macro should be mapped to the application-specific logging implementation that supports error logging.

Note

This logging macro is called in the Shadow library with parameters wrapped in double parentheses to be ISO C89/C90 standard compliant. For a reference POSIX implementation of the logging macros, refer to shadow_config.h files, and the logging-stack in demos folder of the AWS IoT Embedded C SDK repository.

Default value: Error logging is turned off, and no code is generated for calls to the macro in the Shadow library on compilation.

LogWarn

#define LogWarn

(

message

)

Macro that is called in the Shadow library for logging "Warning" level messages.

To enable warning level logging in the Shadow library, this macro should be mapped to the application-specific logging implementation that supports warning logging.

Note

This logging macro is called in the Shadow library with parameters wrapped in double parentheses to be ISO C89/C90 standard compliant. For a reference POSIX implementation of the logging macros, refer to shadow_config.h files, and the logging-stack in demos folder of the AWS IoT Embedded C SDK repository.

Default value: Warning logs are turned off, and no code is generated for calls to the macro in the Shadow library on compilation.

LogInfo

#define LogInfo

(

message

)

Macro that is called in the Shadow library for logging "Info" level messages.

To enable info level logging in the Shadow library, this macro should be mapped to the application-specific logging implementation that supports info logging.

Note

This logging macro is called in the Shadow library with parameters wrapped in double parentheses to be ISO C89/C90 standard compliant. For a reference POSIX implementation of the logging macros, refer to shadow_config.h files, and the logging-stack in demos folder of the AWS IoT Embedded C SDK repository.

Default value: Info logging is turned off, and no code is generated for calls to the macro in the Shadow library on compilation.

LogDebug

#define LogDebug

(

message

)

Macro that is called in the Shadow library for logging "Debug" level messages.

To enable debug level logging from Shadow library, this macro should be mapped to the application-specific logging implementation that supports debug logging.

Note

This logging macro is called in the Shadow library with parameters wrapped in double parentheses to be ISO C89/C90 standard compliant. For a reference POSIX implementation of the logging macros, refer to shadow_config.h files, and the logging-stack in demos folder of the AWS IoT Embedded C SDK repository.

Default value: Debug logging is turned off, and no code is generated for calls to the macro in the Shadow library on compilation.