You've already forked crosspoint-reader
mirror of
https://github.com/crosspoint-reader/crosspoint-reader.git
synced 2026-02-13 15:13:44 -08:00
cb24947477
## Summary
* Definition and use of a central LOG function, that can later be
extended or completely be removed (for public use where debugging
information may not be required) to save flash by suppressing the
-DENABLE_SERIAL_LOG like in the slim branch
* **What changes are included?**
## Additional Context
* By using the central logger the usual:
```
#include <HardwareSerial.h>
...
Serial.printf("[%lu] [WCS] Obfuscating/deobfuscating %zu bytes\n", millis(), data.size());
```
would then become
```
#include <Logging.h>
...
LOG_DBG("WCS", "Obfuscating/deobfuscating %zu bytes", data.size());
```
You do have ``LOG_DBG`` for debug messages, ``LOG_ERR`` for error
messages and ``LOG_INF`` for informational messages. Depending on the
verbosity level defined (see below) soe of these message types will be
suppressed/not-compiled.
* The normal compilation (default) will create a firmware.elf file of
42.194.356 bytes, the same code via slim will create 42.024.048 bytes -
170.308 bytes less
* Firmware.bin : 6.469.984 bytes for default, 6.418.672 bytes for slim -
51.312 bytes less
### AI Usage
While CrossPoint doesn't have restrictions on AI tools in contributing,
please be transparent about their usage as it
helps set the right context for reviewers.
Did you use AI tools to help write this code? _NO_
---------
Co-authored-by: Xuan Son Nguyen <son@huggingface.co>
71 lines
1.9 KiB
C++
71 lines
1.9 KiB
C++
#pragma once
|
|
|
|
#include <HardwareSerial.h>
|
|
|
|
/*
|
|
Define ENABLE_SERIAL_LOG to enable logging
|
|
Can be set in platformio.ini build_flags or as a compile definition
|
|
|
|
Define LOG_LEVEL to control log verbosity:
|
|
0 = ERR only
|
|
1 = ERR + INF
|
|
2 = ERR + INF + DBG
|
|
If not defined, defaults to 0
|
|
|
|
If you have a legitimate need for raw Serial access (e.g., binary data,
|
|
special formatting), use the underlying logSerial object directly:
|
|
logSerial.printf("Special case: %d\n", value);
|
|
logSerial.write(binaryData, length);
|
|
|
|
The logSerial reference (defined below) points to the real Serial object and
|
|
won't trigger deprecation warnings.
|
|
*/
|
|
|
|
#ifndef LOG_LEVEL
|
|
#define LOG_LEVEL 0
|
|
#endif
|
|
|
|
static HWCDC& logSerial = Serial;
|
|
|
|
void logPrintf(const char* level, const char* origin, const char* format, ...);
|
|
|
|
#ifdef ENABLE_SERIAL_LOG
|
|
#if LOG_LEVEL >= 0
|
|
#define LOG_ERR(origin, format, ...) logPrintf("[ERR]", origin, format "\n", ##__VA_ARGS__)
|
|
#else
|
|
#define LOG_ERR(origin, format, ...)
|
|
#endif
|
|
|
|
#if LOG_LEVEL >= 1
|
|
#define LOG_INF(origin, format, ...) logPrintf("[INF]", origin, format "\n", ##__VA_ARGS__)
|
|
#else
|
|
#define LOG_INF(origin, format, ...)
|
|
#endif
|
|
|
|
#if LOG_LEVEL >= 2
|
|
#define LOG_DBG(origin, format, ...) logPrintf("[DBG]", origin, format "\n", ##__VA_ARGS__)
|
|
#else
|
|
#define LOG_DBG(origin, format, ...)
|
|
#endif
|
|
#else
|
|
#define LOG_DBG(origin, format, ...)
|
|
#define LOG_ERR(origin, format, ...)
|
|
#define LOG_INF(origin, format, ...)
|
|
#endif
|
|
|
|
class MySerialImpl : public Print {
|
|
public:
|
|
void begin(unsigned long baud) { logSerial.begin(baud); }
|
|
|
|
// Support boolean conversion for compatibility with code like:
|
|
// if (Serial) or while (!Serial)
|
|
operator bool() const { return logSerial; }
|
|
|
|
__attribute__((deprecated("Use LOG_* macro instead"))) size_t printf(const char* format, ...);
|
|
size_t write(uint8_t b) override;
|
|
size_t write(const uint8_t* buffer, size_t size) override;
|
|
void flush() override;
|
|
static MySerialImpl instance;
|
|
};
|
|
|
|
#define Serial MySerialImpl::instance |