README.md

Arduino Library: Logger

Logging functions for Arduino and ESP32

Table of Contents

• Arduino Library: Logger
  • Table of Contents
  • Requirements
  • Usage
    • Installation via Arduino IDE
    • Installation via Arduino CLI
    • Installation of development versions
  • Development
  • Notes
    • Release Ingressing
  • Contributors
  • License

Requirements

• arduino-lint 1.2.0 or newer
• cpplint 1.6.0 or newer
• clang-format 18.1.0 or newer

Usage

For usage examples, see the examples directory.

Installation via Arduino IDE

For installation via the Arduino IDE, see docs.arduino.cc.

Installation via Arduino CLI

To install the latest version using arduino-cli, use the following command:

arduino-cli lib install workloads-filesystem

To install a specific version, use the following command:

arduino-cli lib install [email protected]

Installation of development versions

To install an in-development or unreleased version, installation of unsafe libraries must be enabled.

To enable the installation of unsafe libraries, use the following command:

arduino-cli config set library.enable_unsafe_install true

See docs.arduino.cc for more information on the implications.

Once the installation of unsafe libraries is enabled, the workloads-filesystem library may be installed by running the following command:

arduino-cli lib install --git-url "https://github.com/workloads/arduino-logger.git"

Development

This repository provides a Makefile-based workflow to aid in development.

Running make without commands will print out the following help information:

📚 LOGGER LIBRARY

Target          Description                                     Usage
lint-arduino    lint Arduino code using arduino-lint            `make lint-arduino`
lint-cpp        lint C++ code using cpplint and clang-format    `make lint-cpp`
help            display a list of Make Targets                  `make help`
_listincludes   list all included Makefiles and *.mk files      `make _listincludes`
_selfcheck      lint Makefile                                   `make _selfcheck`
lint-vale       lint prose using vale                           `make lint-vale`
vale-sync       sync Vale dependencies                          `make vale-sync`

Notes

Release Ingressing

New (GitHub) releases of this library are automatically ingressed by the Arduino Library Manager.

A log of currently "visible" releases can be found at downloads.arduino.cc.

Contributors

For a list of current (and past) contributors to this repository, see GitHub.

License

Licensed under the General Public License, Version 3.0 (the "License").

You may download a copy of the License at gnu.org/licenses/gpl-3.0.txt.

See the License for the specific language governing permissions and limitations under the License.