arduino-logger

arduino-logger copied to clipboard

Add doxygen documentation for LoggerBase

1

give a summary of the class, the design approach (expanding with custom strategies), and outline functions that the user can/should override.

phillipjohnston

Right now, we do this check per-character, which is quite inefficient: ``` virtual void log_add_char_to_buffer(char c) { if(auto_flush() && (internal_size() == internal_capacity())) { flush(); } else if (internal_size() == internal_capacity())...

phillipjohnston

phillipjohnston

I need to add documentation on using the meson build system + using this project as a meson subproject.

phillipjohnston

Add support for F() macro

3

We do not currently handle strings stored in flash via the F() macro. https://andybrown.me.uk/wk/wp-content/images//avr-gcc-4.7.0/WString.h https://github.com/esp8266/Arduino/blob/master/cores/esp8266/Print.h

phillipjohnston

We can add an option to the rotational SD logger strategy which supports a parameter that defines the maximum size of a log file. Once that file size is met,...

phillipjohnston

We should also define an option in the rotational log file strategy that allow the user to specify the maximal number of log files.

phillipjohnston

* [ ] Improve support for compile-time filtering with macros, so users don't need a global instance * [ ] Explore compile-time filtering using templates

phillipjohnston

What if a user wanted to compile-out all logging without relying on the macros? In this case, I could see using a "log disable" strategy of some sort. We could...

phillipjohnston

Create examples showing TRACE(), FUNC(), and PRETTYFUNC()

1

These macros are supported by the library, but we don't have any examples that show how they are used. We should add some! You can see them used in the...

phillipjohnston