{"id":19696697,"url":"https://github.com/pfeerick/debug-helper","last_synced_at":"2026-06-11T08:31:25.793Z","repository":{"id":186323089,"uuid":"669451828","full_name":"pfeerick/debug-helper","owner":"pfeerick","description":null,"archived":false,"fork":false,"pushed_at":"2026-05-18T00:46:36.000Z","size":12,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2026-05-18T02:41:59.065Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"C","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pfeerick.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2023-07-22T10:21:19.000Z","updated_at":"2026-05-18T00:33:22.000Z","dependencies_parsed_at":"2024-02-17T14:45:51.278Z","dependency_job_id":null,"html_url":"https://github.com/pfeerick/debug-helper","commit_stats":null,"previous_names":["pfeerick/debug-helper"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/pfeerick/debug-helper","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pfeerick%2Fdebug-helper","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pfeerick%2Fdebug-helper/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pfeerick%2Fdebug-helper/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pfeerick%2Fdebug-helper/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pfeerick","download_url":"https://codeload.github.com/pfeerick/debug-helper/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pfeerick%2Fdebug-helper/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34190583,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-11T02:00:06.485Z","response_time":57,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-11T19:35:55.068Z","updated_at":"2026-06-11T08:31:25.787Z","avatar_url":"https://github.com/pfeerick.png","language":"C","funding_links":[],"categories":[],"sub_categories":[],"readme":"# DebugHelper\n\nZero-overhead conditional debug macros for Arduino, ESP8266, and ESP32.\n\nWhen `DEBUG` is not enabled, every macro expands to `void(0)` — the compiler eliminates all debug code entirely, adding nothing to flash or RAM.\n\n## Installation\n\n**PlatformIO** — add to `platformio.ini`:\n```ini\nlib_deps =\n    https://github.com/pfeerick/debug-helper.git\n```\n\n**Arduino IDE** — install via Library Manager (search for `DebugHelper`) or download the ZIP and use Sketch → Include Library → Add .ZIP Library.\n\n## Usage\n\nDefine `DEBUG` and `DEBUG_OI` **before** including the header:\n\n```cpp\n#define DEBUG true      // remove or set to false to strip all debug code\n#define DEBUG_OI Serial // any Stream-compatible object (Serial, Serial1, etc.)\n\n#include \u003cdebug-helper.h\u003e\n```\n\n### Macros\n\n| Macro | Description |\n|---|---|\n| `DebugBegin(baud)` | Initialize the debug output stream |\n| `DebugPrint(...)` | `print()` passthrough |\n| `DebugPrintln(...)` | `println()` passthrough |\n| `DebugPrintf(...)` | `printf()` passthrough |\n| `DebugWrite(...)` | `write()` passthrough |\n| `DebugFlush(...)` | `flush()` passthrough |\n| `DebugInfo()` | Print platform info block (see below) |\n\n### DebugInfo() output\n\n`DebugInfo()` prints a formatted block to the debug stream. The content is platform-specific:\n\n- **ESP8266** — core/SDK/boot version, chip ID, CPU frequency, flash details, sketch size \u0026 MD5, heap free \u0026 fragmentation\n- **ESP32** — IDF version, chip model/revision/cores, CPU frequency, flash size, sketch size \u0026 MD5, heap free/min/max-alloc\n- **Generic Arduino** — build date and time only\n\n### Disabling debug\n\nSet `DEBUG` to `false` or remove the define entirely. All macros expand to `void(0)` and the compiler generates no debug code.\n\n## License\n\nMIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpfeerick%2Fdebug-helper","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpfeerick%2Fdebug-helper","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpfeerick%2Fdebug-helper/lists"}