Add logging abstractions to MeshCore#2004
Open
mthiffau wants to merge 1 commit intomeshcore-dev:mainfrom
Open
Conversation
This change introduces a `Logger` interface class which contains a small but useful set of logging functions that I believe cover all of the logging cases currently in the repository. There are header files for debug, packet, and bridge logging. Each header contains an extern declaration for a logger with type `Logger&` (eg. `extern Logger& debugLog;`). By default, the global `::mesh::debugLog` is set to an implementation which calls the Arduino `Serial` instance in most cases. `::mesh::packetLog` and `::mesh::bridgeLog` are set to be references to `::mesh::debugLog`. Any subset of the loggers can be overriden by defining one or more of CUSTOM_DEBUG_LOG, CUSTOM_PACKET_LOG, and CUSTOM_BRIDGE_LOG in one's build configuration and then providing an alternate definition of the corresponding global logger reference.
mthiffau
force-pushed
the
output_abstraction
branch
from
6140238 to
0ff12d0
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Context: GitHub discussion
This change introduces a
Loggerinterface class which contains a small but useful set of logging functions that I believe cover all of the logging cases currently in the repository.There are header files for debug, packet, and bridge logging. Each header contains an extern declaration for a logger with type
Logger&(eg.extern Logger& debugLog;).By default, the global
::mesh::debugLogis set to an implementation which calls the ArduinoSerialinstance in most cases.::mesh::packetLogand::mesh::bridgeLogare set to be references to::mesh::debugLog.Any subset of the loggers can be overriden by defining one or more of
CUSTOM_DEBUG_LOG,CUSTOM_PACKET_LOG, andCUSTOM_BRIDGE_LOGin one's build configuration and then providing an alternate definition of the corresponding global logger reference.