https://github.com/tcmenu/tcmenulog

Simple embedded logging library.
https://github.com/tcmenu/tcmenulog

Last synced: 2 months ago
JSON representation

Simple embedded logging library.

• Host: GitHub
• URL: https://github.com/tcmenu/tcmenulog
• Owner: TcMenu
• License: apache-2.0
• Created: 2024-09-07T11:19:52.000Z (8 months ago)
• Default Branch: main
• Last Pushed: 2025-01-25T08:46:55.000Z (3 months ago)
• Last Synced: 2025-01-25T09:25:11.184Z (3 months ago)
• Language: C++
• Size: 43.9 KB
• Stars: 0
• Watchers: 2
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • Funding: FUNDING.yml
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# TcMenuLog

[![PlatformIO](https://github.com/TcMenu/TcMenuLog/actions/workflows/platformio.yml/badge.svg)](https://github.com/TcMenu/TcMenuLog/actions/workflows/platformio.yml)

[![Test](https://github.com/TcMenu/TcMenuLog/actions/workflows/test.yml/badge.svg)](https://github.com/TcMenu/TcMenuLog/actions/workflows/test.yml)

[![License: Apache 2.0](https://img.shields.io/badge/license-Apache--2.0-green.svg)](https://github.com/TcMenu/TcMenuLog/blob/main/LICENSE)

[![GitHub release](https://img.shields.io/github/release/TcMenu/TcMenuLog.svg?maxAge=3600)](https://github.com/TcMenu/TcMenuLog/releases)

[![davetcc](https://img.shields.io/badge/davetcc-dev-blue.svg)](https://github.com/davetcc)

[![JSC TechMinds](https://img.shields.io/badge/JSC-TechMinds-green.svg)](https://www.jsctm.cz)

TcMenu organisation made this library available for you to use. It takes significant effort to keep all our libraries current and working on a wide range of boards. Please consider making at least a one off donation via the sponsor button if you find it useful. In forks, please keep text to here intact.

## Summary

This library provides logging facilities that are used by all our other libraries. You can consider this like a logging API with a simple implementation that backs onto the serial port by default.

The library works on most Arduino devices, PicoSDK and mbed. You can see our library compatibility matrix: https://tcmenu.github.io/documentation/

You can find examples packaged with it in the `examples` folder. The example should work on most platforms without needing changes. 

## Supporting another output format

The easiest way would be to create another implementation of `LoggingPort` that met the `Print` (or `PrintCompat`) interface, this will then integrate without changing anything. You can see examples of this in `IoLogging.h` for mbed and PicoSDK. 

## License

Licensed under the [Apache-2.0](LICENSE) license.